D2Client

package

v0.0.0-...-f9b5e81 Latest Latest Go to latest Published: Nov 16, 2023 License: MIT Imports: 20 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/eric-gt/d2-vault-inspector

Links

Open Source Insights

README ¶

Go API client for swagger

These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

API version: 2.18.0
Package version: 1.0.0
Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen For more information, please visit https://github.com/Bungie-net/api

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to https://www.bungie.net/Platform

Class	Method	HTTP request
DefaultApi	GetAvailableLocales	Get /GetAvailableLocales/
DefaultApi	GetCommonSettings	Get /Settings/
DefaultApi	GetGlobalAlerts	Get /GlobalAlerts/
DefaultApi	GetUserSystemOverrides	Get /UserSystemOverrides/
AppApi	AppGetApplicationApiUsage	Get /App/ApiUsage/{applicationId}/
AppApi	AppGetBungieApplications	Get /App/FirstParty/
CommunityContentApi	CommunityContentGetCommunityContent	Get /CommunityContent/Get/{sort}/{mediaFilter}/{page}/
ContentApi	ContentGetContentById	Get /Content/GetContentById/{id}/{locale}/
ContentApi	ContentGetContentByTagAndType	Get /Content/GetContentByTagAndType/{tag}/{type}/{locale}/
ContentApi	ContentGetContentType	Get /Content/GetContentType/{type}/
ContentApi	ContentRssNewsArticles	Get /Content/Rss/NewsArticles/{pageToken}/
ContentApi	ContentSearchContentByTagAndType	Get /Content/SearchContentByTagAndType/{tag}/{type}/{locale}/
ContentApi	ContentSearchContentWithText	Get /Content/Search/{locale}/
ContentApi	ContentSearchHelpArticles	Get /Content/SearchHelpArticles/{searchtext}/{size}/
Destiny2Api	Destiny2AwaGetActionToken	Get /Destiny2/Awa/GetActionToken/{correlationId}/
Destiny2Api	Destiny2AwaInitializeRequest	Post /Destiny2/Awa/Initialize/
Destiny2Api	Destiny2AwaProvideAuthorizationResult	Post /Destiny2/Awa/AwaProvideAuthorizationResult/
Destiny2Api	Destiny2ClearLoadout	Post /Destiny2/Actions/Loadouts/ClearLoadout/
Destiny2Api	Destiny2EquipItem	Post /Destiny2/Actions/Items/EquipItem/
Destiny2Api	Destiny2EquipItems	Post /Destiny2/Actions/Items/EquipItems/
Destiny2Api	Destiny2EquipLoadout	Post /Destiny2/Actions/Loadouts/EquipLoadout/
Destiny2Api	Destiny2GetActivityHistory	Get /Destiny2/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Stats/Activities/
Destiny2Api	Destiny2GetCharacter	Get /Destiny2/{membershipType}/Profile/{destinyMembershipId}/Character/{characterId}/
Destiny2Api	Destiny2GetClanAggregateStats	Get /Destiny2/Stats/AggregateClanStats/{groupId}/
Destiny2Api	Destiny2GetClanBannerSource	Get /Destiny2/Clan/ClanBannerDictionary/
Destiny2Api	Destiny2GetClanLeaderboards	Get /Destiny2/Stats/Leaderboards/Clans/{groupId}/
Destiny2Api	Destiny2GetClanWeeklyRewardState	Get /Destiny2/Clan/{groupId}/WeeklyRewardState/
Destiny2Api	Destiny2GetCollectibleNodeDetails	Get /Destiny2/{membershipType}/Profile/{destinyMembershipId}/Character/{characterId}/Collectibles/{collectiblePresentationNodeHash}/
Destiny2Api	Destiny2GetDestinyAggregateActivityStats	Get /Destiny2/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Stats/AggregateActivityStats/
Destiny2Api	Destiny2GetDestinyEntityDefinition	Get /Destiny2/Manifest/{entityType}/{hashIdentifier}/
Destiny2Api	Destiny2GetDestinyManifest	Get /Destiny2/Manifest/
Destiny2Api	Destiny2GetHistoricalStats	Get /Destiny2/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Stats/
Destiny2Api	Destiny2GetHistoricalStatsDefinition	Get /Destiny2/Stats/Definition/
Destiny2Api	Destiny2GetHistoricalStatsForAccount	Get /Destiny2/{membershipType}/Account/{destinyMembershipId}/Stats/
Destiny2Api	Destiny2GetItem	Get /Destiny2/{membershipType}/Profile/{destinyMembershipId}/Item/{itemInstanceId}/
Destiny2Api	Destiny2GetLeaderboards	Get /Destiny2/{membershipType}/Account/{destinyMembershipId}/Stats/Leaderboards/
Destiny2Api	Destiny2GetLeaderboardsForCharacter	Get /Destiny2/Stats/Leaderboards/{membershipType}/{destinyMembershipId}/{characterId}/
Destiny2Api	Destiny2GetLinkedProfiles	Get /Destiny2/{membershipType}/Profile/{membershipId}/LinkedProfiles/
Destiny2Api	Destiny2GetPostGameCarnageReport	Get /Destiny2/Stats/PostGameCarnageReport/{activityId}/
Destiny2Api	Destiny2GetProfile	Get /Destiny2/{membershipType}/Profile/{destinyMembershipId}/
Destiny2Api	Destiny2GetPublicMilestoneContent	Get /Destiny2/Milestones/{milestoneHash}/Content/
Destiny2Api	Destiny2GetPublicMilestones	Get /Destiny2/Milestones/
Destiny2Api	Destiny2GetPublicVendors	Get /Destiny2/Vendors/
Destiny2Api	Destiny2GetUniqueWeaponHistory	Get /Destiny2/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Stats/UniqueWeapons/
Destiny2Api	Destiny2GetVendor	Get /Destiny2/{membershipType}/Profile/{destinyMembershipId}/Character/{characterId}/Vendors/{vendorHash}/
Destiny2Api	Destiny2GetVendors	Get /Destiny2/{membershipType}/Profile/{destinyMembershipId}/Character/{characterId}/Vendors/
Destiny2Api	Destiny2InsertSocketPlug	Post /Destiny2/Actions/Items/InsertSocketPlug/
Destiny2Api	Destiny2InsertSocketPlugFree	Post /Destiny2/Actions/Items/InsertSocketPlugFree/
Destiny2Api	Destiny2PullFromPostmaster	Post /Destiny2/Actions/Items/PullFromPostmaster/
Destiny2Api	Destiny2ReportOffensivePostGameCarnageReportPlayer	Post /Destiny2/Stats/PostGameCarnageReport/{activityId}/Report/
Destiny2Api	Destiny2SearchDestinyEntities	Get /Destiny2/Armory/Search/{type}/{searchTerm}/
Destiny2Api	Destiny2SearchDestinyPlayerByBungieName	Post /Destiny2/SearchDestinyPlayerByBungieName/{membershipType}/
Destiny2Api	Destiny2SetItemLockState	Post /Destiny2/Actions/Items/SetLockState/
Destiny2Api	Destiny2SetQuestTrackedState	Post /Destiny2/Actions/Items/SetTrackedState/
Destiny2Api	Destiny2SnapshotLoadout	Post /Destiny2/Actions/Loadouts/SnapshotLoadout/
Destiny2Api	Destiny2TransferItem	Post /Destiny2/Actions/Items/TransferItem/
Destiny2Api	Destiny2UpdateLoadoutIdentifiers	Post /Destiny2/Actions/Loadouts/UpdateLoadoutIdentifiers/
FireteamApi	FireteamGetActivePrivateClanFireteamCount	Get /Fireteam/Clan/{groupId}/ActiveCount/
FireteamApi	FireteamGetAvailableClanFireteams	Get /Fireteam/Clan/{groupId}/Available/{platform}/{activityType}/{dateRange}/{slotFilter}/{publicOnly}/{page}/
FireteamApi	FireteamGetClanFireteam	Get /Fireteam/Clan/{groupId}/Summary/{fireteamId}/
FireteamApi	FireteamGetMyClanFireteams	Get /Fireteam/Clan/{groupId}/My/{platform}/{includeClosed}/{page}/
FireteamApi	FireteamSearchPublicAvailableClanFireteams	Get /Fireteam/Search/Available/{platform}/{activityType}/{dateRange}/{slotFilter}/{page}/
ForumApi	ForumGetCoreTopicsPaged	Get /Forum/GetCoreTopicsPaged/{page}/{sort}/{quickDate}/{categoryFilter}/
ForumApi	ForumGetForumTagSuggestions	Get /Forum/GetForumTagSuggestions/
ForumApi	ForumGetPoll	Get /Forum/Poll/{topicId}/
ForumApi	ForumGetPostAndParent	Get /Forum/GetPostAndParent/{childPostId}/
ForumApi	ForumGetPostAndParentAwaitingApproval	Get /Forum/GetPostAndParentAwaitingApproval/{childPostId}/
ForumApi	ForumGetPostsThreadedPaged	Get /Forum/GetPostsThreadedPaged/{parentPostId}/{page}/{pageSize}/{replySize}/{getParentPost}/{rootThreadMode}/{sortMode}/
ForumApi	ForumGetPostsThreadedPagedFromChild	Get /Forum/GetPostsThreadedPagedFromChild/{childPostId}/{page}/{pageSize}/{replySize}/{rootThreadMode}/{sortMode}/
ForumApi	ForumGetRecruitmentThreadSummaries	Post /Forum/Recruit/Summaries/
ForumApi	ForumGetTopicForContent	Get /Forum/GetTopicForContent/{contentId}/
ForumApi	ForumGetTopicsPaged	Get /Forum/GetTopicsPaged/{page}/{pageSize}/{group}/{sort}/{quickDate}/{categoryFilter}/
GroupV2Api	GroupV2AbdicateFoundership	Post /GroupV2/{groupId}/Admin/AbdicateFoundership/{membershipType}/{founderIdNew}/
GroupV2Api	GroupV2AddOptionalConversation	Post /GroupV2/{groupId}/OptionalConversations/Add/
GroupV2Api	GroupV2ApproveAllPending	Post /GroupV2/{groupId}/Members/ApproveAll/
GroupV2Api	GroupV2ApprovePending	Post /GroupV2/{groupId}/Members/Approve/{membershipType}/{membershipId}/
GroupV2Api	GroupV2ApprovePendingForList	Post /GroupV2/{groupId}/Members/ApproveList/
GroupV2Api	GroupV2BanMember	Post /GroupV2/{groupId}/Members/{membershipType}/{membershipId}/Ban/
GroupV2Api	GroupV2DenyAllPending	Post /GroupV2/{groupId}/Members/DenyAll/
GroupV2Api	GroupV2DenyPendingForList	Post /GroupV2/{groupId}/Members/DenyList/
GroupV2Api	GroupV2EditClanBanner	Post /GroupV2/{groupId}/EditClanBanner/
GroupV2Api	GroupV2EditFounderOptions	Post /GroupV2/{groupId}/EditFounderOptions/
GroupV2Api	GroupV2EditGroup	Post /GroupV2/{groupId}/Edit/
GroupV2Api	GroupV2EditGroupMembership	Post /GroupV2/{groupId}/Members/{membershipType}/{membershipId}/SetMembershipType/{memberType}/
GroupV2Api	GroupV2EditOptionalConversation	Post /GroupV2/{groupId}/OptionalConversations/Edit/{conversationId}/
GroupV2Api	GroupV2GetAdminsAndFounderOfGroup	Get /GroupV2/{groupId}/AdminsAndFounder/{currentpage}
GroupV2Api	GroupV2GetAvailableAvatars	Get /GroupV2/GetAvailableAvatars/
GroupV2Api	GroupV2GetAvailableThemes	Get /GroupV2/GetAvailableThemes/
GroupV2Api	GroupV2GetBannedMembersOfGroup	Get /GroupV2/{groupId}/Banned/{currentpage}
GroupV2Api	GroupV2GetGroup	Get /GroupV2/{groupId}/
GroupV2Api	GroupV2GetGroupByName	Get /GroupV2/Name/{groupName}/{groupType}/
GroupV2Api	GroupV2GetGroupByNameV2	Post /GroupV2/NameV2/
GroupV2Api	GroupV2GetGroupOptionalConversations	Get /GroupV2/{groupId}/OptionalConversations/
GroupV2Api	GroupV2GetGroupsForMember	Get /GroupV2/User/{membershipType}/{membershipId}/{filter}/{groupType}/
GroupV2Api	GroupV2GetInvitedIndividuals	Get /GroupV2/{groupId}/Members/InvitedIndividuals/{currentpage}
GroupV2Api	GroupV2GetMembersOfGroupcurrentPage	Get /GroupV2/{groupId}/Members/{currentpage}
GroupV2Api	GroupV2GetPendingMemberships	Get /GroupV2/{groupId}/Members/Pending/{currentpage}
GroupV2Api	GroupV2GetPotentialGroupsForMember	Get /GroupV2/User/Potential/{membershipType}/{membershipId}/{filter}/{groupType}/
GroupV2Api	GroupV2GetRecommendedGroups	Post /GroupV2/Recommended/{groupType}/{createDateRange}/
GroupV2Api	GroupV2GetUserClanInviteSetting	Get /GroupV2/GetUserClanInviteSetting/{mType}/
GroupV2Api	GroupV2GroupSearch	Post /GroupV2/Search/
GroupV2Api	GroupV2IndividualGroupInvite	Post /GroupV2/{groupId}/Members/IndividualInvite/{membershipType}/{membershipId}/
GroupV2Api	GroupV2IndividualGroupInviteCancel	Post /GroupV2/{groupId}/Members/IndividualInviteCancel/{membershipType}/{membershipId}/
GroupV2Api	GroupV2KickMember	Post /GroupV2/{groupId}/Members/{membershipType}/{membershipId}/Kick/
GroupV2Api	GroupV2RecoverGroupForFounder	Get /GroupV2/Recover/{membershipType}/{membershipId}/{groupType}/
GroupV2Api	GroupV2UnbanMember	Post /GroupV2/{groupId}/Members/{membershipType}/{membershipId}/Unban/
PreviewApi	Destiny2GetClanAggregateStats	Get /Destiny2/Stats/AggregateClanStats/{groupId}/
PreviewApi	Destiny2GetClanLeaderboards	Get /Destiny2/Stats/Leaderboards/Clans/{groupId}/
PreviewApi	Destiny2GetLeaderboards	Get /Destiny2/{membershipType}/Account/{destinyMembershipId}/Stats/Leaderboards/
PreviewApi	Destiny2GetLeaderboardsForCharacter	Get /Destiny2/Stats/Leaderboards/{membershipType}/{destinyMembershipId}/{characterId}/
PreviewApi	Destiny2GetPublicVendors	Get /Destiny2/Vendors/
PreviewApi	Destiny2InsertSocketPlug	Post /Destiny2/Actions/Items/InsertSocketPlug/
PreviewApi	Destiny2InsertSocketPlugFree	Post /Destiny2/Actions/Items/InsertSocketPlugFree/
SocialApi	SocialAcceptFriendRequest	Post /Social/Friends/Requests/Accept/{membershipId}/
SocialApi	SocialDeclineFriendRequest	Post /Social/Friends/Requests/Decline/{membershipId}/
SocialApi	SocialGetFriendList	Get /Social/Friends/
SocialApi	SocialGetFriendRequestList	Get /Social/Friends/Requests/
SocialApi	SocialGetPlatformFriendList	Get /Social/PlatformFriends/{friendPlatform}/{page}/
SocialApi	SocialIssueFriendRequest	Post /Social/Friends/Add/{membershipId}/
SocialApi	SocialRemoveFriend	Post /Social/Friends/Remove/{membershipId}/
SocialApi	SocialRemoveFriendRequest	Post /Social/Friends/Requests/Remove/{membershipId}/
TokensApi	TokensApplyMissingPartnerOffersWithoutClaim	Post /Tokens/Partner/ApplyMissingOffers/{partnerApplicationId}/{targetBnetMembershipId}/
TokensApi	TokensClaimPartnerOffer	Post /Tokens/Partner/ClaimOffer/
TokensApi	TokensForceDropsRepair	Post /Tokens/Partner/ForceDropsRepair/
TokensApi	TokensGetBungieRewardsForPlatformUser	Get /Tokens/Rewards/GetRewardsForPlatformUser/{membershipId}/{membershipType}/
TokensApi	TokensGetBungieRewardsForUser	Get /Tokens/Rewards/GetRewardsForUser/{membershipId}/
TokensApi	TokensGetBungieRewardsList	Get /Tokens/Rewards/BungieRewards/
TokensApi	TokensGetPartnerOfferSkuHistory	Get /Tokens/Partner/History/{partnerApplicationId}/{targetBnetMembershipId}/
TokensApi	TokensGetPartnerRewardHistory	Get /Tokens/Partner/History/{targetBnetMembershipId}/Application/{partnerApplicationId}/
TrendingApi	TrendingGetTrendingCategories	Get /Trending/Categories/
TrendingApi	TrendingGetTrendingCategory	Get /Trending/Categories/{categoryId}/{pageNumber}/
TrendingApi	TrendingGetTrendingEntryDetail	Get /Trending/Details/{trendingEntryType}/{identifier}/
UserApi	UserGetAvailableThemes	Get /User/GetAvailableThemes/
UserApi	UserGetBungieNetUserById	Get /User/GetBungieNetUserById/{id}/
UserApi	UserGetCredentialTypesForTargetAccount	Get /User/GetCredentialTypesForTargetAccount/{membershipId}/
UserApi	UserGetMembershipDataById	Get /User/GetMembershipsById/{membershipId}/{membershipType}/
UserApi	UserGetMembershipDataForCurrentUser	Get /User/GetMembershipsForCurrentUser/
UserApi	UserGetMembershipFromHardLinkedCredential	Get /User/GetMembershipFromHardLinkedCredential/{crType}/{credential}/
UserApi	UserGetSanitizedPlatformDisplayNames	Get /User/GetSanitizedPlatformDisplayNames/{membershipId}/
UserApi	UserSearchByGlobalNamePost	Post /User/Search/GlobalName/{page}/
UserApi	UserSearchByGlobalNamePrefix	Get /User/Search/Prefix/{displayNamePrefix}/{page}/

Documentation For Models

Documentation For Authorization

apiKey

Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
	Key: "APIKEY",
	Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

oauth2

Type: OAuth
Flow: accessCode
Authorization URL: https://www.bungie.net/en/OAuth/Authorize
Scopes:
ReadBasicUserProfile: Read basic user profile information such as the user's handle, avatar icon, etc.
ReadGroups: Read Group/Clan Forums, Wall, and Members for groups and clans that the user has joined.
WriteGroups: Write Group/Clan Forums, Wall, and Members for groups and clans that the user has joined.
AdminGroups: Administer Group/Clan Forums, Wall, and Members for groups and clans that the user is a founder or an administrator.
BnetWrite: Create new groups, clans, and forum posts, along with other actions that are reserved for Bungie.net elevated scope: not meant to be used by third party applications.
MoveEquipDestinyItems: Move or equip Destiny items
ReadDestinyInventoryAndVault: Read Destiny 1 Inventory and Vault contents. For Destiny 2, this scope is needed to read anything regarded as private. This is the only scope a Destiny 2 app needs for read operations against Destiny 2 data such as inventory, vault, currency, vendors, milestones, progression, etc.
ReadUserData: Read user data such as who they are web notifications, clan/group memberships, recent activity, muted users.
EditUserData: Edit user data such as preferred language, status, motto, avatar selection and theme.
ReadDestinyVendorsAndAdvisors: Access vendor and advisor data specific to a user. OBSOLETE. This scope is only used on the Destiny 1 API.
ReadAndApplyTokens: Read offer history and claim and apply tokens for the user.
AdvancedWriteActions: Can perform actions that will result in a prompt to the user via the Destiny app.
PartnerOfferGrant: Can use the partner offer api to claim rewards defined for a partner
DestinyUnlockValueQuery: Allows an app to query sensitive information like unlock flags and values not available through normal methods.
UserPiiRead: Allows an app to query sensitive user PII, most notably email information.

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

Author

support@bungie.com

Documentation ¶

Overview ¶

* Bungie.Net API * * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality. * * API version: 2.18.0 * Contact: support@bungie.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Bungie.Net API * * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality. * * API version: 2.18.0 * Contact: support@bungie.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Bungie.Net API * * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality. * * API version: 2.18.0 * Contact: support@bungie.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type AllOfDestinyChallengesDestinyChallengeStatusObjective
type AllOfDestinyComponentsKiosksDestinyKioskItemFlavorObjective
type AllOfDestinyComponentsPresentationDestinyPresentationNodeComponentObjective
type AllOfDestinyComponentsProfilesDestinyProfileProgressionComponentSeasonalArtifact
type AllOfDestinyComponentsProfilesDestinyProfileTransitoryComponentCurrentActivity
type AllOfDestinyComponentsProfilesDestinyProfileTransitoryComponentJoinability
type AllOfDestinyDefinitionsArtifactsDestinyArtifactDefinitionDisplayProperties
type AllOfDestinyDefinitionsArtifactsDestinyArtifactDefinitionTranslationBlock
type AllOfDestinyDefinitionsChecklistsDestinyChecklistEntryDefinitionDisplayProperties
type AllOfDestinyDefinitionsDestinyActivityDefinitionDisplayProperties
type AllOfDestinyDefinitionsDestinyActivityDefinitionGuidedGame
type AllOfDestinyDefinitionsDestinyActivityDefinitionMatchmaking
type AllOfDestinyDefinitionsDestinyActivityDefinitionOriginalDisplayProperties
type AllOfDestinyDefinitionsDestinyActivityDefinitionSelectionScreenDisplayProperties
type AllOfDestinyDefinitionsDestinyBubbleDefinitionDisplayProperties
type AllOfDestinyDefinitionsDestinyDamageTypeDefinitionColor
type AllOfDestinyDefinitionsDestinyDamageTypeDefinitionDisplayProperties
type AllOfDestinyDefinitionsDestinyEntitySearchResultItemDisplayProperties
type AllOfDestinyDefinitionsDestinyEntitySearchResultResults
type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionAction
type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionBackgroundColor
type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionCrafting
type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionEquippingBlock
type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionGearset
type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionInventory
type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionMetrics
type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionObjectives
type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionPlug
type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionPreview
type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionQuality
type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionSack
type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionSetData
type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionSockets
type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionSourceData
type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionStats
type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionSummary
type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionTalentGrid
type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionTranslationBlock
type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionValue
type AllOfDestinyDefinitionsDestinyLocationReleaseDefinitionDisplayProperties
type AllOfDestinyDefinitionsDestinyNodeStepDefinitionActivationRequirement
type AllOfDestinyDefinitionsDestinyNodeStepDefinitionDisplayProperties
type AllOfDestinyDefinitionsDestinyNodeStepDefinitionStepGroups
type AllOfDestinyDefinitionsDestinyObjectiveDefinitionDisplayProperties
type AllOfDestinyDefinitionsDestinyObjectiveDefinitionPerks
type AllOfDestinyDefinitionsDestinyObjectiveDefinitionStats
type AllOfDestinyDefinitionsDestinyObjectiveStatEntryDefinitionStat
type AllOfDestinyDefinitionsDestinyProgressionDefinitionColor
type AllOfDestinyDefinitionsDestinyProgressionMappingDefinitionDisplayProperties
type AllOfDestinyDefinitionsDestinySandboxPerkDefinitionDisplayProperties
type AllOfDestinyDefinitionsDestinySandboxPerkDefinitionPerkGroups
type AllOfDestinyDefinitionsDestinyStatOverrideDefinitionDisplayProperties
type AllOfDestinyDefinitionsDestinyTalentNodeCategoryDisplayProperties
type AllOfDestinyDefinitionsDestinyTalentNodeDefinitionRandomActivationRequirement
type AllOfDestinyDefinitionsDestinyUnlockDefinitionDisplayProperties
type AllOfDestinyDefinitionsDestinyVendorCategoryEntryDefinitionOverlay
type AllOfDestinyDefinitionsDestinyVendorInteractionDefinitionHeaderDisplayProperties
type AllOfDestinyDefinitionsDestinyVendorInventoryFlyoutDefinitionDisplayProperties
type AllOfDestinyDefinitionsDestinyVendorItemDefinitionAction
type AllOfDestinyDefinitionsDirectorDestinyActivityGraphArtElementDefinitionPosition
type AllOfDestinyDefinitionsDirectorDestinyActivityGraphNodeDefinitionOverrideDisplay
type AllOfDestinyDefinitionsDirectorDestinyActivityGraphNodeDefinitionPosition
type AllOfDestinyDefinitionsEnergyTypesDestinyEnergyTypeDefinitionDisplayProperties
type AllOfDestinyDefinitionsItemsDestinyItemPlugDefinitionEnergyCapacity
type AllOfDestinyDefinitionsItemsDestinyItemPlugDefinitionEnergyCost
type AllOfDestinyDefinitionsItemsDestinyItemPlugDefinitionParentItemOverride
type AllOfDestinyDefinitionsItemsDestinyItemTierTypeDefinitionInfusionProcess
type AllOfDestinyDefinitionsMilestonesDestinyMilestoneQuestDefinitionDisplayProperties
type AllOfDestinyDefinitionsMilestonesDestinyMilestoneQuestDefinitionQuestRewards
type AllOfDestinyDefinitionsMilestonesDestinyMilestoneRewardCategoryDefinitionDisplayProperties
type AllOfDestinyDefinitionsMilestonesDestinyMilestoneRewardEntryDefinitionDisplayProperties
type AllOfDestinyDefinitionsPresentationDestinyPresentationNodeDefinitionChildren
type AllOfDestinyDefinitionsPresentationDestinyPresentationNodeDefinitionRequirements
type AllOfDestinyDefinitionsRecordsDestinyRecordDefinitionIntervalInfo
type AllOfDestinyDefinitionsSeasonsDestinySeasonDefinitionPreview
type AllOfDestinyDefinitionsSocialDestinySocialCommendationNodeDefinitionColor
type AllOfDestinyDefinitionsSocketsDestinyPlugSetDefinitionDisplayProperties
type AllOfDestinyDefinitionsSocketsDestinySocketTypeDefinitionDisplayProperties
type AllOfDestinyDefinitionsSocketsDestinySocketTypeDefinitionInsertAction
type AllOfDestinyDestinyTalentNodeNodeStatsBlock
type AllOfDestinyEntitiesCharactersDestinyCharacterComponentEmblemColor
type AllOfDestinyEntitiesCharactersDestinyCharacterComponentLevelProgression
type AllOfDestinyEntitiesCharactersDestinyCharacterProgressionComponentSeasonalArtifact
type AllOfDestinyEntitiesCharactersDestinyCharacterRenderComponentCustomization
type AllOfDestinyEntitiesCharactersDestinyCharacterRenderComponentPeerView
type AllOfDestinyEntitiesItemsDestinyItemComponentMetricObjective
type AllOfDestinyEntitiesItemsDestinyItemInstanceComponentEnergy
type AllOfDestinyEntitiesItemsDestinyItemInstanceComponentPrimaryStat
type AllOfDestinyEntitiesItemsDestinyItemObjectivesComponentFlavorObjective
type AllOfDestinyEntitiesItemsDestinyItemTalentGridComponentGridProgression
type AllOfDestinyEntitiesProfilesDestinyProfileComponentUserInfo
type AllOfDestinyEntitiesVendorsDestinyVendorComponentProgression
type AllOfDestinyHistoricalStatsDestinyClanAggregateStatValue
type AllOfDestinyHistoricalStatsDestinyHistoricalStatsPeriodGroupActivityDetails
type AllOfDestinyHistoricalStatsDestinyHistoricalStatsValueBasic
type AllOfDestinyHistoricalStatsDestinyHistoricalStatsValuePga
type AllOfDestinyHistoricalStatsDestinyHistoricalStatsValueWeighted
type AllOfDestinyHistoricalStatsDestinyLeaderboardEntryPlayer
type AllOfDestinyHistoricalStatsDestinyLeaderboardEntryValue
type AllOfDestinyHistoricalStatsDestinyPlayerBungieNetUserInfo
type AllOfDestinyHistoricalStatsDestinyPlayerDestinyUserInfo
type AllOfDestinyHistoricalStatsDestinyPostGameCarnageReportDataActivityDetails
type AllOfDestinyHistoricalStatsDestinyPostGameCarnageReportEntryExtended
type AllOfDestinyHistoricalStatsDestinyPostGameCarnageReportEntryPlayer
type AllOfDestinyHistoricalStatsDestinyPostGameCarnageReportEntryScore
type AllOfDestinyHistoricalStatsDestinyPostGameCarnageReportTeamEntryScore
type AllOfDestinyHistoricalStatsDestinyPostGameCarnageReportTeamEntryStanding
type AllOfDestinyMilestonesDestinyMilestoneActivityVariantCompletionStatus
type AllOfDestinyMilestonesDestinyMilestoneQuestActivity
type AllOfDestinyMilestonesDestinyMilestoneQuestStatus
type AllOfDestinyMilestonesDestinyPublicMilestoneQuestActivity
type AllOfDestinyRequestsActionsDestinyInsertPlugsActionRequestPlug
type AllOfDestinyRequestsActionsDestinyInsertPlugsFreeActionRequestPlug
type AllOfDestinyResponsesDestinyCharacterResponseActivities
type AllOfDestinyResponsesDestinyCharacterResponseCharacter
type AllOfDestinyResponsesDestinyCharacterResponseCollectibles
type AllOfDestinyResponsesDestinyCharacterResponseCurrencyLookups
type AllOfDestinyResponsesDestinyCharacterResponseEquipment
type AllOfDestinyResponsesDestinyCharacterResponseInventory
type AllOfDestinyResponsesDestinyCharacterResponseItemComponents
type AllOfDestinyResponsesDestinyCharacterResponseKiosks
type AllOfDestinyResponsesDestinyCharacterResponseLoadouts
type AllOfDestinyResponsesDestinyCharacterResponsePlugSets
type AllOfDestinyResponsesDestinyCharacterResponsePresentationNodes
type AllOfDestinyResponsesDestinyCharacterResponseProgressions
type AllOfDestinyResponsesDestinyCharacterResponseRecords
type AllOfDestinyResponsesDestinyCharacterResponseRenderData
type AllOfDestinyResponsesDestinyCharacterResponseUninstancedItemComponents
type AllOfDestinyResponsesDestinyCollectibleNodeDetailResponseCollectibleItemComponents
type AllOfDestinyResponsesDestinyCollectibleNodeDetailResponseCollectibles
type AllOfDestinyResponsesDestinyErrorProfileInfoCard
type AllOfDestinyResponsesDestinyItemResponseInstance
type AllOfDestinyResponsesDestinyItemResponseItem
type AllOfDestinyResponsesDestinyItemResponseObjectives
type AllOfDestinyResponsesDestinyItemResponsePerks
type AllOfDestinyResponsesDestinyItemResponsePlugObjectives
type AllOfDestinyResponsesDestinyItemResponseRenderData
type AllOfDestinyResponsesDestinyItemResponseReusablePlugs
type AllOfDestinyResponsesDestinyItemResponseSockets
type AllOfDestinyResponsesDestinyItemResponseStats
type AllOfDestinyResponsesDestinyItemResponseTalentGrid
type AllOfDestinyResponsesDestinyLinkedProfilesResponseBnetMembership
type AllOfDestinyResponsesDestinyProfileResponseCharacterActivities
type AllOfDestinyResponsesDestinyProfileResponseCharacterCollectibles
type AllOfDestinyResponsesDestinyProfileResponseCharacterCraftables
type AllOfDestinyResponsesDestinyProfileResponseCharacterCurrencyLookups
type AllOfDestinyResponsesDestinyProfileResponseCharacterEquipment
type AllOfDestinyResponsesDestinyProfileResponseCharacterInventories
type AllOfDestinyResponsesDestinyProfileResponseCharacterKiosks
type AllOfDestinyResponsesDestinyProfileResponseCharacterLoadouts
type AllOfDestinyResponsesDestinyProfileResponseCharacterPlugSets
type AllOfDestinyResponsesDestinyProfileResponseCharacterPresentationNodes
type AllOfDestinyResponsesDestinyProfileResponseCharacterProgressions
type AllOfDestinyResponsesDestinyProfileResponseCharacterRecords
type AllOfDestinyResponsesDestinyProfileResponseCharacterRenderData
type AllOfDestinyResponsesDestinyProfileResponseCharacterStringVariables
type AllOfDestinyResponsesDestinyProfileResponseCharacters
type AllOfDestinyResponsesDestinyProfileResponseItemComponents
type AllOfDestinyResponsesDestinyProfileResponseMetrics
type AllOfDestinyResponsesDestinyProfileResponsePlatformSilver
type AllOfDestinyResponsesDestinyProfileResponseProfile
type AllOfDestinyResponsesDestinyProfileResponseProfileCollectibles
type AllOfDestinyResponsesDestinyProfileResponseProfileCommendations
type AllOfDestinyResponsesDestinyProfileResponseProfileCurrencies
type AllOfDestinyResponsesDestinyProfileResponseProfileInventory
type AllOfDestinyResponsesDestinyProfileResponseProfileKiosks
type AllOfDestinyResponsesDestinyProfileResponseProfilePlugSets
type AllOfDestinyResponsesDestinyProfileResponseProfilePresentationNodes
type AllOfDestinyResponsesDestinyProfileResponseProfileProgression
type AllOfDestinyResponsesDestinyProfileResponseProfileRecords
type AllOfDestinyResponsesDestinyProfileResponseProfileStringVariables
type AllOfDestinyResponsesDestinyProfileResponseProfileTransitoryData
type AllOfDestinyResponsesDestinyProfileResponseVendorReceipts
type AllOfDestinyResponsesDestinyProfileUserInfoCardPlatformSilver
type AllOfDestinyResponsesDestinyPublicVendorsResponseCategories
type AllOfDestinyResponsesDestinyPublicVendorsResponseSales
type AllOfDestinyResponsesDestinyPublicVendorsResponseStringVariables
type AllOfDestinyResponsesDestinyPublicVendorsResponseVendorGroups
type AllOfDestinyResponsesDestinyPublicVendorsResponseVendors
type AllOfDestinyResponsesDestinyVendorResponseCategories
type AllOfDestinyResponsesDestinyVendorResponseCurrencyLookups
type AllOfDestinyResponsesDestinyVendorResponseItemComponents
type AllOfDestinyResponsesDestinyVendorResponseSales
type AllOfDestinyResponsesDestinyVendorResponseStringVariables
type AllOfDestinyResponsesDestinyVendorResponseVendor
type AllOfDestinyResponsesDestinyVendorsResponseCategories
type AllOfDestinyResponsesDestinyVendorsResponseCurrencyLookups
type AllOfDestinyResponsesDestinyVendorsResponseSales
type AllOfDestinyResponsesDestinyVendorsResponseStringVariables
type AllOfDestinyResponsesDestinyVendorsResponseVendorGroups
type AllOfDestinyResponsesDestinyVendorsResponseVendors
type AllOfDestinyVendorsDestinyVendorReceiptItemReceived
type AllOfTrendingTrendingEntryDestinyRitualEventContent
type AllOfTrendingTrendingEntryDestinyRitualMilestoneDetails
type AppApiAppGetApplicationApiUsageOpts
type AppApiService
- func (a *AppApiService) AppGetApplicationApiUsage(ctx context.Context, applicationId int32, ...) (*http.Response, error)
- func (a *AppApiService) AppGetBungieApplications(ctx context.Context) (*http.Response, error)
type ApplicationsApiUsage
type ApplicationsApplication
type ApplicationsApplicationDeveloper
type ApplicationsApplicationScopes
type ApplicationsApplicationStatus
type ApplicationsDatapoint
type ApplicationsDeveloperRole
type ApplicationsSeries
type BasicAuth
type BungieCredentialType
type BungieResponse
type CommonModelsCoreSetting
type CommonModelsCoreSettingsConfiguration
type CommonModelsCoreSystem
type CommonModelsDestiny2CoreSettings
type CommunityContentApiService
- func (a *CommunityContentApiService) CommunityContentGetCommunityContent(ctx context.Context, mediaFilter int32, page int32, sort int32) (*http.Response, error)
type ComponentsComponentPrivacySetting
type ComponentsComponentResponse
type ConfigClanBannerClanBannerDecal
type ConfigClanBannerClanBannerSource
type ConfigGroupTheme
type ConfigUserTheme
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type ContentApiContentGetContentByIdOpts
type ContentApiContentGetContentByTagAndTypeOpts
type ContentApiContentRssNewsArticlesOpts
type ContentApiContentSearchContentByTagAndTypeOpts
type ContentApiContentSearchContentWithTextOpts
type ContentApiService
- func (a *ContentApiService) ContentGetContentById(ctx context.Context, id int64, locale string, ...) (*http.Response, error)
- func (a *ContentApiService) ContentGetContentByTagAndType(ctx context.Context, locale string, tag string, type_ string, ...) (*http.Response, error)
- func (a *ContentApiService) ContentGetContentType(ctx context.Context, type_ string) (*http.Response, error)
- func (a *ContentApiService) ContentRssNewsArticles(ctx context.Context, pageToken string, ...) (*http.Response, error)
- func (a *ContentApiService) ContentSearchContentByTagAndType(ctx context.Context, locale string, tag string, type_ string, ...) (*http.Response, error)
- func (a *ContentApiService) ContentSearchContentWithText(ctx context.Context, locale string, ...) (*http.Response, error)
- func (a *ContentApiService) ContentSearchHelpArticles(ctx context.Context, searchtext string, size string) (*http.Response, error)
type ContentCommentSummary
type ContentContentItemPublicContract
type ContentContentRepresentation
type ContentModelsContentPreview
type ContentModelsContentPropertyDataTypeEnum
type ContentModelsContentTypeDefaultValue
type ContentModelsContentTypeDescription
type ContentModelsContentTypeProperty
type ContentModelsContentTypePropertySection
type ContentModelsTagMetadataDefinition
type ContentModelsTagMetadataItem
type ContentNewsArticleRssItem
type ContentNewsArticleRssResponse
type DatesDateRange
type DefaultApiGetGlobalAlertsOpts
type DefaultApiService
- func (a *DefaultApiService) GetAvailableLocales(ctx context.Context) (*http.Response, error)
- func (a *DefaultApiService) GetCommonSettings(ctx context.Context) (*http.Response, error)
- func (a *DefaultApiService) GetGlobalAlerts(ctx context.Context, localVarOptionals *DefaultApiGetGlobalAlertsOpts) (*http.Response, error)
- func (a *DefaultApiService) GetUserSystemOverrides(ctx context.Context) (*http.Response, error)
type Destiny2ApiDestiny2GetActivityHistoryOpts
type Destiny2ApiDestiny2GetCharacterOpts
type Destiny2ApiDestiny2GetClanAggregateStatsOpts
type Destiny2ApiDestiny2GetClanLeaderboardsOpts
type Destiny2ApiDestiny2GetCollectibleNodeDetailsOpts
type Destiny2ApiDestiny2GetHistoricalStatsForAccountOpts
type Destiny2ApiDestiny2GetHistoricalStatsOpts
type Destiny2ApiDestiny2GetItemOpts
type Destiny2ApiDestiny2GetLeaderboardsForCharacterOpts
type Destiny2ApiDestiny2GetLeaderboardsOpts
type Destiny2ApiDestiny2GetLinkedProfilesOpts
type Destiny2ApiDestiny2GetProfileOpts
type Destiny2ApiDestiny2GetPublicVendorsOpts
type Destiny2ApiDestiny2GetVendorOpts
type Destiny2ApiDestiny2GetVendorsOpts
type Destiny2ApiDestiny2SearchDestinyEntitiesOpts
type Destiny2ApiService
- func (a *Destiny2ApiService) Destiny2AwaGetActionToken(ctx context.Context, correlationId string) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2AwaInitializeRequest(ctx context.Context, body DestinyAdvancedAwaPermissionRequested) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2AwaProvideAuthorizationResult(ctx context.Context, body DestinyAdvancedAwaUserResponse) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2ClearLoadout(ctx context.Context, body DestinyRequestsActionsDestinyLoadoutActionRequest) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2EquipItem(ctx context.Context, body DestinyRequestsActionsDestinyItemActionRequest) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2EquipItems(ctx context.Context, body DestinyRequestsActionsDestinyItemSetActionRequest) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2EquipLoadout(ctx context.Context, body DestinyRequestsActionsDestinyLoadoutActionRequest) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2GetActivityHistory(ctx context.Context, characterId int64, destinyMembershipId int64, ...) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2GetCharacter(ctx context.Context, characterId int64, destinyMembershipId int64, ...) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2GetClanAggregateStats(ctx context.Context, groupId int64, ...) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2GetClanBannerSource(ctx context.Context) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2GetClanLeaderboards(ctx context.Context, groupId int64, ...) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2GetClanWeeklyRewardState(ctx context.Context, groupId int64) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2GetCollectibleNodeDetails(ctx context.Context, characterId int64, collectiblePresentationNodeHash int32, ...) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2GetDestinyAggregateActivityStats(ctx context.Context, characterId int64, destinyMembershipId int64, ...) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2GetDestinyEntityDefinition(ctx context.Context, entityType string, hashIdentifier int32) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2GetDestinyManifest(ctx context.Context) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2GetHistoricalStats(ctx context.Context, characterId int64, destinyMembershipId int64, ...) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2GetHistoricalStatsDefinition(ctx context.Context) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2GetHistoricalStatsForAccount(ctx context.Context, destinyMembershipId int64, membershipType int32, ...) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2GetItem(ctx context.Context, destinyMembershipId int64, itemInstanceId int64, ...) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2GetLeaderboards(ctx context.Context, destinyMembershipId int64, membershipType int32, ...) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2GetLeaderboardsForCharacter(ctx context.Context, characterId int64, destinyMembershipId int64, ...) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2GetLinkedProfiles(ctx context.Context, membershipId int64, membershipType int32, ...) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2GetPostGameCarnageReport(ctx context.Context, activityId int64) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2GetProfile(ctx context.Context, destinyMembershipId int64, membershipType int32, ...) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2GetPublicMilestoneContent(ctx context.Context, milestoneHash int32) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2GetPublicMilestones(ctx context.Context) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2GetPublicVendors(ctx context.Context, ...) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2GetUniqueWeaponHistory(ctx context.Context, characterId int64, destinyMembershipId int64, ...) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2GetVendor(ctx context.Context, characterId int64, destinyMembershipId int64, ...) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2GetVendors(ctx context.Context, characterId int64, destinyMembershipId int64, ...) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2InsertSocketPlug(ctx context.Context, ...) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2InsertSocketPlugFree(ctx context.Context, ...) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2PullFromPostmaster(ctx context.Context, ...) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2ReportOffensivePostGameCarnageReportPlayer(ctx context.Context, ...) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2SearchDestinyEntities(ctx context.Context, searchTerm string, type_ string, ...) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2SearchDestinyPlayerByBungieName(ctx context.Context, body UserExactSearchRequest, membershipType int32) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2SetItemLockState(ctx context.Context, body DestinyRequestsActionsDestinyItemStateRequest) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2SetQuestTrackedState(ctx context.Context, body DestinyRequestsActionsDestinyItemStateRequest) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2SnapshotLoadout(ctx context.Context, ...) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2TransferItem(ctx context.Context, body DestinyRequestsDestinyItemTransferRequest) (*http.Response, error)
- func (a *Destiny2ApiService) Destiny2UpdateLoadoutIdentifiers(ctx context.Context, ...) (*http.Response, error)
type DestinyActivitiesDestinyPublicActivityStatus
type DestinyActivityGraphNodeHighlightType
type DestinyAdvancedAwaAuthorizationResult
type DestinyAdvancedAwaInitializeResponse
type DestinyAdvancedAwaPermissionRequested
type DestinyAdvancedAwaResponseReason
type DestinyAdvancedAwaType
type DestinyAdvancedAwaUserResponse
type DestinyAdvancedAwaUserSelection
type DestinyArtifactsDestinyArtifactCharacterScoped
type DestinyArtifactsDestinyArtifactProfileScoped
type DestinyArtifactsDestinyArtifactTier
type DestinyArtifactsDestinyArtifactTierItem
type DestinyBaseItemComponentSetOfint32
type DestinyBaseItemComponentSetOfint64
type DestinyBaseItemComponentSetOfuint32
type DestinyBucketCategory
type DestinyBucketScope
type DestinyChallengesDestinyChallengeStatus
type DestinyCharacterDestinyCharacterCustomization
type DestinyCharacterDestinyCharacterPeerView
type DestinyCharacterDestinyItemPeerView
type DestinyComponentsCollectiblesDestinyCollectibleComponent
type DestinyComponentsCollectiblesDestinyCollectiblesComponent
type DestinyComponentsCollectiblesDestinyProfileCollectiblesComponent
type DestinyComponentsCraftablesDestinyCraftableComponent
type DestinyComponentsCraftablesDestinyCraftableSocketComponent
type DestinyComponentsCraftablesDestinyCraftableSocketPlugComponent
type DestinyComponentsCraftablesDestinyCraftablesComponent
type DestinyComponentsInventoryDestinyCurrenciesComponent
type DestinyComponentsInventoryDestinyPlatformSilverComponent
type DestinyComponentsItemsDestinyItemPlugComponent
type DestinyComponentsItemsDestinyItemPlugObjectivesComponent
type DestinyComponentsItemsDestinyItemReusablePlugsComponent
type DestinyComponentsKiosksDestinyKioskItem
type DestinyComponentsKiosksDestinyKiosksComponent
type DestinyComponentsLoadoutsDestinyLoadoutComponent
type DestinyComponentsLoadoutsDestinyLoadoutItemComponent
type DestinyComponentsLoadoutsDestinyLoadoutsComponent
type DestinyComponentsMetricsDestinyMetricComponent
type DestinyComponentsMetricsDestinyMetricsComponent
type DestinyComponentsPlugSetsDestinyPlugSetsComponent
type DestinyComponentsPresentationDestinyPresentationNodeComponent
type DestinyComponentsPresentationDestinyPresentationNodesComponent
type DestinyComponentsProfilesDestinyProfileProgressionComponent
type DestinyComponentsProfilesDestinyProfileTransitoryComponent
type DestinyComponentsProfilesDestinyProfileTransitoryCurrentActivity
type DestinyComponentsProfilesDestinyProfileTransitoryJoinability
type DestinyComponentsProfilesDestinyProfileTransitoryPartyMember
type DestinyComponentsProfilesDestinyProfileTransitoryTrackingEntry
type DestinyComponentsRecordsDestinyCharacterRecordsComponent
type DestinyComponentsRecordsDestinyProfileRecordsComponent
type DestinyComponentsRecordsDestinyRecordComponent
type DestinyComponentsRecordsDestinyRecordsComponent
type DestinyComponentsSocialDestinySocialCommendationsComponent
type DestinyComponentsStringVariablesDestinyStringVariablesComponent
type DestinyComponentsVendorsDestinyPublicVendorComponent
type DestinyComponentsVendorsDestinyPublicVendorSaleItemComponent
type DestinyComponentsVendorsDestinyVendorBaseComponent
type DestinyComponentsVendorsDestinyVendorGroup
type DestinyComponentsVendorsDestinyVendorGroupComponent
type DestinyComponentsVendorsDestinyVendorSaleItemBaseComponent
type DestinyConfigDestinyManifest
type DestinyConfigGearAssetDataBaseDefinition
type DestinyConfigImagePyramidEntry
type DestinyConstantsDestinyEnvironmentLocationMapping
type DestinyDamageType
type DestinyDefinitionsActivityModifiersDestinyActivityModifierDefinition
type DestinyDefinitionsAnimationsDestinyAnimationReference
type DestinyDefinitionsArtifactsDestinyArtifactDefinition
type DestinyDefinitionsArtifactsDestinyArtifactTierDefinition
type DestinyDefinitionsArtifactsDestinyArtifactTierItemDefinition
type DestinyDefinitionsBreakerTypesDestinyBreakerTypeDefinition
type DestinyDefinitionsChecklistsDestinyChecklistDefinition
type DestinyDefinitionsChecklistsDestinyChecklistEntryDefinition
type DestinyDefinitionsCollectiblesDestinyCollectibleAcquisitionBlock
type DestinyDefinitionsCollectiblesDestinyCollectibleDefinition
type DestinyDefinitionsCollectiblesDestinyCollectibleStateBlock
type DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition
type DestinyDefinitionsCommonDestinyIconSequenceDefinition
type DestinyDefinitionsCommonDestinyPositionDefinition
type DestinyDefinitionsDestinyActivityChallengeDefinition
type DestinyDefinitionsDestinyActivityDefinition
type DestinyDefinitionsDestinyActivityGraphListEntryDefinition
type DestinyDefinitionsDestinyActivityGuidedBlockDefinition
type DestinyDefinitionsDestinyActivityInsertionPointDefinition
type DestinyDefinitionsDestinyActivityLoadoutRequirement
type DestinyDefinitionsDestinyActivityLoadoutRequirementSet
type DestinyDefinitionsDestinyActivityMatchmakingBlockDefinition
type DestinyDefinitionsDestinyActivityModeDefinition
type DestinyDefinitionsDestinyActivityModifierReferenceDefinition
type DestinyDefinitionsDestinyActivityPlaylistItemDefinition
type DestinyDefinitionsDestinyActivityRewardDefinition
type DestinyDefinitionsDestinyActivityTypeDefinition
type DestinyDefinitionsDestinyActivityUnlockStringDefinition
type DestinyDefinitionsDestinyArrangementRegionFilterDefinition
type DestinyDefinitionsDestinyArtDyeReference
type DestinyDefinitionsDestinyBubbleDefinition
type DestinyDefinitionsDestinyClassDefinition
type DestinyDefinitionsDestinyDamageTypeDefinition
type DestinyDefinitionsDestinyDefinition
type DestinyDefinitionsDestinyDestinationBubbleSettingDefinition
type DestinyDefinitionsDestinyDestinationDefinition
type DestinyDefinitionsDestinyDisplayCategoryDefinition
type DestinyDefinitionsDestinyEntitySearchResult
type DestinyDefinitionsDestinyEntitySearchResultItem
type DestinyDefinitionsDestinyEquipmentSlotDefinition
type DestinyDefinitionsDestinyEquippingBlockDefinition
type DestinyDefinitionsDestinyFactionDefinition
type DestinyDefinitionsDestinyFactionVendorDefinition
type DestinyDefinitionsDestinyGearArtArrangementReference
type DestinyDefinitionsDestinyGenderDefinition
type DestinyDefinitionsDestinyInventoryBucketDefinition
type DestinyDefinitionsDestinyInventoryItemDefinition
type DestinyDefinitionsDestinyInventoryItemStatDefinition
type DestinyDefinitionsDestinyItemActionBlockDefinition
type DestinyDefinitionsDestinyItemActionRequiredItemDefinition
type DestinyDefinitionsDestinyItemCategoryDefinition
type DestinyDefinitionsDestinyItemCraftingBlockBonusPlugDefinition
type DestinyDefinitionsDestinyItemCraftingBlockDefinition
type DestinyDefinitionsDestinyItemCreationEntryLevelDefinition
type DestinyDefinitionsDestinyItemGearsetBlockDefinition
type DestinyDefinitionsDestinyItemIntrinsicSocketEntryDefinition
type DestinyDefinitionsDestinyItemInventoryBlockDefinition
type DestinyDefinitionsDestinyItemInvestmentStatDefinition
type DestinyDefinitionsDestinyItemMetricBlockDefinition
type DestinyDefinitionsDestinyItemObjectiveBlockDefinition
type DestinyDefinitionsDestinyItemPerkEntryDefinition
type DestinyDefinitionsDestinyItemPreviewBlockDefinition
type DestinyDefinitionsDestinyItemQualityBlockDefinition
type DestinyDefinitionsDestinyItemSackBlockDefinition
type DestinyDefinitionsDestinyItemSetBlockDefinition
type DestinyDefinitionsDestinyItemSetBlockEntryDefinition
type DestinyDefinitionsDestinyItemSocketBlockDefinition
type DestinyDefinitionsDestinyItemSocketCategoryDefinition
type DestinyDefinitionsDestinyItemSocketEntryDefinition
type DestinyDefinitionsDestinyItemSocketEntryPlugItemDefinition
type DestinyDefinitionsDestinyItemSocketEntryPlugItemRandomizedDefinition
type DestinyDefinitionsDestinyItemSourceBlockDefinition
type DestinyDefinitionsDestinyItemStatBlockDefinition
type DestinyDefinitionsDestinyItemSummaryBlockDefinition
type DestinyDefinitionsDestinyItemTalentGridBlockDefinition
type DestinyDefinitionsDestinyItemTooltipNotification
type DestinyDefinitionsDestinyItemTranslationBlockDefinition
type DestinyDefinitionsDestinyItemValueBlockDefinition
type DestinyDefinitionsDestinyItemVendorSourceReference
type DestinyDefinitionsDestinyItemVersionDefinition
type DestinyDefinitionsDestinyLocationDefinition
type DestinyDefinitionsDestinyLocationReleaseDefinition
type DestinyDefinitionsDestinyMaterialRequirement
type DestinyDefinitionsDestinyMaterialRequirementSetDefinition
type DestinyDefinitionsDestinyMedalTierDefinition
type DestinyDefinitionsDestinyNodeActivationRequirement
type DestinyDefinitionsDestinyNodeSocketReplaceResponse
type DestinyDefinitionsDestinyNodeStepDefinition
type DestinyDefinitionsDestinyObjectiveDefinition
type DestinyDefinitionsDestinyObjectiveDisplayProperties
type DestinyDefinitionsDestinyObjectivePerkEntryDefinition
type DestinyDefinitionsDestinyObjectiveStatEntryDefinition
type DestinyDefinitionsDestinyPlaceDefinition
type DestinyDefinitionsDestinyPlugItemCraftingRequirements
type DestinyDefinitionsDestinyPlugItemCraftingUnlockRequirement
type DestinyDefinitionsDestinyProgressionDefinition
type DestinyDefinitionsDestinyProgressionDisplayPropertiesDefinition
type DestinyDefinitionsDestinyProgressionMappingDefinition
type DestinyDefinitionsDestinyProgressionRewardDefinition
type DestinyDefinitionsDestinyProgressionRewardItemQuantity
type DestinyDefinitionsDestinyProgressionStepDefinition
type DestinyDefinitionsDestinyRaceDefinition
type DestinyDefinitionsDestinyRewardSourceCategory
type DestinyDefinitionsDestinyRewardSourceDefinition
type DestinyDefinitionsDestinySandboxPatternDefinition
type DestinyDefinitionsDestinySandboxPerkDefinition
type DestinyDefinitionsDestinyStatDefinition
type DestinyDefinitionsDestinyStatDisplayDefinition
type DestinyDefinitionsDestinyStatGroupDefinition
type DestinyDefinitionsDestinyStatOverrideDefinition
type DestinyDefinitionsDestinyTalentExclusiveGroup
type DestinyDefinitionsDestinyTalentGridDefinition
type DestinyDefinitionsDestinyTalentNodeCategory
type DestinyDefinitionsDestinyTalentNodeDefinition
type DestinyDefinitionsDestinyTalentNodeExclusiveSetDefinition
type DestinyDefinitionsDestinyTalentNodeStepDamageTypes
type DestinyDefinitionsDestinyTalentNodeStepGroups
type DestinyDefinitionsDestinyTalentNodeStepGuardianAttributes
type DestinyDefinitionsDestinyTalentNodeStepImpactEffects
type DestinyDefinitionsDestinyTalentNodeStepLightAbilities
type DestinyDefinitionsDestinyTalentNodeStepWeaponPerformances
type DestinyDefinitionsDestinyUnlockDefinition
type DestinyDefinitionsDestinyUnlockExpressionDefinition
type DestinyDefinitionsDestinyUnlockValueDefinition
type DestinyDefinitionsDestinyVendorAcceptedItemDefinition
type DestinyDefinitionsDestinyVendorActionDefinition
type DestinyDefinitionsDestinyVendorCategoryEntryDefinition
type DestinyDefinitionsDestinyVendorCategoryOverlayDefinition
type DestinyDefinitionsDestinyVendorDefinition
type DestinyDefinitionsDestinyVendorDisplayPropertiesDefinition
type DestinyDefinitionsDestinyVendorGroupDefinition
type DestinyDefinitionsDestinyVendorGroupReference
type DestinyDefinitionsDestinyVendorInteractionDefinition
type DestinyDefinitionsDestinyVendorInteractionReplyDefinition
type DestinyDefinitionsDestinyVendorInteractionSackEntryDefinition
type DestinyDefinitionsDestinyVendorInventoryFlyoutBucketDefinition
type DestinyDefinitionsDestinyVendorInventoryFlyoutDefinition
type DestinyDefinitionsDestinyVendorItemDefinition
type DestinyDefinitionsDestinyVendorItemQuantity
type DestinyDefinitionsDestinyVendorItemSocketOverride
type DestinyDefinitionsDestinyVendorRequirementDisplayEntryDefinition
type DestinyDefinitionsDestinyVendorSaleItemActionBlockDefinition
type DestinyDefinitionsDestinyVendorServiceDefinition
type DestinyDefinitionsDirectorDestinyActivityGraphArtElementDefinition
type DestinyDefinitionsDirectorDestinyActivityGraphConnectionDefinition
type DestinyDefinitionsDirectorDestinyActivityGraphDefinition
type DestinyDefinitionsDirectorDestinyActivityGraphDisplayObjectiveDefinition
type DestinyDefinitionsDirectorDestinyActivityGraphDisplayProgressionDefinition
type DestinyDefinitionsDirectorDestinyActivityGraphNodeActivityDefinition
type DestinyDefinitionsDirectorDestinyActivityGraphNodeDefinition
type DestinyDefinitionsDirectorDestinyActivityGraphNodeFeaturingStateDefinition
type DestinyDefinitionsDirectorDestinyActivityGraphNodeStateEntry
type DestinyDefinitionsDirectorDestinyLinkedGraphDefinition
type DestinyDefinitionsDirectorDestinyLinkedGraphEntryDefinition
type DestinyDefinitionsEnergyTypesDestinyEnergyTypeDefinition
type DestinyDefinitionsGuardianRanksDestinyGuardianRankConstantsDefinition
type DestinyDefinitionsGuardianRanksDestinyGuardianRankDefinition
type DestinyDefinitionsGuardianRanksDestinyGuardianRankIconBackgroundsDefinition
type DestinyDefinitionsItemsDestinyDerivedItemCategoryDefinition
type DestinyDefinitionsItemsDestinyDerivedItemDefinition
type DestinyDefinitionsItemsDestinyEnergyCapacityEntry
type DestinyDefinitionsItemsDestinyEnergyCostEntry
type DestinyDefinitionsItemsDestinyItemPlugDefinition
type DestinyDefinitionsItemsDestinyItemTierTypeDefinition
type DestinyDefinitionsItemsDestinyItemTierTypeInfusionBlock
type DestinyDefinitionsItemsDestinyParentItemOverride
type DestinyDefinitionsItemsDestinyPlugRuleDefinition
type DestinyDefinitionsLoadoutsDestinyLoadoutColorDefinition
type DestinyDefinitionsLoadoutsDestinyLoadoutConstantsDefinition
type DestinyDefinitionsLoadoutsDestinyLoadoutIconDefinition
type DestinyDefinitionsLoadoutsDestinyLoadoutNameDefinition
type DestinyDefinitionsLoreDestinyLoreDefinition
type DestinyDefinitionsMetricsDestinyMetricDefinition
type DestinyDefinitionsMilestonesDestinyMilestoneActivityDefinition
type DestinyDefinitionsMilestonesDestinyMilestoneActivityVariantDefinition
type DestinyDefinitionsMilestonesDestinyMilestoneChallengeActivityDefinition
type DestinyDefinitionsMilestonesDestinyMilestoneChallengeActivityGraphNodeEntry
type DestinyDefinitionsMilestonesDestinyMilestoneChallengeActivityPhase
type DestinyDefinitionsMilestonesDestinyMilestoneChallengeDefinition
type DestinyDefinitionsMilestonesDestinyMilestoneDefinition
type DestinyDefinitionsMilestonesDestinyMilestoneDisplayPreference
type DestinyDefinitionsMilestonesDestinyMilestoneQuestDefinition
type DestinyDefinitionsMilestonesDestinyMilestoneQuestRewardItem
type DestinyDefinitionsMilestonesDestinyMilestoneQuestRewardsDefinition
type DestinyDefinitionsMilestonesDestinyMilestoneRewardCategoryDefinition
type DestinyDefinitionsMilestonesDestinyMilestoneRewardEntryDefinition
type DestinyDefinitionsMilestonesDestinyMilestoneType
type DestinyDefinitionsMilestonesDestinyMilestoneValueDefinition
type DestinyDefinitionsMilestonesDestinyMilestoneVendorDefinition
type DestinyDefinitionsPowerCapsDestinyPowerCapDefinition
type DestinyDefinitionsPresentationDestinyPresentationChildBlock
type DestinyDefinitionsPresentationDestinyPresentationNodeBaseDefinition
type DestinyDefinitionsPresentationDestinyPresentationNodeChildEntry
type DestinyDefinitionsPresentationDestinyPresentationNodeChildEntryBase
type DestinyDefinitionsPresentationDestinyPresentationNodeChildrenBlock
type DestinyDefinitionsPresentationDestinyPresentationNodeCollectibleChildEntry
type DestinyDefinitionsPresentationDestinyPresentationNodeCraftableChildEntry
type DestinyDefinitionsPresentationDestinyPresentationNodeDefinition
type DestinyDefinitionsPresentationDestinyPresentationNodeMetricChildEntry
type DestinyDefinitionsPresentationDestinyPresentationNodeRecordChildEntry
type DestinyDefinitionsPresentationDestinyPresentationNodeRequirementsBlock
type DestinyDefinitionsPresentationDestinyScoredPresentationNodeBaseDefinition
type DestinyDefinitionsProgressionDestinyProgressionLevelRequirementDefinition
type DestinyDefinitionsRecordsDestinyRecordCompletionBlock
type DestinyDefinitionsRecordsDestinyRecordDefinition
type DestinyDefinitionsRecordsDestinyRecordExpirationBlock
type DestinyDefinitionsRecordsDestinyRecordIntervalBlock
type DestinyDefinitionsRecordsDestinyRecordIntervalObjective
type DestinyDefinitionsRecordsDestinyRecordIntervalRewards
type DestinyDefinitionsRecordsDestinyRecordTitleBlock
type DestinyDefinitionsRecordsSchemaRecordStateBlock
type DestinyDefinitionsReportingDestinyReportReasonCategoryDefinition
type DestinyDefinitionsReportingDestinyReportReasonDefinition
type DestinyDefinitionsSeasonsDestinyEventCardDefinition
type DestinyDefinitionsSeasonsDestinyEventCardImages
type DestinyDefinitionsSeasonsDestinySeasonDefinition
type DestinyDefinitionsSeasonsDestinySeasonPassDefinition
type DestinyDefinitionsSeasonsDestinySeasonPreviewDefinition
type DestinyDefinitionsSeasonsDestinySeasonPreviewImageDefinition
type DestinyDefinitionsSocialDestinySocialCommendationDefinition
type DestinyDefinitionsSocialDestinySocialCommendationNodeDefinition
type DestinyDefinitionsSocketsDestinyInsertPlugActionDefinition
type DestinyDefinitionsSocketsDestinyPlugSetDefinition
type DestinyDefinitionsSocketsDestinyPlugWhitelistEntryDefinition
type DestinyDefinitionsSocketsDestinySocketCategoryDefinition
type DestinyDefinitionsSocketsDestinySocketTypeDefinition
type DestinyDefinitionsSocketsDestinySocketTypeScalarMaterialRequirementEntry
type DestinyDefinitionsSourcesDestinyItemSourceDefinition
type DestinyDefinitionsTraitsDestinyTraitDefinition
type DestinyDefinitionsVendorsDestinyVendorLocationDefinition
type DestinyDestinyActivity
type DestinyDestinyActivityDifficultyTier
type DestinyDestinyActivityModeCategory
type DestinyDestinyActivityNavPointType
type DestinyDestinyAmmunitionType
type DestinyDestinyBreakerType
type DestinyDestinyClass
type DestinyDestinyCollectibleState
type DestinyDestinyComponentType
type DestinyDestinyEnergyType
type DestinyDestinyEquipItemResult
type DestinyDestinyEquipItemResults
type DestinyDestinyGamePrivacySetting
type DestinyDestinyGameVersions
type DestinyDestinyGatingScope
type DestinyDestinyGender
type DestinyDestinyGraphNodeState
type DestinyDestinyItemQuantity
type DestinyDestinyItemSortType
type DestinyDestinyItemSubType
type DestinyDestinyItemType
type DestinyDestinyJoinClosedReasons
type DestinyDestinyObjectiveGrantStyle
type DestinyDestinyObjectiveUiStyle
type DestinyDestinyPartyMemberStates
type DestinyDestinyPresentationDisplayStyle
type DestinyDestinyPresentationNodeState
type DestinyDestinyPresentationNodeType
type DestinyDestinyPresentationScreenStyle
type DestinyDestinyProgression
type DestinyDestinyProgressionResetEntry
type DestinyDestinyProgressionRewardItemAcquisitionBehavior
type DestinyDestinyProgressionRewardItemState
type DestinyDestinyProgressionScope
type DestinyDestinyProgressionStepDisplayEffect
type DestinyDestinyRace
type DestinyDestinyRecordState
type DestinyDestinyRecordToastStyle
type DestinyDestinyRecordValueStyle
type DestinyDestinyScope
type DestinyDestinySocketCategoryStyle
type DestinyDestinySocketVisibility
type DestinyDestinyStat
type DestinyDestinyStatAggregationType
type DestinyDestinyStatCategory
type DestinyDestinyTalentNode
type DestinyDestinyTalentNodeStatBlock
type DestinyDestinyTalentNodeState
type DestinyDestinyUnlockStatus
type DestinyDestinyUnlockValueUiStyle
type DestinyDestinyVendorFilter
type DestinyDestinyVendorInteractionRewardSelection
type DestinyDestinyVendorItemRefundPolicy
type DestinyDestinyVendorItemState
type DestinyDestinyVendorProgressionType
type DestinyDestinyVendorReplyType
type DestinyDyeReference
type DestinyEntitiesCharactersDestinyCharacterActivitiesComponent
type DestinyEntitiesCharactersDestinyCharacterComponent
type DestinyEntitiesCharactersDestinyCharacterProgressionComponent
type DestinyEntitiesCharactersDestinyCharacterRenderComponent
type DestinyEntitiesInventoryDestinyInventoryComponent
type DestinyEntitiesItemsDestinyItemComponent
type DestinyEntitiesItemsDestinyItemInstanceComponent
type DestinyEntitiesItemsDestinyItemInstanceEnergy
type DestinyEntitiesItemsDestinyItemObjectivesComponent
type DestinyEntitiesItemsDestinyItemPerksComponent
type DestinyEntitiesItemsDestinyItemRenderComponent
type DestinyEntitiesItemsDestinyItemSocketState
type DestinyEntitiesItemsDestinyItemSocketsComponent
type DestinyEntitiesItemsDestinyItemStatsComponent
type DestinyEntitiesItemsDestinyItemTalentGridComponent
type DestinyEntitiesProfilesDestinyProfileComponent
type DestinyEntitiesProfilesDestinyVendorReceiptsComponent
type DestinyEntitiesVendorsDestinyVendorCategoriesComponent
type DestinyEntitiesVendorsDestinyVendorCategory
type DestinyEntitiesVendorsDestinyVendorComponent
type DestinyEntitiesVendorsDestinyVendorSaleItemComponent
type DestinyEquipFailureReason
type DestinyEquippingItemBlockAttributes
type DestinyHistoricalStatsDefinitionsDestinyHistoricalStatsDefinition
type DestinyHistoricalStatsDefinitionsDestinyStatsCategoryType
type DestinyHistoricalStatsDefinitionsDestinyStatsGroupType
type DestinyHistoricalStatsDefinitionsDestinyStatsMergeMethod
type DestinyHistoricalStatsDefinitionsPeriodType
type DestinyHistoricalStatsDefinitionsUnitType
type DestinyHistoricalStatsDestinyActivityHistoryResults
type DestinyHistoricalStatsDestinyAggregateActivityResults
type DestinyHistoricalStatsDestinyAggregateActivityStats
type DestinyHistoricalStatsDestinyClanAggregateStat
type DestinyHistoricalStatsDestinyHistoricalStatsAccountResult
type DestinyHistoricalStatsDestinyHistoricalStatsActivity
type DestinyHistoricalStatsDestinyHistoricalStatsByPeriod
type DestinyHistoricalStatsDestinyHistoricalStatsPerCharacter
type DestinyHistoricalStatsDestinyHistoricalStatsPeriodGroup
type DestinyHistoricalStatsDestinyHistoricalStatsValue
type DestinyHistoricalStatsDestinyHistoricalStatsValuePair
type DestinyHistoricalStatsDestinyHistoricalStatsWithMerged
type DestinyHistoricalStatsDestinyHistoricalWeaponStats
type DestinyHistoricalStatsDestinyHistoricalWeaponStatsData
type DestinyHistoricalStatsDestinyLeaderboard
type DestinyHistoricalStatsDestinyLeaderboardEntry
type DestinyHistoricalStatsDestinyPlayer
type DestinyHistoricalStatsDestinyPostGameCarnageReportData
type DestinyHistoricalStatsDestinyPostGameCarnageReportEntry
type DestinyHistoricalStatsDestinyPostGameCarnageReportExtendedData
type DestinyHistoricalStatsDestinyPostGameCarnageReportTeamEntry
type DestinyItemBindStatus
type DestinyItemComponentSetOfint32
type DestinyItemComponentSetOfint64
type DestinyItemComponentSetOfuint32
type DestinyItemLocation
type DestinyItemPerkVisibility
type DestinyItemState
type DestinyMilestonesDestinyMilestone
type DestinyMilestonesDestinyMilestoneActivity
type DestinyMilestonesDestinyMilestoneActivityCompletionStatus
type DestinyMilestonesDestinyMilestoneActivityPhase
type DestinyMilestonesDestinyMilestoneActivityVariant
type DestinyMilestonesDestinyMilestoneChallengeActivity
type DestinyMilestonesDestinyMilestoneContent
type DestinyMilestonesDestinyMilestoneContentItemCategory
type DestinyMilestonesDestinyMilestoneQuest
type DestinyMilestonesDestinyMilestoneRewardCategory
type DestinyMilestonesDestinyMilestoneRewardEntry
type DestinyMilestonesDestinyMilestoneVendor
type DestinyMilestonesDestinyPublicMilestone
type DestinyMilestonesDestinyPublicMilestoneActivity
type DestinyMilestonesDestinyPublicMilestoneActivityVariant
type DestinyMilestonesDestinyPublicMilestoneChallenge
type DestinyMilestonesDestinyPublicMilestoneChallengeActivity
type DestinyMilestonesDestinyPublicMilestoneQuest
type DestinyMilestonesDestinyPublicMilestoneVendor
type DestinyMiscDestinyColor
type DestinyPerksDestinyPerkReference
type DestinyPlugAvailabilityMode
type DestinyPlugUiStyles
type DestinyProgressionDestinyFactionProgression
type DestinyQuestsDestinyObjectiveProgress
type DestinyQuestsDestinyQuestStatus
type DestinyReportingRequestsDestinyReportOffensePgcrRequest
type DestinyRequestsActionsDestinyActionRequest
type DestinyRequestsActionsDestinyCharacterActionRequest
type DestinyRequestsActionsDestinyInsertPlugsActionRequest
type DestinyRequestsActionsDestinyInsertPlugsFreeActionRequest
type DestinyRequestsActionsDestinyInsertPlugsRequestEntry
type DestinyRequestsActionsDestinyItemActionRequest
type DestinyRequestsActionsDestinyItemSetActionRequest
type DestinyRequestsActionsDestinyItemStateRequest
type DestinyRequestsActionsDestinyLoadoutActionRequest
type DestinyRequestsActionsDestinyLoadoutUpdateActionRequest
type DestinyRequestsActionsDestinyPostmasterTransferRequest
type DestinyRequestsActionsDestinySocketArrayType
type DestinyRequestsDestinyItemTransferRequest
type DestinyResponsesDestinyCharacterResponse
type DestinyResponsesDestinyCollectibleNodeDetailResponse
type DestinyResponsesDestinyErrorProfile
type DestinyResponsesDestinyItemChangeResponse
type DestinyResponsesDestinyItemResponse
type DestinyResponsesDestinyLinkedProfilesResponse
type DestinyResponsesDestinyProfileResponse
type DestinyResponsesDestinyProfileUserInfoCard
type DestinyResponsesDestinyPublicVendorsResponse
type DestinyResponsesDestinyVendorResponse
type DestinyResponsesDestinyVendorsResponse
type DestinyResponsesInventoryChangedResponse
type DestinyResponsesPersonalDestinyVendorSaleItemSetComponent
type DestinyResponsesPublicDestinyVendorSaleItemSetComponent
type DestinySocketPlugSources
type DestinySocketTypeActionType
type DestinySocketsDestinyItemPlug
type DestinySocketsDestinyItemPlugBase
type DestinySpecialItemType
type DestinyTierType
type DestinyTransferStatuses
type DestinyVendorDisplayCategorySortOrder
type DestinyVendorInteractionType
type DestinyVendorItemStatus
type DestinyVendorSaleItemSetComponentOfDestinyPublicVendorSaleItemComponent
type DestinyVendorSaleItemSetComponentOfDestinyVendorSaleItemComponent
type DestinyVendorsDestinyVendorReceipt
type DictionaryComponentResponseOfint32AndDestinyItemInstanceComponent
type DictionaryComponentResponseOfint32AndDestinyItemObjectivesComponent
type DictionaryComponentResponseOfint32AndDestinyItemPerksComponent
type DictionaryComponentResponseOfint32AndDestinyItemPlugObjectivesComponent
type DictionaryComponentResponseOfint32AndDestinyItemRenderComponent
type DictionaryComponentResponseOfint32AndDestinyItemReusablePlugsComponent
type DictionaryComponentResponseOfint32AndDestinyItemSocketsComponent
type DictionaryComponentResponseOfint32AndDestinyItemStatsComponent
type DictionaryComponentResponseOfint32AndDestinyItemTalentGridComponent
type DictionaryComponentResponseOfint32AndDestinyVendorSaleItemComponent
type DictionaryComponentResponseOfint64AndDestinyCharacterActivitiesComponent
type DictionaryComponentResponseOfint64AndDestinyCharacterComponent
type DictionaryComponentResponseOfint64AndDestinyCharacterProgressionComponent
type DictionaryComponentResponseOfint64AndDestinyCharacterRecordsComponent
type DictionaryComponentResponseOfint64AndDestinyCharacterRenderComponent
type DictionaryComponentResponseOfint64AndDestinyCollectiblesComponent
type DictionaryComponentResponseOfint64AndDestinyCraftablesComponent
type DictionaryComponentResponseOfint64AndDestinyCurrenciesComponent
type DictionaryComponentResponseOfint64AndDestinyInventoryComponent
type DictionaryComponentResponseOfint64AndDestinyItemInstanceComponent
type DictionaryComponentResponseOfint64AndDestinyItemObjectivesComponent
type DictionaryComponentResponseOfint64AndDestinyItemPerksComponent
type DictionaryComponentResponseOfint64AndDestinyItemPlugObjectivesComponent
type DictionaryComponentResponseOfint64AndDestinyItemRenderComponent
type DictionaryComponentResponseOfint64AndDestinyItemReusablePlugsComponent
type DictionaryComponentResponseOfint64AndDestinyItemSocketsComponent
type DictionaryComponentResponseOfint64AndDestinyItemStatsComponent
type DictionaryComponentResponseOfint64AndDestinyItemTalentGridComponent
type DictionaryComponentResponseOfint64AndDestinyKiosksComponent
type DictionaryComponentResponseOfint64AndDestinyLoadoutsComponent
type DictionaryComponentResponseOfint64AndDestinyPlugSetsComponent
type DictionaryComponentResponseOfint64AndDestinyPresentationNodesComponent
type DictionaryComponentResponseOfint64AndDestinyStringVariablesComponent
type DictionaryComponentResponseOfuint32AndDestinyItemInstanceComponent
type DictionaryComponentResponseOfuint32AndDestinyItemObjectivesComponent
type DictionaryComponentResponseOfuint32AndDestinyItemPerksComponent
type DictionaryComponentResponseOfuint32AndDestinyItemPlugComponent
type DictionaryComponentResponseOfuint32AndDestinyItemPlugObjectivesComponent
type DictionaryComponentResponseOfuint32AndDestinyItemRenderComponent
type DictionaryComponentResponseOfuint32AndDestinyItemReusablePlugsComponent
type DictionaryComponentResponseOfuint32AndDestinyItemSocketsComponent
type DictionaryComponentResponseOfuint32AndDestinyItemStatsComponent
type DictionaryComponentResponseOfuint32AndDestinyItemTalentGridComponent
type DictionaryComponentResponseOfuint32AndDestinyPublicVendorComponent
type DictionaryComponentResponseOfuint32AndDestinyVendorCategoriesComponent
type DictionaryComponentResponseOfuint32AndDestinyVendorComponent
type DictionaryComponentResponseOfuint32AndPersonalDestinyVendorSaleItemSetComponent
type DictionaryComponentResponseOfuint32AndPublicDestinyVendorSaleItemSetComponent
type EntitiesEntityActionResult
type ExceptionsPlatformErrorCodes
type FireteamApiFireteamGetAvailableClanFireteamsOpts
type FireteamApiFireteamGetMyClanFireteamsOpts
type FireteamApiFireteamSearchPublicAvailableClanFireteamsOpts
type FireteamApiService
- func (a *FireteamApiService) FireteamGetActivePrivateClanFireteamCount(ctx context.Context, groupId int64) (*http.Response, error)
- func (a *FireteamApiService) FireteamGetAvailableClanFireteams(ctx context.Context, activityType int32, dateRange int32, groupId int64, ...) (*http.Response, error)
- func (a *FireteamApiService) FireteamGetClanFireteam(ctx context.Context, fireteamId int64, groupId int64) (*http.Response, error)
- func (a *FireteamApiService) FireteamGetMyClanFireteams(ctx context.Context, groupId int64, includeClosed bool, page int32, ...) (*http.Response, error)
- func (a *FireteamApiService) FireteamSearchPublicAvailableClanFireteams(ctx context.Context, activityType int32, dateRange int32, page int32, ...) (*http.Response, error)
type FireteamFireteamDateRange
type FireteamFireteamMember
type FireteamFireteamPlatform
type FireteamFireteamPlatformInviteResult
type FireteamFireteamPublicSearchOption
type FireteamFireteamResponse
type FireteamFireteamSlotSearch
type FireteamFireteamSummary
type FireteamFireteamUserInfoCard
type ForumApiForumGetCoreTopicsPagedOpts
type ForumApiForumGetForumTagSuggestionsOpts
type ForumApiForumGetPostAndParentAwaitingApprovalOpts
type ForumApiForumGetPostAndParentOpts
type ForumApiForumGetPostsThreadedPagedFromChildOpts
type ForumApiForumGetPostsThreadedPagedOpts
type ForumApiForumGetTopicsPagedOpts
type ForumApiService
- func (a *ForumApiService) ForumGetCoreTopicsPaged(ctx context.Context, categoryFilter int32, page int32, quickDate int32, ...) (*http.Response, error)
- func (a *ForumApiService) ForumGetForumTagSuggestions(ctx context.Context, ...) (*http.Response, error)
- func (a *ForumApiService) ForumGetPoll(ctx context.Context, topicId int64) (*http.Response, error)
- func (a *ForumApiService) ForumGetPostAndParent(ctx context.Context, childPostId int64, ...) (*http.Response, error)
- func (a *ForumApiService) ForumGetPostAndParentAwaitingApproval(ctx context.Context, childPostId int64, ...) (*http.Response, error)
- func (a *ForumApiService) ForumGetPostsThreadedPaged(ctx context.Context, getParentPost bool, page int32, pageSize int32, ...) (*http.Response, error)
- func (a *ForumApiService) ForumGetPostsThreadedPagedFromChild(ctx context.Context, childPostId int64, page int32, pageSize int32, ...) (*http.Response, error)
- func (a *ForumApiService) ForumGetRecruitmentThreadSummaries(ctx context.Context, body []int64) (*http.Response, error)
- func (a *ForumApiService) ForumGetTopicForContent(ctx context.Context, contentId int64) (*http.Response, error)
- func (a *ForumApiService) ForumGetTopicsPaged(ctx context.Context, categoryFilter int32, group int64, page int32, ...) (*http.Response, error)
type ForumCommunityContentSortMode
type ForumForumMediaType
type ForumForumPostPopularity
type ForumForumPostSortEnum
type ForumForumRecruitmentDetail
type ForumForumRecruitmentIntensityLabel
type ForumForumRecruitmentToneLabel
type ForumForumTopicsCategoryFiltersEnum
type ForumForumTopicsQuickDateEnum
type ForumForumTopicsSortEnum
type ForumPollResponse
type ForumPollResult
type ForumPostResponse
type ForumPostSearchResponse
type ForumsForumFlagsEnum
type ForumsForumPostCategoryEnums
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type GlobalAlert
type GlobalAlertLevel
type GlobalAlertType
type GroupV2ApiGroupV2GetMembersOfGroupcurrentPageOpts
type GroupV2ApiService
- func (a *GroupV2ApiService) GroupV2AbdicateFoundership(ctx context.Context, founderIdNew int64, groupId int64, membershipType int32) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2AddOptionalConversation(ctx context.Context, body GroupsV2GroupOptionalConversationAddRequest, ...) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2ApproveAllPending(ctx context.Context, body GroupsV2GroupApplicationRequest, groupId int64) (InlineResponse2001, *http.Response, error)
- func (a *GroupV2ApiService) GroupV2ApprovePending(ctx context.Context, body GroupsV2GroupApplicationRequest, groupId int64, ...) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2ApprovePendingForList(ctx context.Context, body GroupsV2GroupApplicationListRequest, groupId int64) (InlineResponse2001, *http.Response, error)
- func (a *GroupV2ApiService) GroupV2BanMember(ctx context.Context, body GroupsV2GroupBanRequest, groupId int64, ...) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2DenyAllPending(ctx context.Context, body GroupsV2GroupApplicationRequest, groupId int64) (InlineResponse2001, *http.Response, error)
- func (a *GroupV2ApiService) GroupV2DenyPendingForList(ctx context.Context, body GroupsV2GroupApplicationListRequest, groupId int64) (InlineResponse2001, *http.Response, error)
- func (a *GroupV2ApiService) GroupV2EditClanBanner(ctx context.Context, body GroupsV2ClanBanner, groupId int64) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2EditFounderOptions(ctx context.Context, body GroupsV2GroupOptionsEditAction, groupId int64) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2EditGroup(ctx context.Context, body GroupsV2GroupEditAction, groupId int64) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2EditGroupMembership(ctx context.Context, groupId int64, membershipId int64, membershipType int32, ...) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2EditOptionalConversation(ctx context.Context, body GroupsV2GroupOptionalConversationEditRequest, ...) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2GetAdminsAndFounderOfGroup(ctx context.Context, currentpage int32, groupId int64) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2GetAvailableAvatars(ctx context.Context) (InlineResponse200, *http.Response, error)
- func (a *GroupV2ApiService) GroupV2GetAvailableThemes(ctx context.Context) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2GetBannedMembersOfGroup(ctx context.Context, currentpage int32, groupId int64) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2GetGroup(ctx context.Context, groupId int64) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2GetGroupByName(ctx context.Context, groupName string, groupType int32) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2GetGroupByNameV2(ctx context.Context, body GroupsV2GroupNameSearchRequest) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2GetGroupOptionalConversations(ctx context.Context, groupId int64) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2GetGroupsForMember(ctx context.Context, filter int32, groupType int32, membershipId int64, ...) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2GetInvitedIndividuals(ctx context.Context, currentpage int32, groupId int64) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2GetMembersOfGroupcurrentPage(ctx context.Context, currentpage int32, groupId int64, ...) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2GetPendingMemberships(ctx context.Context, currentpage int32, groupId int64) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2GetPotentialGroupsForMember(ctx context.Context, filter int32, groupType int32, membershipId int64, ...) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2GetRecommendedGroups(ctx context.Context, createDateRange int32, groupType int32) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2GetUserClanInviteSetting(ctx context.Context, mType int32) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2GroupSearch(ctx context.Context, body GroupsV2GroupQuery) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2IndividualGroupInvite(ctx context.Context, body GroupsV2GroupApplicationRequest, groupId int64, ...) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2IndividualGroupInviteCancel(ctx context.Context, groupId int64, membershipId int64, membershipType int32) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2KickMember(ctx context.Context, groupId int64, membershipId int64, membershipType int32) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2RecoverGroupForFounder(ctx context.Context, groupType int32, membershipId int64, membershipType int32) (*http.Response, error)
- func (a *GroupV2ApiService) GroupV2UnbanMember(ctx context.Context, groupId int64, membershipId int64, membershipType int32) (*http.Response, error)
type GroupsV2Capabilities
type GroupsV2ChatSecuritySetting
type GroupsV2ClanBanner
type GroupsV2GetGroupsForMemberResponse
type GroupsV2GroupAllianceStatus
type GroupsV2GroupApplicationListRequest
type GroupsV2GroupApplicationRequest
type GroupsV2GroupApplicationResolveState
type GroupsV2GroupApplicationResponse
type GroupsV2GroupBan
type GroupsV2GroupBanRequest
type GroupsV2GroupDateRange
type GroupsV2GroupEditAction
type GroupsV2GroupFeatures
type GroupsV2GroupHomepage
type GroupsV2GroupMember
type GroupsV2GroupMemberApplication
type GroupsV2GroupMemberCountFilter
type GroupsV2GroupMemberLeaveResult
type GroupsV2GroupMembership
type GroupsV2GroupMembershipBase
type GroupsV2GroupMembershipSearchResponse
type GroupsV2GroupNameSearchRequest
type GroupsV2GroupOptionalConversation
type GroupsV2GroupOptionalConversationAddRequest
type GroupsV2GroupOptionalConversationEditRequest
type GroupsV2GroupOptionsEditAction
type GroupsV2GroupPostPublicity
type GroupsV2GroupPotentialMember
type GroupsV2GroupPotentialMemberStatus
type GroupsV2GroupPotentialMembership
type GroupsV2GroupPotentialMembershipSearchResponse
type GroupsV2GroupQuery
type GroupsV2GroupResponse
type GroupsV2GroupSearchResponse
type GroupsV2GroupSortBy
type GroupsV2GroupType
type GroupsV2GroupUserBase
type GroupsV2GroupUserInfoCard
type GroupsV2GroupV2
type GroupsV2GroupV2Card
type GroupsV2GroupV2ClanInfo
type GroupsV2GroupV2ClanInfoAndInvestment
type GroupsV2GroupsForMemberFilter
type GroupsV2HostGuidedGamesPermissionLevel
type GroupsV2MembershipOption
type GroupsV2RuntimeGroupMemberType
type IgnoresIgnoreLength
type IgnoresIgnoreResponse
type IgnoresIgnoreStatus
type InlineResponse200
type InlineResponse2001
type InlineResponse2002
type InterpolationInterpolationPoint
type InterpolationInterpolationPointFloat
type LinksHyperlinkReference
type PreviewApiDestiny2GetClanAggregateStatsOpts
type PreviewApiDestiny2GetClanLeaderboardsOpts
type PreviewApiDestiny2GetLeaderboardsForCharacterOpts
type PreviewApiDestiny2GetLeaderboardsOpts
type PreviewApiDestiny2GetPublicVendorsOpts
type PreviewApiService
- func (a *PreviewApiService) Destiny2GetClanAggregateStats(ctx context.Context, groupId int64, ...) (*http.Response, error)
- func (a *PreviewApiService) Destiny2GetClanLeaderboards(ctx context.Context, groupId int64, ...) (*http.Response, error)
- func (a *PreviewApiService) Destiny2GetLeaderboards(ctx context.Context, destinyMembershipId int64, membershipType int32, ...) (*http.Response, error)
- func (a *PreviewApiService) Destiny2GetLeaderboardsForCharacter(ctx context.Context, characterId int64, destinyMembershipId int64, ...) (*http.Response, error)
- func (a *PreviewApiService) Destiny2GetPublicVendors(ctx context.Context, localVarOptionals *PreviewApiDestiny2GetPublicVendorsOpts) (*http.Response, error)
- func (a *PreviewApiService) Destiny2InsertSocketPlug(ctx context.Context, ...) (*http.Response, error)
- func (a *PreviewApiService) Destiny2InsertSocketPlugFree(ctx context.Context, ...) (*http.Response, error)
type QueriesPagedQuery
type QueriesSearchResult
type SearchResultOfContentItemPublicContract
type SearchResultOfDestinyEntitySearchResultItem
type SearchResultOfFireteamResponse
type SearchResultOfFireteamSummary
type SearchResultOfGroupBan
type SearchResultOfGroupMember
type SearchResultOfGroupMemberApplication
type SearchResultOfGroupMembership
type SearchResultOfGroupPotentialMembership
type SearchResultOfGroupV2Card
type SearchResultOfPostResponse
type SearchResultOfTrendingEntry
type SingleComponentResponseOfDestinyCharacterActivitiesComponent
type SingleComponentResponseOfDestinyCharacterComponent
type SingleComponentResponseOfDestinyCharacterProgressionComponent
type SingleComponentResponseOfDestinyCharacterRecordsComponent
type SingleComponentResponseOfDestinyCharacterRenderComponent
type SingleComponentResponseOfDestinyCollectiblesComponent
type SingleComponentResponseOfDestinyCurrenciesComponent
type SingleComponentResponseOfDestinyInventoryComponent
type SingleComponentResponseOfDestinyItemComponent
type SingleComponentResponseOfDestinyItemInstanceComponent
type SingleComponentResponseOfDestinyItemObjectivesComponent
type SingleComponentResponseOfDestinyItemPerksComponent
type SingleComponentResponseOfDestinyItemPlugObjectivesComponent
type SingleComponentResponseOfDestinyItemRenderComponent
type SingleComponentResponseOfDestinyItemReusablePlugsComponent
type SingleComponentResponseOfDestinyItemSocketsComponent
type SingleComponentResponseOfDestinyItemStatsComponent
type SingleComponentResponseOfDestinyItemTalentGridComponent
type SingleComponentResponseOfDestinyKiosksComponent
type SingleComponentResponseOfDestinyLoadoutsComponent
type SingleComponentResponseOfDestinyMetricsComponent
type SingleComponentResponseOfDestinyPlatformSilverComponent
type SingleComponentResponseOfDestinyPlugSetsComponent
type SingleComponentResponseOfDestinyPresentationNodesComponent
type SingleComponentResponseOfDestinyProfileCollectiblesComponent
type SingleComponentResponseOfDestinyProfileComponent
type SingleComponentResponseOfDestinyProfileProgressionComponent
type SingleComponentResponseOfDestinyProfileRecordsComponent
type SingleComponentResponseOfDestinyProfileTransitoryComponent
type SingleComponentResponseOfDestinySocialCommendationsComponent
type SingleComponentResponseOfDestinyStringVariablesComponent
type SingleComponentResponseOfDestinyVendorCategoriesComponent
type SingleComponentResponseOfDestinyVendorComponent
type SingleComponentResponseOfDestinyVendorGroupComponent
type SingleComponentResponseOfDestinyVendorReceiptsComponent
type SocialApiService
- func (a *SocialApiService) SocialAcceptFriendRequest(ctx context.Context, membershipId string) (*http.Response, error)
- func (a *SocialApiService) SocialDeclineFriendRequest(ctx context.Context, membershipId string) (*http.Response, error)
- func (a *SocialApiService) SocialGetFriendList(ctx context.Context) (*http.Response, error)
- func (a *SocialApiService) SocialGetFriendRequestList(ctx context.Context) (*http.Response, error)
- func (a *SocialApiService) SocialGetPlatformFriendList(ctx context.Context, friendPlatform int32, page string) (*http.Response, error)
- func (a *SocialApiService) SocialIssueFriendRequest(ctx context.Context, membershipId string) (*http.Response, error)
- func (a *SocialApiService) SocialRemoveFriend(ctx context.Context, membershipId string) (*http.Response, error)
- func (a *SocialApiService) SocialRemoveFriendRequest(ctx context.Context, membershipId string) (*http.Response, error)
type SocialFriendsBungieFriend
type SocialFriendsBungieFriendListResponse
type SocialFriendsBungieFriendRequestListResponse
type SocialFriendsFriendRelationshipState
type SocialFriendsPlatformFriend
type SocialFriendsPlatformFriendResponse
type SocialFriendsPlatformFriendType
type SocialFriendsPresenceOnlineStateFlags
type SocialFriendsPresenceStatus
type StreamInfo
type StreamingDropStateEnum
type TagsModelsContractsTagResponse
type TokensApiService
- func (a *TokensApiService) TokensApplyMissingPartnerOffersWithoutClaim(ctx context.Context, partnerApplicationId int32, targetBnetMembershipId int64) (*http.Response, error)
- func (a *TokensApiService) TokensClaimPartnerOffer(ctx context.Context, body TokensPartnerOfferClaimRequest) (*http.Response, error)
- func (a *TokensApiService) TokensForceDropsRepair(ctx context.Context) (*http.Response, error)
- func (a *TokensApiService) TokensGetBungieRewardsForPlatformUser(ctx context.Context, membershipId int64, membershipType int32) (InlineResponse2002, *http.Response, error)
- func (a *TokensApiService) TokensGetBungieRewardsForUser(ctx context.Context, membershipId int64) (InlineResponse2002, *http.Response, error)
- func (a *TokensApiService) TokensGetBungieRewardsList(ctx context.Context) (InlineResponse2002, *http.Response, error)
- func (a *TokensApiService) TokensGetPartnerOfferSkuHistory(ctx context.Context, partnerApplicationId int32, targetBnetMembershipId int64) (*http.Response, error)
- func (a *TokensApiService) TokensGetPartnerRewardHistory(ctx context.Context, partnerApplicationId int32, targetBnetMembershipId int64) (*http.Response, error)
type TokensBungieRewardDisplay
type TokensCollectibleDefinitions
type TokensPartnerOfferClaimRequest
type TokensPartnerOfferHistoryResponse
type TokensPartnerOfferSkuHistoryResponse
type TokensPartnerRewardHistoryResponse
type TokensRewardAvailabilityModel
type TokensRewardDisplayProperties
type TokensTwitchDropHistoryResponse
type TokensUserRewardAvailabilityModel
type TrendingApiService
- func (a *TrendingApiService) TrendingGetTrendingCategories(ctx context.Context) (*http.Response, error)
- func (a *TrendingApiService) TrendingGetTrendingCategory(ctx context.Context, categoryId string, pageNumber int32) (*http.Response, error)
- func (a *TrendingApiService) TrendingGetTrendingEntryDetail(ctx context.Context, identifier string, trendingEntryType int32) (*http.Response, error)
type TrendingTrendingCategories
type TrendingTrendingCategory
type TrendingTrendingDetail
type TrendingTrendingEntry
type TrendingTrendingEntryCommunityCreation
type TrendingTrendingEntryDestinyActivity
type TrendingTrendingEntryDestinyItem
type TrendingTrendingEntryDestinyRitual
type TrendingTrendingEntryNews
type TrendingTrendingEntrySupportArticle
type TrendingTrendingEntryType
type UserApiService
- func (a *UserApiService) UserGetAvailableThemes(ctx context.Context) (*http.Response, error)
- func (a *UserApiService) UserGetBungieNetUserById(ctx context.Context, id int64) (*http.Response, error)
- func (a *UserApiService) UserGetCredentialTypesForTargetAccount(ctx context.Context, membershipId int64) (*http.Response, error)
- func (a *UserApiService) UserGetMembershipDataById(ctx context.Context, membershipId int64, membershipType int32) (*http.Response, error)
- func (a *UserApiService) UserGetMembershipDataForCurrentUser(ctx context.Context) (*http.Response, error)
- func (a *UserApiService) UserGetMembershipFromHardLinkedCredential(ctx context.Context, credential string, crType int32) (*http.Response, error)
- func (a *UserApiService) UserGetSanitizedPlatformDisplayNames(ctx context.Context, membershipId int64) (*http.Response, error)
- func (a *UserApiService) UserSearchByGlobalNamePost(ctx context.Context, body UserUserSearchPrefixRequest, page int32) (*http.Response, error)
- func (a *UserApiService) UserSearchByGlobalNamePrefix(ctx context.Context, displayNamePrefix string, page int32) (*http.Response, error)
type UserCrossSaveUserMembership
type UserEMailSettingLocalization
type UserEMailSettingSubscriptionLocalization
type UserEmailOptInDefinition
type UserEmailSettings
type UserEmailSubscriptionDefinition
type UserEmailViewDefinition
type UserEmailViewDefinitionSetting
type UserExactSearchRequest
type UserGeneralUser
type UserHardLinkedUserMembership
type UserModelsGetCredentialTypesForAccountResponse
type UserOptInFlags
type UserUserInfoCard
type UserUserMembership
type UserUserMembershipData
type UserUserSearchPrefixRequest
type UserUserSearchResponse
type UserUserSearchResponseDetail
type UserUserToUserContext

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶

type APIClient struct {
	DefaultApi *DefaultApiService

	AppApi *AppApiService

	CommunityContentApi *CommunityContentApiService

	ContentApi *ContentApiService

	Destiny2Api *Destiny2ApiService

	FireteamApi *FireteamApiService

	ForumApi *ForumApiService

	GroupV2Api *GroupV2ApiService

	PreviewApi *PreviewApiService

	SocialApi *SocialApiService

	TokensApi *TokensApiService

	TrendingApi *TrendingApiService

	UserApi *UserApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Bungie.Net API API v2.18.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AllOfDestinyChallengesDestinyChallengeStatusObjective ¶

type AllOfDestinyChallengesDestinyChallengeStatusObjective struct {
	// The unique identifier of the Objective being referred to. Use to look up the DestinyObjectiveDefinition in static data.
	ObjectiveHash int32 `json:"objectiveHash,omitempty"`
	// If the Objective has a Destination associated with it, this is the unique identifier of the Destination being referred to. Use to look up the DestinyDestinationDefinition in static data. This will give localized data about *where* in the universe the objective should be achieved.
	DestinationHash int32 `json:"destinationHash,omitempty"`
	// If the Objective has an Activity associated with it, this is the unique identifier of the Activity being referred to. Use to look up the DestinyActivityDefinition in static data. This will give localized data about *what* you should be playing for the objective to be achieved.
	ActivityHash int32 `json:"activityHash,omitempty"`
	// If progress has been made, and the progress can be measured numerically, this will be the value of that progress. You can compare it to the DestinyObjectiveDefinition.completionValue property for current vs. upper bounds, and use DestinyObjectiveDefinition.inProgressValueStyle or completedValueStyle to determine how this should be rendered. Note that progress, in Destiny 2, need not be a literal numeric progression. It could be one of a number of possible values, even a Timestamp. Always examine DestinyObjectiveDefinition.inProgressValueStyle or completedValueStyle before rendering progress.
	Progress int32 `json:"progress,omitempty"`
	// As of Forsaken, objectives' completion value is determined dynamically at runtime.  This value represents the threshold of progress you need to surpass in order for this objective to be considered \"complete\".  If you were using objective data, switch from using the DestinyObjectiveDefinition's \"completionValue\" to this value.
	CompletionValue int32 `json:"completionValue,omitempty"`
	// Whether or not the Objective is completed.
	Complete bool `json:"complete,omitempty"`
	// If this is true, the objective is visible in-game. Otherwise, it's not yet visible to the player. Up to you if you want to honor this property.
	Visible bool `json:"visible,omitempty"`
}

The progress - including completion status - of the active challenge.

type AllOfDestinyComponentsKiosksDestinyKioskItemFlavorObjective ¶

type AllOfDestinyComponentsKiosksDestinyKioskItemFlavorObjective struct {
	// The unique identifier of the Objective being referred to. Use to look up the DestinyObjectiveDefinition in static data.
	ObjectiveHash int32 `json:"objectiveHash,omitempty"`
	// If the Objective has a Destination associated with it, this is the unique identifier of the Destination being referred to. Use to look up the DestinyDestinationDefinition in static data. This will give localized data about *where* in the universe the objective should be achieved.
	DestinationHash int32 `json:"destinationHash,omitempty"`
	// If the Objective has an Activity associated with it, this is the unique identifier of the Activity being referred to. Use to look up the DestinyActivityDefinition in static data. This will give localized data about *what* you should be playing for the objective to be achieved.
	ActivityHash int32 `json:"activityHash,omitempty"`
	// If progress has been made, and the progress can be measured numerically, this will be the value of that progress. You can compare it to the DestinyObjectiveDefinition.completionValue property for current vs. upper bounds, and use DestinyObjectiveDefinition.inProgressValueStyle or completedValueStyle to determine how this should be rendered. Note that progress, in Destiny 2, need not be a literal numeric progression. It could be one of a number of possible values, even a Timestamp. Always examine DestinyObjectiveDefinition.inProgressValueStyle or completedValueStyle before rendering progress.
	Progress int32 `json:"progress,omitempty"`
	// As of Forsaken, objectives' completion value is determined dynamically at runtime.  This value represents the threshold of progress you need to surpass in order for this objective to be considered \"complete\".  If you were using objective data, switch from using the DestinyObjectiveDefinition's \"completionValue\" to this value.
	CompletionValue int32 `json:"completionValue,omitempty"`
	// Whether or not the Objective is completed.
	Complete bool `json:"complete,omitempty"`
	// If this is true, the objective is visible in-game. Otherwise, it's not yet visible to the player. Up to you if you want to honor this property.
	Visible bool `json:"visible,omitempty"`
}

I may regret naming it this way - but this represents when an item has an objective that doesn't serve a beneficial purpose, but rather is used for \"flavor\" or additional information. For instance, when Emblems track specific stats, those stats are represented as Objectives on the item.

type AllOfDestinyComponentsPresentationDestinyPresentationNodeComponentObjective ¶

type AllOfDestinyComponentsPresentationDestinyPresentationNodeComponentObjective struct {
	// The unique identifier of the Objective being referred to. Use to look up the DestinyObjectiveDefinition in static data.
	ObjectiveHash int32 `json:"objectiveHash,omitempty"`
	// If the Objective has a Destination associated with it, this is the unique identifier of the Destination being referred to. Use to look up the DestinyDestinationDefinition in static data. This will give localized data about *where* in the universe the objective should be achieved.
	DestinationHash int32 `json:"destinationHash,omitempty"`
	// If the Objective has an Activity associated with it, this is the unique identifier of the Activity being referred to. Use to look up the DestinyActivityDefinition in static data. This will give localized data about *what* you should be playing for the objective to be achieved.
	ActivityHash int32 `json:"activityHash,omitempty"`
	// If progress has been made, and the progress can be measured numerically, this will be the value of that progress. You can compare it to the DestinyObjectiveDefinition.completionValue property for current vs. upper bounds, and use DestinyObjectiveDefinition.inProgressValueStyle or completedValueStyle to determine how this should be rendered. Note that progress, in Destiny 2, need not be a literal numeric progression. It could be one of a number of possible values, even a Timestamp. Always examine DestinyObjectiveDefinition.inProgressValueStyle or completedValueStyle before rendering progress.
	Progress int32 `json:"progress,omitempty"`
	// As of Forsaken, objectives' completion value is determined dynamically at runtime.  This value represents the threshold of progress you need to surpass in order for this objective to be considered \"complete\".  If you were using objective data, switch from using the DestinyObjectiveDefinition's \"completionValue\" to this value.
	CompletionValue int32 `json:"completionValue,omitempty"`
	// Whether or not the Objective is completed.
	Complete bool `json:"complete,omitempty"`
	// If this is true, the objective is visible in-game. Otherwise, it's not yet visible to the player. Up to you if you want to honor this property.
	Visible bool `json:"visible,omitempty"`
}

An optional property: presentation nodes MAY have objectives, which can be used to infer more human readable data about the progress. However, progressValue and completionValue ought to be considered the canonical values for progress on Progression Nodes.

type AllOfDestinyComponentsProfilesDestinyProfileProgressionComponentSeasonalArtifact ¶

type AllOfDestinyComponentsProfilesDestinyProfileProgressionComponentSeasonalArtifact struct {
	ArtifactHash          int32                      `json:"artifactHash,omitempty"`
	PointProgression      *DestinyDestinyProgression `json:"pointProgression,omitempty"`
	PointsAcquired        int32                      `json:"pointsAcquired,omitempty"`
	PowerBonusProgression *DestinyDestinyProgression `json:"powerBonusProgression,omitempty"`
	PowerBonus            int32                      `json:"powerBonus,omitempty"`
}

Data related to your progress on the current season's artifact that is the same across characters.

type AllOfDestinyComponentsProfilesDestinyProfileTransitoryComponentCurrentActivity ¶

type AllOfDestinyComponentsProfilesDestinyProfileTransitoryComponentCurrentActivity struct {
	// When the activity started.
	StartTime time.Time `json:"startTime,omitempty"`
	// If you're still in it but it \"ended\" (like when folks are dancing around the loot after they beat a boss), this is when the activity ended.
	EndTime time.Time `json:"endTime,omitempty"`
	// This is what our non-authoritative source thought the score was.
	Score float32 `json:"score,omitempty"`
	// If you have human opponents, this is the highest opposing team's score.
	HighestOpposingFactionScore float32 `json:"highestOpposingFactionScore,omitempty"`
	// This is how many human or poorly crafted aimbot opponents you have.
	NumberOfOpponents int32 `json:"numberOfOpponents,omitempty"`
	// This is how many human or poorly crafted aimbots are on your team.
	NumberOfPlayers int32 `json:"numberOfPlayers,omitempty"`
}

If you are in an activity, this is some transitory info about the activity currently being played.

type AllOfDestinyComponentsProfilesDestinyProfileTransitoryComponentJoinability ¶

type AllOfDestinyComponentsProfilesDestinyProfileTransitoryComponentJoinability struct {
	// The number of slots still available on this person's fireteam.
	OpenSlots int32 `json:"openSlots,omitempty"`
	// Who the person is currently allowing invites from.
	PrivacySetting int32 `json:"privacySetting,omitempty"`
	// Reasons why a person can't join this person's fireteam.
	ClosedReasons int32 `json:"closedReasons,omitempty"`
}

Information about whether and what might prevent you from joining this person on a fireteam.

type AllOfDestinyDefinitionsArtifactsDestinyArtifactDefinitionDisplayProperties ¶

type AllOfDestinyDefinitionsArtifactsDestinyArtifactDefinitionDisplayProperties struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

Any basic display info we know about the Artifact. Currently sourced from a related inventory item, but the source of this data is subject to change.

type AllOfDestinyDefinitionsArtifactsDestinyArtifactDefinitionTranslationBlock ¶

type AllOfDestinyDefinitionsArtifactsDestinyArtifactDefinitionTranslationBlock struct {
	WeaponPatternIdentifier string                                                 `json:"weaponPatternIdentifier,omitempty"`
	WeaponPatternHash       int32                                                  `json:"weaponPatternHash,omitempty"`
	DefaultDyes             []DestinyDyeReference                                  `json:"defaultDyes,omitempty"`
	LockedDyes              []DestinyDyeReference                                  `json:"lockedDyes,omitempty"`
	CustomDyes              []DestinyDyeReference                                  `json:"customDyes,omitempty"`
	Arrangements            []DestinyDefinitionsDestinyGearArtArrangementReference `json:"arrangements,omitempty"`
	HasGeometry             bool                                                   `json:"hasGeometry,omitempty"`
}

Any Geometry/3D info we know about the Artifact. Currently sourced from a related inventory item's gearset information, but the source of this data is subject to change.

type AllOfDestinyDefinitionsChecklistsDestinyChecklistEntryDefinitionDisplayProperties ¶

type AllOfDestinyDefinitionsChecklistsDestinyChecklistEntryDefinitionDisplayProperties struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

Even if no other associations exist, we will give you *something* for display properties. In cases where we have no associated entities, it may be as simple as a numerical identifier.

type AllOfDestinyDefinitionsDestinyActivityDefinitionDisplayProperties ¶

type AllOfDestinyDefinitionsDestinyActivityDefinitionDisplayProperties struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

The title, subtitle, and icon for the activity. We do a little post-processing on this to try and account for Activities where the designers have left this data too minimal to determine what activity is actually being played.

type AllOfDestinyDefinitionsDestinyActivityDefinitionGuidedGame ¶

type AllOfDestinyDefinitionsDestinyActivityDefinitionGuidedGame struct {
	// The maximum amount of people that can be in the waiting lobby.
	GuidedMaxLobbySize int32 `json:"guidedMaxLobbySize,omitempty"`
	// The minimum amount of people that can be in the waiting lobby.
	GuidedMinLobbySize int32 `json:"guidedMinLobbySize,omitempty"`
	// If -1, the guided group cannot be disbanded. Otherwise, take the total # of players in the activity and subtract this number: that is the total # of votes needed for the guided group to disband.
	GuidedDisbandCount int32 `json:"guidedDisbandCount,omitempty"`
}

This block of data, if it exists, provides information about the guided game experience and restrictions for this activity. If it doesn't exist, the game is not able to be played as a guided game.

type AllOfDestinyDefinitionsDestinyActivityDefinitionMatchmaking ¶

type AllOfDestinyDefinitionsDestinyActivityDefinitionMatchmaking struct {
	// If TRUE, the activity is matchmade. Otherwise, it requires explicit forming of a party.
	IsMatchmade bool `json:"isMatchmade,omitempty"`
	// The minimum # of people in the fireteam for the activity to launch.
	MinParty int32 `json:"minParty,omitempty"`
	// The maximum # of people allowed in a Fireteam.
	MaxParty int32 `json:"maxParty,omitempty"`
	// The maximum # of people allowed across all teams in the activity.
	MaxPlayers int32 `json:"maxPlayers,omitempty"`
	// If true, you have to Solemnly Swear to be up to Nothing But Good(tm) to play.
	RequiresGuardianOath bool `json:"requiresGuardianOath,omitempty"`
}

This block of data provides information about the Activity's matchmaking attributes: how many people can join and such.

type AllOfDestinyDefinitionsDestinyActivityDefinitionOriginalDisplayProperties ¶

type AllOfDestinyDefinitionsDestinyActivityDefinitionOriginalDisplayProperties struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

The unadulterated form of the display properties, as they ought to be shown in the Director (if the activity appears in the director).

type AllOfDestinyDefinitionsDestinyActivityDefinitionSelectionScreenDisplayProperties ¶

type AllOfDestinyDefinitionsDestinyActivityDefinitionSelectionScreenDisplayProperties struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

The title, subtitle, and icon for the activity as determined by Selection Screen data, if there is any for this activity. There won't be data in this field if the activity is never shown in a selection/options screen.

type AllOfDestinyDefinitionsDestinyBubbleDefinitionDisplayProperties ¶

type AllOfDestinyDefinitionsDestinyBubbleDefinitionDisplayProperties struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

The display properties of this bubble, so you don't have to look them up in a separate list anymore.

type AllOfDestinyDefinitionsDestinyDamageTypeDefinitionColor ¶

type AllOfDestinyDefinitionsDestinyDamageTypeDefinitionColor struct {
	Red   string `json:"red,omitempty"`
	Green string `json:"green,omitempty"`
	Blue  string `json:"blue,omitempty"`
	Alpha string `json:"alpha,omitempty"`
}

A color associated with the damage type. The displayProperties icon is tinted with a color close to this.

type AllOfDestinyDefinitionsDestinyDamageTypeDefinitionDisplayProperties ¶

type AllOfDestinyDefinitionsDestinyDamageTypeDefinitionDisplayProperties struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

The description of the damage type, icon etc...

type AllOfDestinyDefinitionsDestinyEntitySearchResultItemDisplayProperties ¶

type AllOfDestinyDefinitionsDestinyEntitySearchResultItemDisplayProperties struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

Basic display properties on the entity, so you don't have to look up the definition to show basic results for the item.

type AllOfDestinyDefinitionsDestinyEntitySearchResultResults ¶

type AllOfDestinyDefinitionsDestinyEntitySearchResultResults struct {
	Results                      []DestinyDefinitionsDestinyEntitySearchResultItem `json:"results,omitempty"`
	TotalResults                 int32                                             `json:"totalResults,omitempty"`
	HasMore                      bool                                              `json:"hasMore,omitempty"`
	Query                        *QueriesPagedQuery                                `json:"query,omitempty"`
	ReplacementContinuationToken string                                            `json:"replacementContinuationToken,omitempty"`
	// If useTotalResults is true, then totalResults represents an accurate count.  If False, it does not, and may be estimated/only the size of the current page.  Either way, you should probably always only trust hasMore.  This is a long-held historical throwback to when we used to do paging with known total results. Those queries toasted our database, and we were left to hastily alter our endpoints and create backward- compatible shims, of which useTotalResults is one.
	UseTotalResults bool `json:"useTotalResults,omitempty"`
}

The items found that are matches/near matches for the searched-for term, sorted by something vaguely resembling \"relevance\". Hopefully this will get better in the future.

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionAction ¶

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionAction struct {
	// Localized text for the verb of the action being performed.
	VerbName string `json:"verbName,omitempty"`
	// Localized text describing the action being performed.
	VerbDescription string `json:"verbDescription,omitempty"`
	// The content has this property, however it's not entirely clear how it is used.
	IsPositive bool `json:"isPositive,omitempty"`
	// If the action has an overlay screen associated with it, this is the name of that screen. Unfortunately, we cannot return the screen's data itself.
	OverlayScreenName string `json:"overlayScreenName,omitempty"`
	// The icon associated with the overlay screen for the action, if any.
	OverlayIcon string `json:"overlayIcon,omitempty"`
	// The number of seconds to delay before allowing this action to be performed again.
	RequiredCooldownSeconds int32 `json:"requiredCooldownSeconds,omitempty"`
	// If the action requires other items to exist or be destroyed, this is the list of those items and requirements.
	RequiredItems []DestinyDefinitionsDestinyItemActionRequiredItemDefinition `json:"requiredItems,omitempty"`
	// If performing this action earns you Progression, this is the list of progressions and values granted for those progressions by performing this action.
	ProgressionRewards []DestinyDefinitionsDestinyProgressionRewardDefinition `json:"progressionRewards,omitempty"`
	// The internal identifier for the action.
	ActionTypeLabel string `json:"actionTypeLabel,omitempty"`
	// Theoretically, an item could have a localized string for a hint about the location in which the action should be performed. In practice, no items yet have this property.
	RequiredLocation string `json:"requiredLocation,omitempty"`
	// The identifier hash for the Cooldown associated with this action. We have not pulled this data yet for you to have more data to use for cooldowns.
	RequiredCooldownHash int32 `json:"requiredCooldownHash,omitempty"`
	// If true, the item is deleted when the action completes.
	DeleteOnAction bool `json:"deleteOnAction,omitempty"`
	// If true, the entire stack is deleted when the action completes.
	ConsumeEntireStack bool `json:"consumeEntireStack,omitempty"`
	// If true, this action will be performed as soon as you earn this item. Some rewards work this way, providing you a single item to pick up from a reward-granting vendor in-game and then immediately consuming itself to provide you multiple items.
	UseOnAcquire bool `json:"useOnAcquire,omitempty"`
}

If the item can be \"used\", this block will be non-null, and will have data related to the action performed when using the item. (Guess what? 99% of the time, this action is \"dismantle\". Shocker)

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionBackgroundColor ¶

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionBackgroundColor struct {
	Red   string `json:"red,omitempty"`
	Green string `json:"green,omitempty"`
	Blue  string `json:"blue,omitempty"`
	Alpha string `json:"alpha,omitempty"`
}

Sometimes, an item will have a background color. Most notably this occurs with Emblems, who use the Background Color for small character nameplates such as the \"friends\" view you see in-game. There are almost certainly other items that have background color as well, though I have not bothered to investigate what items have it nor what purposes they serve: use it as you will.

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionCrafting ¶

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionCrafting struct {
	// A reference to the item definition that is created when crafting with this 'recipe' item.
	OutputItemHash int32 `json:"outputItemHash,omitempty"`
	// A list of socket type hashes that describes which sockets are required for crafting with this recipe.
	RequiredSocketTypeHashes []int32  `json:"requiredSocketTypeHashes,omitempty"`
	FailedRequirementStrings []string `json:"failedRequirementStrings,omitempty"`
	// A reference to the base material requirements for crafting with this recipe.
	BaseMaterialRequirements int32 `json:"baseMaterialRequirements,omitempty"`
	// A list of 'bonus' socket plugs that may be available if certain requirements are met.
	BonusPlugs []DestinyDefinitionsDestinyItemCraftingBlockBonusPlugDefinition `json:"bonusPlugs,omitempty"`
}

Recipe items will have relevant crafting information available here.

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionEquippingBlock ¶

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionEquippingBlock struct {
	// If the item is part of a gearset, this is a reference to that gearset item.
	GearsetItemHash int32 `json:"gearsetItemHash,omitempty"`
	// If defined, this is the label used to check if the item has other items of matching types already equipped.   For instance, when you aren't allowed to equip more than one Exotic Weapon, that's because all exotic weapons have identical uniqueLabels and the game checks the to-be-equipped item's uniqueLabel vs. all other already equipped items (other than the item in the slot that's about to be occupied).
	UniqueLabel string `json:"uniqueLabel,omitempty"`
	// The hash of that unique label. Does not point to a specific definition.
	UniqueLabelHash int32 `json:"uniqueLabelHash,omitempty"`
	// An equipped item *must* be equipped in an Equipment Slot. This is the hash identifier of the DestinyEquipmentSlotDefinition into which it must be equipped.
	EquipmentSlotTypeHash int32 `json:"equipmentSlotTypeHash,omitempty"`
	// These are custom attributes on the equippability of the item.  For now, this can only be \"equip on acquire\", which would mean that the item will be automatically equipped as soon as you pick it up.
	Attributes int32 `json:"attributes,omitempty"`
	// Ammo type used by a weapon is no longer determined by the bucket in which it is contained. If the item has an ammo type - i.e. if it is a weapon - this will be the type of ammunition expected.
	AmmoType int32 `json:"ammoType,omitempty"`
	// These are strings that represent the possible Game/Account/Character state failure conditions that can occur when trying to equip the item. They match up one-to-one with requiredUnlockExpressions.
	DisplayStrings []string `json:"displayStrings,omitempty"`
}

If this item can be equipped, this block will be non-null and will be populated with the conditions under which it can be equipped.

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionGearset ¶

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionGearset struct {
	// The maximum possible number of items that can be collected.
	TrackingValueMax int32 `json:"trackingValueMax,omitempty"`
	// The list of hashes for items in the gearset. Use them to look up DestinyInventoryItemDefinition entries for the items in the set.
	ItemList []int32 `json:"itemList,omitempty"`
}

If this item has related items in a \"Gear Set\", this will be non-null and the relationships defined herein.

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionInventory ¶

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionInventory struct {
	// If this string is populated, you can't have more than one stack with this label in a given inventory. Note that this is different from the equipping block's unique label, which is used for equipping uniqueness.
	StackUniqueLabel string `json:"stackUniqueLabel,omitempty"`
	// The maximum quantity of this item that can exist in a stack.
	MaxStackSize int32 `json:"maxStackSize,omitempty"`
	// The hash identifier for the DestinyInventoryBucketDefinition to which this item belongs. I should have named this \"bucketHash\", but too many things refer to it now. Sigh.
	BucketTypeHash int32 `json:"bucketTypeHash,omitempty"`
	// If the item is picked up by the lost loot queue, this is the hash identifier for the DestinyInventoryBucketDefinition into which it will be placed. Again, I should have named this recoveryBucketHash instead.
	RecoveryBucketTypeHash int32 `json:"recoveryBucketTypeHash,omitempty"`
	// The hash identifier for the Tier Type of the item, use to look up its DestinyItemTierTypeDefinition if you need to show localized data for the item's tier.
	TierTypeHash int32 `json:"tierTypeHash,omitempty"`
	// If TRUE, this item is instanced. Otherwise, it is a generic item that merely has a quantity in a stack (like Glimmer).
	IsInstanceItem bool `json:"isInstanceItem,omitempty"`
	// The localized name of the tier type, which is a useful shortcut so you don't have to look up the definition every time. However, it's mostly a holdover from days before we had a DestinyItemTierTypeDefinition to refer to.
	TierTypeName string `json:"tierTypeName,omitempty"`
	// The enumeration matching the tier type of the item to known values, again for convenience sake.
	TierType int32 `json:"tierType,omitempty"`
	// The tooltip message to show, if any, when the item expires.
	ExpirationTooltip string `json:"expirationTooltip,omitempty"`
	// If the item expires while playing in an activity, we show a different message.
	ExpiredInActivityMessage string `json:"expiredInActivityMessage,omitempty"`
	// If the item expires in orbit, we show a... more different message. (\"Consummate V's, consummate!\")
	ExpiredInOrbitMessage                    string `json:"expiredInOrbitMessage,omitempty"`
	SuppressExpirationWhenObjectivesComplete bool   `json:"suppressExpirationWhenObjectivesComplete,omitempty"`
	// A reference to the associated crafting 'recipe' item definition, if this item can be crafted.
	RecipeItemHash int32 `json:"recipeItemHash,omitempty"`
}

If this item can exist in an inventory, this block will be non-null. In practice, every item that currently exists has one of these blocks. But note that it is not necessarily guaranteed.

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionMetrics ¶

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionMetrics struct {
	// Hash identifiers for any DestinyPresentationNodeDefinition entry that can be used to list available metrics. Any metric listed directly below these nodes, or in any of these nodes' children will be made available for selection.
	AvailableMetricCategoryNodeHashes []int32 `json:"availableMetricCategoryNodeHashes,omitempty"`
}

If this item has available metrics to be shown, this block will be non-null have the appropriate hashes defined.

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionObjectives ¶

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionObjectives struct {
	// The hashes to Objectives (DestinyObjectiveDefinition) that are part of this Quest Step, in the order that they should be rendered.
	ObjectiveHashes []int32 `json:"objectiveHashes,omitempty"`
	// For every entry in objectiveHashes, there is a corresponding entry in this array at the same index. If the objective is meant to be associated with a specific DestinyActivityDefinition, there will be a valid hash at that index. Otherwise, it will be invalid (0).  Rendered somewhat obsolete by perObjectiveDisplayProperties, which currently has much the same information but may end up with more info in the future.
	DisplayActivityHashes []int32 `json:"displayActivityHashes,omitempty"`
	// If True, all objectives must be completed for the step to be completed. If False, any one objective can be completed for the step to be completed.
	RequireFullObjectiveCompletion bool `json:"requireFullObjectiveCompletion,omitempty"`
	// The hash for the DestinyInventoryItemDefinition representing the Quest to which this Quest Step belongs.
	QuestlineItemHash int32 `json:"questlineItemHash,omitempty"`
	// The localized string for narrative text related to this quest step, if any.
	Narrative string `json:"narrative,omitempty"`
	// The localized string describing an action to be performed associated with the objectives, if any.
	ObjectiveVerbName string `json:"objectiveVerbName,omitempty"`
	// The identifier for the type of quest being performed, if any. Not associated with any fixed definition, yet.
	QuestTypeIdentifier string `json:"questTypeIdentifier,omitempty"`
	// A hashed value for the questTypeIdentifier, because apparently I like to be redundant.
	QuestTypeHash int32 `json:"questTypeHash,omitempty"`
	// One entry per Objective on the item, it will have related display information.
	PerObjectiveDisplayProperties []DestinyDefinitionsDestinyObjectiveDisplayProperties `json:"perObjectiveDisplayProperties,omitempty"`
	DisplayAsStatTracker          bool                                                  `json:"displayAsStatTracker,omitempty"`
}

If this item has Objectives (extra tasks that can be accomplished related to the item... most frequently when the item is a Quest Step and the Objectives need to be completed to move on to the next Quest Step), this block will be non-null and the objectives defined herein.

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionPlug ¶

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionPlug struct {
	// The rules around when this plug can be inserted into a socket, aside from the socket's individual restrictions.  The live data DestinyItemPlugComponent.insertFailIndexes will be an index into this array, so you can pull out the failure strings appropriate for the user.
	InsertionRules []DestinyDefinitionsItemsDestinyPlugRuleDefinition `json:"insertionRules,omitempty"`
	// The string identifier for the plug's category. Use the socket's DestinySocketTypeDefinition.plugWhitelist to determine whether this plug can be inserted into the socket.
	PlugCategoryIdentifier string `json:"plugCategoryIdentifier,omitempty"`
	// The hash for the plugCategoryIdentifier. You can use this instead if you wish: I put both in the definition for debugging purposes.
	PlugCategoryHash int32 `json:"plugCategoryHash,omitempty"`
	// If you successfully socket the item, this will determine whether or not you get \"refunded\" on the plug.
	OnActionRecreateSelf bool `json:"onActionRecreateSelf,omitempty"`
	// If inserting this plug requires materials, this is the hash identifier for looking up the DestinyMaterialRequirementSetDefinition for those requirements.
	InsertionMaterialRequirementHash int32 `json:"insertionMaterialRequirementHash,omitempty"`
	// In the game, if you're inspecting a plug item directly, this will be the item shown with the plug attached. Look up the DestinyInventoryItemDefinition for this hash for the item.
	PreviewItemOverrideHash int32 `json:"previewItemOverrideHash,omitempty"`
	// It's not enough for the plug to be inserted. It has to be enabled as well. For it to be enabled, it may require materials. This is the hash identifier for the DestinyMaterialRequirementSetDefinition for those requirements, if there is one.
	EnabledMaterialRequirementHash int32 `json:"enabledMaterialRequirementHash,omitempty"`
	// The rules around whether the plug, once inserted, is enabled and providing its benefits.  The live data DestinyItemPlugComponent.enableFailIndexes will be an index into this array, so you can pull out the failure strings appropriate for the user.
	EnabledRules []DestinyDefinitionsItemsDestinyPlugRuleDefinition `json:"enabledRules,omitempty"`
	// Plugs can have arbitrary, UI-defined identifiers that the UI designers use to determine the style applied to plugs. Unfortunately, we have neither a definitive list of these labels nor advance warning of when new labels might be applied or how that relates to how they get rendered. If you want to, you can refer to known labels to change your own styles: but know that new ones can be created arbitrarily, and we have no way of associating the labels with any specific UI style guidance... you'll have to piece that together on your end. Or do what we do, and just show plugs more generically, without specialized styles.
	UiPlugLabel string `json:"uiPlugLabel,omitempty"`
	PlugStyle   int32  `json:"plugStyle,omitempty"`
	// Indicates the rules about when this plug can be used. See the PlugAvailabilityMode enumeration for more information!
	PlugAvailability int32 `json:"plugAvailability,omitempty"`
	// If the plug meets certain state requirements, it may have an alternative label applied to it. This is the alternative label that will be applied in such a situation.
	AlternateUiPlugLabel string `json:"alternateUiPlugLabel,omitempty"`
	// The alternate plug of the plug: only applies when the item is in states that only the server can know about and control, unfortunately. See AlternateUiPlugLabel for the related label info.
	AlternatePlugStyle int32 `json:"alternatePlugStyle,omitempty"`
	// If TRUE, this plug is used for UI display purposes only, and doesn't have any interesting effects of its own.
	IsDummyPlug bool `json:"isDummyPlug,omitempty"`
	// Do you ever get the feeling that a system has become so overburdened by edge cases that it probably should have become some other system entirely? So do I!  In totally unrelated news, Plugs can now override properties of their parent items. This is some of the relevant definition data for those overrides.  If this is populated, it will have the override data to be applied when this plug is applied to an item.
	ParentItemOverride *interface{} `json:"parentItemOverride,omitempty"`
	// IF not null, this plug provides Energy capacity to the item in which it is socketed. In Armor 2.0 for example, is implemented in a similar way to Masterworks, where visually it's a single area of the UI being clicked on to \"Upgrade\" to higher energy levels, but it's actually socketing new plugs.
	EnergyCapacity *interface{} `json:"energyCapacity,omitempty"`
	// IF not null, this plug has an energy cost. This contains the details of that cost.
	EnergyCost *interface{} `json:"energyCost,omitempty"`
}

If this item *is* a Plug, this will be non-null and the info defined herein. See DestinyItemPlugDefinition for more information.

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionPreview ¶

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionPreview struct {
	// A string that the game UI uses as a hint for which detail screen to show for the item. You, too, can leverage this for your own custom screen detail views. Note, however, that these are arbitrarily defined by designers: there's no guarantees of a fixed, known number of these - so fall back to something reasonable if you don't recognize it.
	ScreenStyle string `json:"screenStyle,omitempty"`
	// If the preview data is derived from a fake \"Preview\" Vendor, this will be the hash identifier for the DestinyVendorDefinition of that fake vendor.
	PreviewVendorHash int32 `json:"previewVendorHash,omitempty"`
	// If this item should show you Artifact information when you preview it, this is the hash identifier of the DestinyArtifactDefinition for the artifact whose data should be shown.
	ArtifactHash int32 `json:"artifactHash,omitempty"`
	// If the preview has an associated action (like \"Open\"), this will be the localized string for that action.
	PreviewActionString string `json:"previewActionString,omitempty"`
	// This is a list of the items being previewed, categorized in the same way as they are in the preview UI.
	DerivedItemCategories []DestinyDefinitionsItemsDestinyDerivedItemCategoryDefinition `json:"derivedItemCategories,omitempty"`
}

If this item can be Used or Acquired to gain other items (for instance, how Eververse Boxes can be consumed to get items from the box), this block will be non-null and will give summary information for the items that can be acquired.

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionQuality ¶

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionQuality struct {
	// The \"base\" defined level of an item. This is a list because, in theory, each Expansion could define its own base level for an item.  In practice, not only was that never done in Destiny 1, but now this isn't even populated at all. When it's not populated, the level at which it spawns has to be inferred by Reward information, of which BNet receives an imperfect view and will only be reliable on instanced data as a result.
	ItemLevels []int32 `json:"itemLevels,omitempty"`
	// qualityLevel is used in combination with the item's level to calculate stats like Attack and Defense. It plays a role in that calculation, but not nearly as large as itemLevel does.
	QualityLevel int32 `json:"qualityLevel,omitempty"`
	// The string identifier for this item's \"infusability\", if any.   Items that match the same infusionCategoryName are allowed to infuse with each other.  DEPRECATED: Items can now have multiple infusion categories. Please use infusionCategoryHashes instead.
	InfusionCategoryName string `json:"infusionCategoryName,omitempty"`
	// The hash identifier for the infusion. It does not map to a Definition entity.  DEPRECATED: Items can now have multiple infusion categories. Please use infusionCategoryHashes instead.
	InfusionCategoryHash int32 `json:"infusionCategoryHash,omitempty"`
	// If any one of these hashes matches any value in another item's infusionCategoryHashes, the two can infuse with each other.
	InfusionCategoryHashes []int32 `json:"infusionCategoryHashes,omitempty"`
	// An item can refer to pre-set level requirements. They are defined in DestinyProgressionLevelRequirementDefinition, and you can use this hash to find the appropriate definition.
	ProgressionLevelRequirementHash int32 `json:"progressionLevelRequirementHash,omitempty"`
	// The latest version available for this item.
	CurrentVersion int32 `json:"currentVersion,omitempty"`
	// The list of versions available for this item.
	Versions []DestinyDefinitionsDestinyItemVersionDefinition `json:"versions,omitempty"`
	// Icon overlays to denote the item version and power cap status.
	DisplayVersionWatermarkIcons []string `json:"displayVersionWatermarkIcons,omitempty"`
}

If this item can have a level or stats, this block will be non-null and will be populated with default quality (item level, \"quality\", and infusion) data. See the block for more details, there's often less upfront information in D2 so you'll want to be aware of how you use quality and item level on the definition level now.

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionSack ¶

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionSack struct {
	// A description of what will happen when you open the sack. As far as I can tell, this is blank currently. Unknown whether it will eventually be populated with useful info.
	DetailAction string `json:"detailAction,omitempty"`
	// The localized name of the action being performed when you open the sack.
	OpenAction      string `json:"openAction,omitempty"`
	SelectItemCount int32  `json:"selectItemCount,omitempty"`
	VendorSackType  string `json:"vendorSackType,omitempty"`
	OpenOnAcquire   bool   `json:"openOnAcquire,omitempty"`
}

If this item is a \"reward sack\" that can be opened to provide other items, this will be non-null and the properties of the sack contained herein.

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionSetData ¶

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionSetData struct {
	// A collection of hashes of set items, for items such as Quest Metadata items that possess this data.
	ItemList []DestinyDefinitionsDestinyItemSetBlockEntryDefinition `json:"itemList,omitempty"`
	// If true, items in the set can only be added in increasing order, and adding an item will remove any previous item. For Quests, this is by necessity true. Only one quest step is present at a time, and previous steps are removed as you advance in the quest.
	RequireOrderedSetItemAdd bool `json:"requireOrderedSetItemAdd,omitempty"`
	// If true, the UI should treat this quest as \"featured\"
	SetIsFeatured bool `json:"setIsFeatured,omitempty"`
	// A string identifier we can use to attempt to identify the category of the Quest.
	SetType string `json:"setType,omitempty"`
	// The name of the quest line that this quest step is a part of.
	QuestLineName string `json:"questLineName,omitempty"`
	// The description of the quest line that this quest step is a part of.
	QuestLineDescription string `json:"questLineDescription,omitempty"`
	// An additional summary of this step in the quest line.
	QuestStepSummary string `json:"questStepSummary,omitempty"`
}

If this item is a quest, this block will be non-null. In practice, I wish I had called this the Quest block, but at the time it wasn't clear to me whether it would end up being used for purposes other than quests. It will contain data about the steps in the quest, and mechanics we can use for displaying and tracking the quest.

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionSockets ¶

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionSockets struct {
	// This was supposed to be a string that would give per-item details about sockets. In practice, it turns out that all this ever has is the localized word \"details\". ... that's lame, but perhaps it will become something cool in the future.
	Detail string `json:"detail,omitempty"`
	// Each non-intrinsic (or mutable) socket on an item is defined here. Check inside for more info.
	SocketEntries []DestinyDefinitionsDestinyItemSocketEntryDefinition `json:"socketEntries,omitempty"`
	// Each intrinsic (or immutable/permanent) socket on an item is defined here, along with the plug that is permanently affixed to the socket.
	IntrinsicSockets []DestinyDefinitionsDestinyItemIntrinsicSocketEntryDefinition `json:"intrinsicSockets,omitempty"`
	// A convenience property, that refers to the sockets in the \"sockets\" property, pre-grouped by category and ordered in the manner that they should be grouped in the UI. You could form this yourself with the existing data, but why would you want to? Enjoy life man.
	SocketCategories []DestinyDefinitionsDestinyItemSocketCategoryDefinition `json:"socketCategories,omitempty"`
}

If this item has any Sockets, this will be non-null and the individual sockets on the item will be defined herein.

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionSourceData ¶

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionSourceData struct {
	// The list of hash identifiers for Reward Sources that hint where the item can be found (DestinyRewardSourceDefinition).
	SourceHashes []int32 `json:"sourceHashes,omitempty"`
	// A collection of details about the stats that were computed for the ways we found that the item could be spawned.
	Sources []DestinyDefinitionsSourcesDestinyItemSourceDefinition `json:"sources,omitempty"`
	// If we found that this item is exclusive to a specific platform, this will be set to the BungieMembershipType enumeration that matches that platform.
	Exclusive int32 `json:"exclusive,omitempty"`
	// A denormalized reference back to vendors that potentially sell this item.
	VendorSources []DestinyDefinitionsDestinyItemVendorSourceReference `json:"vendorSources,omitempty"`
}

If this item has a known source, this block will be non-null and populated with source information. Unfortunately, at this time we are not generating sources: that is some aggressively manual work which we didn't have time for, and I'm hoping to get back to at some point in the future.

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionStats ¶

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionStats struct {
	// If true, the game won't show the \"primary\" stat on this item when you inspect it.  NOTE: This is being manually mapped, because I happen to want it in a block that isn't going to directly create this derivative block.
	DisablePrimaryStatDisplay bool `json:"disablePrimaryStatDisplay,omitempty"`
	// If the item's stats are meant to be modified by a DestinyStatGroupDefinition, this will be the identifier for that definition.  If you are using live data or precomputed stats data on the DestinyInventoryItemDefinition.stats.stats property, you don't have to worry about statGroupHash and how it alters stats: the already altered stats are provided to you. But if you want to see how the sausage gets made, or perform computations yourself, this is valuable information.
	StatGroupHash int32 `json:"statGroupHash,omitempty"`
	// If you are looking for precomputed values for the stats on a weapon, this is where they are stored. Technically these are the \"Display\" stat values. Please see DestinyStatsDefinition for what Display Stat Values means, it's a very long story... but essentially these are the closest values BNet can get to the item stats that you see in-game.  These stats are keyed by the DestinyStatDefinition's hash identifier for the stat that's found on the item.
	Stats map[string]DestinyDefinitionsDestinyInventoryItemStatDefinition `json:"stats,omitempty"`
	// A quick and lazy way to determine whether any stat other than the \"primary\" stat is actually visible on the item. Items often have stats that we return in case people find them useful, but they're not part of the \"Stat Group\" and thus we wouldn't display them in our UI. If this is False, then we're not going to display any of these stats other than the primary one.
	HasDisplayableStats bool `json:"hasDisplayableStats,omitempty"`
	// This stat is determined to be the \"primary\" stat, and can be looked up in the stats or any other stat collection related to the item.  Use this hash to look up the stat's value using DestinyInventoryItemDefinition.stats.stats, and the renderable data for the primary stat in the related DestinyStatDefinition.
	PrimaryBaseStatHash int32 `json:"primaryBaseStatHash,omitempty"`
}

If this item can have stats (such as a weapon, armor, or vehicle), this block will be non-null and populated with the stats found on the item.

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionSummary ¶

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionSummary struct {
	// Apparently when rendering an item in a reward, this should be used as a sort priority. We're not doing it presently.
	SortPriority int32 `json:"sortPriority,omitempty"`
}

Summary data about the item.

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionTalentGrid ¶

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionTalentGrid struct {
	// The hash identifier of the DestinyTalentGridDefinition attached to this item.
	TalentGridHash int32 `json:"talentGridHash,omitempty"`
	// This is meant to be a subtitle for looking at the talent grid. In practice, somewhat frustratingly, this always merely says the localized word for \"Details\". Great. Maybe it'll have more if talent grids ever get used for more than builds and subclasses again.
	ItemDetailString string `json:"itemDetailString,omitempty"`
	// A shortcut string identifier for the \"build\" in question, if this talent grid has an associated build. Doesn't map to anything we can expose at the moment.
	BuildName string `json:"buildName,omitempty"`
	// If the talent grid implies a damage type, this is the enum value for that damage type.
	HudDamageType int32 `json:"hudDamageType,omitempty"`
	// If the talent grid has a special icon that's shown in the game UI (like builds, funny that), this is the identifier for that icon. Sadly, we don't actually get that icon right now. I'll be looking to replace this with a path to the actual icon itself.
	HudIcon string `json:"hudIcon,omitempty"`
}

If the item has a Talent Grid, this will be non-null and the properties of the grid defined herein. Note that, while many items still have talent grids, the only ones with meaningful Nodes still on them will be Subclass/\"Build\" items.

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionTranslationBlock ¶

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionTranslationBlock struct {
	WeaponPatternIdentifier string                                                 `json:"weaponPatternIdentifier,omitempty"`
	WeaponPatternHash       int32                                                  `json:"weaponPatternHash,omitempty"`
	DefaultDyes             []DestinyDyeReference                                  `json:"defaultDyes,omitempty"`
	LockedDyes              []DestinyDyeReference                                  `json:"lockedDyes,omitempty"`
	CustomDyes              []DestinyDyeReference                                  `json:"customDyes,omitempty"`
	Arrangements            []DestinyDefinitionsDestinyGearArtArrangementReference `json:"arrangements,omitempty"`
	HasGeometry             bool                                                   `json:"hasGeometry,omitempty"`
}

If this item can be rendered, this block will be non-null and will be populated with rendering information.

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionValue ¶

type AllOfDestinyDefinitionsDestinyInventoryItemDefinitionValue struct {
	// References to the items that make up this item's \"value\", and the quantity.
	ItemValue []DestinyDestinyItemQuantity `json:"itemValue,omitempty"`
	// If there's a localized text description of the value provided, this will be said description.
	ValueDescription string `json:"valueDescription,omitempty"`
}

The conceptual \"Value\" of an item, if any was defined. See the DestinyItemValueBlockDefinition for more details.

type AllOfDestinyDefinitionsDestinyLocationReleaseDefinitionDisplayProperties ¶

type AllOfDestinyDefinitionsDestinyLocationReleaseDefinitionDisplayProperties struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

Sadly, these don't appear to be populated anymore (ever?)

type AllOfDestinyDefinitionsDestinyNodeStepDefinitionActivationRequirement ¶

type AllOfDestinyDefinitionsDestinyNodeStepDefinitionActivationRequirement struct {
	// The Progression level on the Talent Grid required to activate this node.  See DestinyTalentGridDefinition.progressionHash for the related Progression, and read DestinyProgressionDefinition's documentation to learn more about Progressions.
	GridLevel int32 `json:"gridLevel,omitempty"`
	// The list of hash identifiers for material requirement sets: materials that are required for the node to be activated. See DestinyMaterialRequirementSetDefinition for more information about material requirements.  In this case, only a single DestinyMaterialRequirementSetDefinition will be chosen from this list, and we won't know which one will be chosen until an instance of the item is created.
	MaterialRequirementHashes []int32 `json:"materialRequirementHashes,omitempty"`
}

If the step has requirements for activation (they almost always do, if nothing else than for the Talent Grid's Progression to have reached a certain level), they will be defined here.

type AllOfDestinyDefinitionsDestinyNodeStepDefinitionDisplayProperties ¶

type AllOfDestinyDefinitionsDestinyNodeStepDefinitionDisplayProperties struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

These are the display properties actually used to render the Talent Node. The currently active step's displayProperties are shown.

type AllOfDestinyDefinitionsDestinyNodeStepDefinitionStepGroups ¶

type AllOfDestinyDefinitionsDestinyNodeStepDefinitionStepGroups struct {
	WeaponPerformance  int32 `json:"weaponPerformance,omitempty"`
	ImpactEffects      int32 `json:"impactEffects,omitempty"`
	GuardianAttributes int32 `json:"guardianAttributes,omitempty"`
	LightAbilities     int32 `json:"lightAbilities,omitempty"`
	DamageTypes        int32 `json:"damageTypes,omitempty"`
}

In Destiny 1, the Armory's Perk Filtering was driven by a concept of TalentNodeStepGroups: categorizations of talent nodes based on their functionality. While the Armory isn't a BNet-facing thing for now, and the new Armory will need to account for Sockets rather than Talent Nodes, this categorization capability feels useful enough to still keep around.

type AllOfDestinyDefinitionsDestinyObjectiveDefinitionDisplayProperties ¶

type AllOfDestinyDefinitionsDestinyObjectiveDefinitionDisplayProperties struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

Ideally, this should tell you what your task is. I'm not going to lie to you though. Sometimes this doesn't have useful information at all. Which sucks, but there's nothing either of us can do about it.

type AllOfDestinyDefinitionsDestinyObjectiveDefinitionPerks ¶

type AllOfDestinyDefinitionsDestinyObjectiveDefinitionPerks struct {
	// The hash identifier of the DestinySandboxPerkDefinition that will be applied to the character.
	PerkHash int32 `json:"perkHash,omitempty"`
	// An enumeration indicating whether it will be applied as long as the Objective is active, when it's completed, or until it's completed.
	Style int32 `json:"style,omitempty"`
}

If this objective enables Perks intrinsically, the conditions for that enabling are defined here.

type AllOfDestinyDefinitionsDestinyObjectiveDefinitionStats ¶

type AllOfDestinyDefinitionsDestinyObjectiveDefinitionStats struct {
	// The stat being modified, and the value used.
	Stat *interface{} `json:"stat,omitempty"`
	// Whether it will be applied as long as the objective is active, when it's completed, or until it's completed.
	Style int32 `json:"style,omitempty"`
}

If this objective enables modifications on a player's stats intrinsically, the conditions are defined here.

type AllOfDestinyDefinitionsDestinyObjectiveStatEntryDefinitionStat ¶

type AllOfDestinyDefinitionsDestinyObjectiveStatEntryDefinitionStat struct {
	// The hash identifier for the DestinyStatDefinition defining this stat.
	StatTypeHash int32 `json:"statTypeHash,omitempty"`
	// The raw \"Investment\" value for the stat, before transformations are performed to turn this raw stat into stats that are displayed in the game UI.
	Value int32 `json:"value,omitempty"`
	// If this is true, the stat will only be applied on the item in certain game state conditions, and we can't know statically whether or not this stat will be applied. Check the \"live\" API data instead for whether this value is being applied on a specific instance of the item in question, and you can use this to decide whether you want to show the stat on the generic view of the item, or whether you want to show some kind of caveat or warning about the stat value being conditional on game state.
	IsConditionallyActive bool `json:"isConditionallyActive,omitempty"`
}

The stat being modified, and the value used.

type AllOfDestinyDefinitionsDestinyProgressionDefinitionColor ¶

type AllOfDestinyDefinitionsDestinyProgressionDefinitionColor struct {
	Red   string `json:"red,omitempty"`
	Green string `json:"green,omitempty"`
	Blue  string `json:"blue,omitempty"`
	Alpha string `json:"alpha,omitempty"`
}

The #RGB string value for the color related to this progression, if there is one.

type AllOfDestinyDefinitionsDestinyProgressionMappingDefinitionDisplayProperties ¶

type AllOfDestinyDefinitionsDestinyProgressionMappingDefinitionDisplayProperties struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

Infrequently defined in practice. Defer to the individual progressions' display properties.

type AllOfDestinyDefinitionsDestinySandboxPerkDefinitionDisplayProperties ¶

type AllOfDestinyDefinitionsDestinySandboxPerkDefinitionDisplayProperties struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

These display properties are by no means guaranteed to be populated. Usually when it is, it's only because we back-filled them with the displayProperties of some Talent Node or Plug item that happened to be uniquely providing that perk.

type AllOfDestinyDefinitionsDestinySandboxPerkDefinitionPerkGroups ¶

type AllOfDestinyDefinitionsDestinySandboxPerkDefinitionPerkGroups struct {
	WeaponPerformance  int32 `json:"weaponPerformance,omitempty"`
	ImpactEffects      int32 `json:"impactEffects,omitempty"`
	GuardianAttributes int32 `json:"guardianAttributes,omitempty"`
	LightAbilities     int32 `json:"lightAbilities,omitempty"`
	DamageTypes        int32 `json:"damageTypes,omitempty"`
}

An old holdover from the original Armory, this was an attempt to group perks by functionality. It is as yet unpopulated, and there will be quite a bit of work needed to restore it to its former working order.

type AllOfDestinyDefinitionsDestinyStatOverrideDefinitionDisplayProperties ¶

type AllOfDestinyDefinitionsDestinyStatOverrideDefinitionDisplayProperties struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

The display properties to show instead of the base DestinyStatDefinition display properties.

type AllOfDestinyDefinitionsDestinyTalentNodeCategoryDisplayProperties ¶

type AllOfDestinyDefinitionsDestinyTalentNodeCategoryDisplayProperties struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

Will contain at least the \"name\", which will be the title of the category. We will likely not have description and an icon yet, but I'm going to keep my options open.

type AllOfDestinyDefinitionsDestinyTalentNodeDefinitionRandomActivationRequirement ¶

type AllOfDestinyDefinitionsDestinyTalentNodeDefinitionRandomActivationRequirement struct {
	// The Progression level on the Talent Grid required to activate this node.  See DestinyTalentGridDefinition.progressionHash for the related Progression, and read DestinyProgressionDefinition's documentation to learn more about Progressions.
	GridLevel int32 `json:"gridLevel,omitempty"`
	// The list of hash identifiers for material requirement sets: materials that are required for the node to be activated. See DestinyMaterialRequirementSetDefinition for more information about material requirements.  In this case, only a single DestinyMaterialRequirementSetDefinition will be chosen from this list, and we won't know which one will be chosen until an instance of the item is created.
	MaterialRequirementHashes []int32 `json:"materialRequirementHashes,omitempty"`
}

At one point, you were going to be able to repurchase talent nodes that had random steps, to \"re-roll\" the current step of the node (and thus change the properties of your item). This was to be the activation requirement for performing that re-roll. The system still exists to do this, as far as I know, so it may yet come back around!

type AllOfDestinyDefinitionsDestinyUnlockDefinitionDisplayProperties ¶

type AllOfDestinyDefinitionsDestinyUnlockDefinitionDisplayProperties struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

Sometimes, but not frequently, these unlock flags also have human readable information: usually when they are being directly tested for some requirement, in which case the string is a localized description of why the requirement check failed.

type AllOfDestinyDefinitionsDestinyVendorCategoryEntryDefinitionOverlay ¶

type AllOfDestinyDefinitionsDestinyVendorCategoryEntryDefinitionOverlay struct {
	ChoiceDescription string `json:"choiceDescription,omitempty"`
	Description       string `json:"description,omitempty"`
	Icon              string `json:"icon,omitempty"`
	Title             string `json:"title,omitempty"`
	// If this overlay has a currency item that it features, this is said featured item.
	CurrencyItemHash int32 `json:"currencyItemHash,omitempty"`
}

If this category has an overlay prompt that should appear, this contains the details of that prompt.

type AllOfDestinyDefinitionsDestinyVendorInteractionDefinitionHeaderDisplayProperties ¶

type AllOfDestinyDefinitionsDestinyVendorInteractionDefinitionHeaderDisplayProperties struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

The header for the interaction dialog.

type AllOfDestinyDefinitionsDestinyVendorInventoryFlyoutDefinitionDisplayProperties ¶

type AllOfDestinyDefinitionsDestinyVendorInventoryFlyoutDefinitionDisplayProperties struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

The title and other common properties of the flyout.

type AllOfDestinyDefinitionsDestinyVendorItemDefinitionAction ¶

type AllOfDestinyDefinitionsDestinyVendorItemDefinitionAction struct {
	ExecuteSeconds float32 `json:"executeSeconds,omitempty"`
	IsPositive     bool    `json:"isPositive,omitempty"`
}

The action to be performed when purchasing the item, if it's not just \"buy\".

type AllOfDestinyDefinitionsDirectorDestinyActivityGraphArtElementDefinitionPosition ¶

type AllOfDestinyDefinitionsDirectorDestinyActivityGraphArtElementDefinitionPosition struct {
	X int32 `json:"x,omitempty"`
	Y int32 `json:"y,omitempty"`
	Z int32 `json:"z,omitempty"`
}

The position on the map of the art element.

type AllOfDestinyDefinitionsDirectorDestinyActivityGraphNodeDefinitionOverrideDisplay ¶

type AllOfDestinyDefinitionsDirectorDestinyActivityGraphNodeDefinitionOverrideDisplay struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

The node *may* have display properties that override the active Activity's display properties.

type AllOfDestinyDefinitionsDirectorDestinyActivityGraphNodeDefinitionPosition ¶

type AllOfDestinyDefinitionsDirectorDestinyActivityGraphNodeDefinitionPosition struct {
	X int32 `json:"x,omitempty"`
	Y int32 `json:"y,omitempty"`
	Z int32 `json:"z,omitempty"`
}

The position on the map for this node.

type AllOfDestinyDefinitionsEnergyTypesDestinyEnergyTypeDefinitionDisplayProperties ¶

type AllOfDestinyDefinitionsEnergyTypesDestinyEnergyTypeDefinitionDisplayProperties struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

The description of the energy type, icon etc...

type AllOfDestinyDefinitionsItemsDestinyItemPlugDefinitionEnergyCapacity ¶

type AllOfDestinyDefinitionsItemsDestinyItemPlugDefinitionEnergyCapacity struct {
	// How much energy capacity this plug provides.
	CapacityValue int32 `json:"capacityValue,omitempty"`
	// Energy provided by a plug is always of a specific type - this is the hash identifier for the energy type for which it provides Capacity.
	EnergyTypeHash int32 `json:"energyTypeHash,omitempty"`
	// The Energy Type for this energy capacity, in enum form for easy use.
	EnergyType int32 `json:"energyType,omitempty"`
}

IF not null, this plug provides Energy capacity to the item in which it is socketed. In Armor 2.0 for example, is implemented in a similar way to Masterworks, where visually it's a single area of the UI being clicked on to \"Upgrade\" to higher energy levels, but it's actually socketing new plugs.

type AllOfDestinyDefinitionsItemsDestinyItemPlugDefinitionEnergyCost ¶

type AllOfDestinyDefinitionsItemsDestinyItemPlugDefinitionEnergyCost struct {
	// The Energy cost for inserting this plug.
	EnergyCost int32 `json:"energyCost,omitempty"`
	// The type of energy that this plug costs, as a reference to the DestinyEnergyTypeDefinition of the energy type.
	EnergyTypeHash int32 `json:"energyTypeHash,omitempty"`
	// The type of energy that this plug costs, in enum form.
	EnergyType int32 `json:"energyType,omitempty"`
}

IF not null, this plug has an energy cost. This contains the details of that cost.

type AllOfDestinyDefinitionsItemsDestinyItemPlugDefinitionParentItemOverride ¶

type AllOfDestinyDefinitionsItemsDestinyItemPlugDefinitionParentItemOverride struct {
	AdditionalEquipRequirementsDisplayStrings []string `json:"additionalEquipRequirementsDisplayStrings,omitempty"`
	PipIcon                                   string   `json:"pipIcon,omitempty"`
}

Do you ever get the feeling that a system has become so overburdened by edge cases that it probably should have become some other system entirely? So do I! In totally unrelated news, Plugs can now override properties of their parent items. This is some of the relevant definition data for those overrides. If this is populated, it will have the override data to be applied when this plug is applied to an item.

type AllOfDestinyDefinitionsItemsDestinyItemTierTypeDefinitionInfusionProcess ¶

type AllOfDestinyDefinitionsItemsDestinyItemTierTypeDefinitionInfusionProcess struct {
	// The default portion of quality that will transfer from the infuser to the infusee item. (InfuserQuality - InfuseeQuality) * baseQualityTransferRatio = base quality transferred.
	BaseQualityTransferRatio float32 `json:"baseQualityTransferRatio,omitempty"`
	// As long as InfuserQuality > InfuseeQuality, the amount of quality bestowed is guaranteed to be at least this value, even if the transferRatio would dictate that it should be less. The total amount of quality that ends up in the Infusee cannot exceed the Infuser's quality however (for instance, if you infuse a 300 item with a 301 item and the minimum quality increment is 10, the infused item will not end up with 310 quality)
	MinimumQualityIncrement int32 `json:"minimumQualityIncrement,omitempty"`
}

If this tier defines infusion properties, they will be contained here.

type AllOfDestinyDefinitionsMilestonesDestinyMilestoneQuestDefinitionDisplayProperties ¶

type AllOfDestinyDefinitionsMilestonesDestinyMilestoneQuestDefinitionDisplayProperties struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

The individual quests may have different definitions from the overall milestone: if there's a specific active quest, use these displayProperties instead of that of the overall DestinyMilestoneDefinition.

type AllOfDestinyDefinitionsMilestonesDestinyMilestoneQuestDefinitionQuestRewards ¶

type AllOfDestinyDefinitionsMilestonesDestinyMilestoneQuestDefinitionQuestRewards struct {
	// The items that represent your reward for completing the quest.  Be warned, these could be \"dummy\" items: items that are only used to render a good-looking in-game tooltip, but aren't the actual items themselves.  For instance, when experience is given there's often a dummy item representing \"experience\", with quantity being the amount of experience you got. We don't have a programmatic association between those and whatever Progression is actually getting that experience... yet.
	Items []DestinyDefinitionsMilestonesDestinyMilestoneQuestRewardItem `json:"items,omitempty"`
}

The rewards you will get for completing this quest, as best as we could extract them from our data. Sometimes, it'll be a decent amount of data. Sometimes, it's going to be sucky. Sorry.

type AllOfDestinyDefinitionsMilestonesDestinyMilestoneRewardCategoryDefinitionDisplayProperties ¶

type AllOfDestinyDefinitionsMilestonesDestinyMilestoneRewardCategoryDefinitionDisplayProperties struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

Hopefully this is obvious by now.

type AllOfDestinyDefinitionsMilestonesDestinyMilestoneRewardEntryDefinitionDisplayProperties ¶

type AllOfDestinyDefinitionsMilestonesDestinyMilestoneRewardEntryDefinitionDisplayProperties struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

For us to bother returning this info, we should be able to return some kind of information about why these rewards are grouped together. This is ideally that information. Look at how confident I am that this will always remain true.

type AllOfDestinyDefinitionsPresentationDestinyPresentationNodeDefinitionChildren ¶

type AllOfDestinyDefinitionsPresentationDestinyPresentationNodeDefinitionChildren struct {
	PresentationNodes []DestinyDefinitionsPresentationDestinyPresentationNodeChildEntry            `json:"presentationNodes,omitempty"`
	Collectibles      []DestinyDefinitionsPresentationDestinyPresentationNodeCollectibleChildEntry `json:"collectibles,omitempty"`
	Records           []DestinyDefinitionsPresentationDestinyPresentationNodeRecordChildEntry      `json:"records,omitempty"`
	Metrics           []DestinyDefinitionsPresentationDestinyPresentationNodeMetricChildEntry      `json:"metrics,omitempty"`
	Craftables        []DestinyDefinitionsPresentationDestinyPresentationNodeCraftableChildEntry   `json:"craftables,omitempty"`
}

The child entities contained by this presentation node.

type AllOfDestinyDefinitionsPresentationDestinyPresentationNodeDefinitionRequirements ¶

type AllOfDestinyDefinitionsPresentationDestinyPresentationNodeDefinitionRequirements struct {
	// If this node is not accessible due to Entitlements (for instance, you don't own the required game expansion), this is the message to show.
	EntitlementUnavailableMessage string `json:"entitlementUnavailableMessage,omitempty"`
}

The requirements for being able to interact with this presentation node and its children.

type AllOfDestinyDefinitionsRecordsDestinyRecordDefinitionIntervalInfo ¶

type AllOfDestinyDefinitionsRecordsDestinyRecordDefinitionIntervalInfo struct {
	IntervalObjectives                   []DestinyDefinitionsRecordsDestinyRecordIntervalObjective `json:"intervalObjectives,omitempty"`
	IntervalRewards                      []DestinyDefinitionsRecordsDestinyRecordIntervalRewards   `json:"intervalRewards,omitempty"`
	OriginalObjectiveArrayInsertionIndex int32                                                     `json:"originalObjectiveArrayInsertionIndex,omitempty"`
}

Some records have multiple 'interval' objectives, and the record may be claimed at each completed interval

type AllOfDestinyDefinitionsSeasonsDestinySeasonDefinitionPreview ¶

type AllOfDestinyDefinitionsSeasonsDestinySeasonDefinitionPreview struct {
	// A localized description of the season.
	Description string `json:"description,omitempty"`
	// 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.
	LinkPath string `json:"linkPath,omitempty"`
	// An optional link to a localized video, probably YouTube.
	VideoLink string `json:"videoLink,omitempty"`
	// A list of images to preview the seasonal content. Should have at least three to show.
	Images []DestinyDefinitionsSeasonsDestinySeasonPreviewImageDefinition `json:"images,omitempty"`
}

Optional - Defines the promotional text, images, and links to preview this season.

type AllOfDestinyDefinitionsSocialDestinySocialCommendationNodeDefinitionColor ¶

type AllOfDestinyDefinitionsSocialDestinySocialCommendationNodeDefinitionColor struct {
	Red   string `json:"red,omitempty"`
	Green string `json:"green,omitempty"`
	Blue  string `json:"blue,omitempty"`
	Alpha string `json:"alpha,omitempty"`
}

The color associated with this group of commendations.

type AllOfDestinyDefinitionsSocketsDestinyPlugSetDefinitionDisplayProperties ¶

type AllOfDestinyDefinitionsSocketsDestinyPlugSetDefinitionDisplayProperties struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

If you want to show these plugs in isolation, these are the display properties for them.

type AllOfDestinyDefinitionsSocketsDestinySocketTypeDefinitionDisplayProperties ¶

type AllOfDestinyDefinitionsSocketsDestinySocketTypeDefinitionDisplayProperties struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

There are fields for this display data, but they appear to be unpopulated as of now. I am not sure where in the UI these would show if they even were populated, but I will continue to return this data in case it becomes useful.

type AllOfDestinyDefinitionsSocketsDestinySocketTypeDefinitionInsertAction ¶

type AllOfDestinyDefinitionsSocketsDestinySocketTypeDefinitionInsertAction struct {
	// How long it takes for the Plugging of the item to be completed once it is initiated, if you care.
	ActionExecuteSeconds int32 `json:"actionExecuteSeconds,omitempty"`
	// The type of action being performed when you act on this Socket Type. The most common value is \"insert plug\", but there are others as well (for instance, a \"Masterwork\" socket may allow for Re-initialization, and an Infusion socket allows for items to be consumed to upgrade the item)
	ActionType int32 `json:"actionType,omitempty"`
}

Defines what happens when a plug is inserted into sockets of this type.

type AllOfDestinyDestinyTalentNodeNodeStatsBlock ¶

type AllOfDestinyDestinyTalentNodeNodeStatsBlock struct {
	// The stat benefits conferred when this talent node is activated for the current Step that is active on the node.
	CurrentStepStats []DestinyDestinyStat `json:"currentStepStats,omitempty"`
	// This is a holdover from the old days of Destiny 1, when a node could be activated multiple times, conferring multiple steps worth of benefits: you would use this property to show what activating the \"next\" step on the node would provide vs. what the current step is providing. While Nodes are currently not being used this way, the underlying system for this functionality still exists. I hesitate to remove this property while the ability for designers to make such a talent grid still exists. Whether you want to show it is up to you.
	NextStepStats []DestinyDestinyStat `json:"nextStepStats,omitempty"`
}

This property has some history. A talent grid can provide stats on both the item it's related to and the character equipping the item. This returns data about those stat bonuses.

type AllOfDestinyEntitiesCharactersDestinyCharacterComponentEmblemColor ¶

type AllOfDestinyEntitiesCharactersDestinyCharacterComponentEmblemColor struct {
	Red   string `json:"red,omitempty"`
	Green string `json:"green,omitempty"`
	Blue  string `json:"blue,omitempty"`
	Alpha string `json:"alpha,omitempty"`
}

A shortcut for getting the background color of the user's currently equipped emblem without having to do a DestinyInventoryItemDefinition lookup.

type AllOfDestinyEntitiesCharactersDestinyCharacterComponentLevelProgression ¶

type AllOfDestinyEntitiesCharactersDestinyCharacterComponentLevelProgression struct {
	// The hash identifier of the Progression in question. Use it to look up the DestinyProgressionDefinition in static data.
	ProgressionHash int32 `json:"progressionHash,omitempty"`
	// The amount of progress earned today for this progression.
	DailyProgress int32 `json:"dailyProgress,omitempty"`
	// If this progression has a daily limit, this is that limit.
	DailyLimit int32 `json:"dailyLimit,omitempty"`
	// The amount of progress earned toward this progression in the current week.
	WeeklyProgress int32 `json:"weeklyProgress,omitempty"`
	// If this progression has a weekly limit, this is that limit.
	WeeklyLimit int32 `json:"weeklyLimit,omitempty"`
	// This is the total amount of progress obtained overall for this progression (for instance, the total amount of Character Level experience earned)
	CurrentProgress int32 `json:"currentProgress,omitempty"`
	// This is the level of the progression (for instance, the Character Level).
	Level int32 `json:"level,omitempty"`
	// This is the maximum possible level you can achieve for this progression (for example, the maximum character level obtainable)
	LevelCap int32 `json:"levelCap,omitempty"`
	// Progressions define their levels in \"steps\". Since the last step may be repeatable, the user may be at a higher level than the actual Step achieved in the progression. Not necessarily useful, but potentially interesting for those cruising the API. Relate this to the \"steps\" property of the DestinyProgression to see which step the user is on, if you care about that. (Note that this is Content Version dependent since it refers to indexes.)
	StepIndex int32 `json:"stepIndex,omitempty"`
	// The amount of progression (i.e. \"Experience\") needed to reach the next level of this Progression. Jeez, progression is such an overloaded word.
	ProgressToNextLevel int32 `json:"progressToNextLevel,omitempty"`
	// The total amount of progression (i.e. \"Experience\") needed in order to reach the next level.
	NextLevelAt int32 `json:"nextLevelAt,omitempty"`
	// The number of resets of this progression you've executed this season, if applicable to this progression.
	CurrentResetCount int32 `json:"currentResetCount,omitempty"`
	// Information about historical resets of this progression, if there is any data for it.
	SeasonResets []DestinyDestinyProgressionResetEntry `json:"seasonResets,omitempty"`
	// Information about historical rewards for this progression, if there is any data for it.
	RewardItemStates []int32 `json:"rewardItemStates,omitempty"`
}

The progression that indicates your character's level. Not their light level, but their character level: you know, the thing you max out a couple hours in and then ignore for the sake of light level.

type AllOfDestinyEntitiesCharactersDestinyCharacterProgressionComponentSeasonalArtifact ¶

type AllOfDestinyEntitiesCharactersDestinyCharacterProgressionComponentSeasonalArtifact struct {
	ArtifactHash int32                                 `json:"artifactHash,omitempty"`
	PointsUsed   int32                                 `json:"pointsUsed,omitempty"`
	ResetCount   int32                                 `json:"resetCount,omitempty"`
	Tiers        []DestinyArtifactsDestinyArtifactTier `json:"tiers,omitempty"`
}

Data related to your progress on the current season's artifact that can vary per character.

type AllOfDestinyEntitiesCharactersDestinyCharacterRenderComponentCustomization ¶

type AllOfDestinyEntitiesCharactersDestinyCharacterRenderComponentCustomization struct {
	Personality   int32   `json:"personality,omitempty"`
	Face          int32   `json:"face,omitempty"`
	SkinColor     int32   `json:"skinColor,omitempty"`
	LipColor      int32   `json:"lipColor,omitempty"`
	EyeColor      int32   `json:"eyeColor,omitempty"`
	HairColors    []int32 `json:"hairColors,omitempty"`
	FeatureColors []int32 `json:"featureColors,omitempty"`
	DecalColor    int32   `json:"decalColor,omitempty"`
	WearHelmet    bool    `json:"wearHelmet,omitempty"`
	HairIndex     int32   `json:"hairIndex,omitempty"`
	FeatureIndex  int32   `json:"featureIndex,omitempty"`
	DecalIndex    int32   `json:"decalIndex,omitempty"`
}

This is actually something that Spasm.js *doesn't* do right now, and that we don't return assets for yet. This is the data about what character customization options you picked. You can combine this with DestinyCharacterCustomizationOptionDefinition to show some cool info, and hopefully someday to actually render a user's face in 3D. We'll see if we ever end up with time for that.

type AllOfDestinyEntitiesCharactersDestinyCharacterRenderComponentPeerView ¶

type AllOfDestinyEntitiesCharactersDestinyCharacterRenderComponentPeerView struct {
	Equipment []DestinyCharacterDestinyItemPeerView `json:"equipment,omitempty"`
}

A minimal view of: - Equipped items - The rendering-related custom options on those equipped items Combined, that should be enough to render all of the items on the equipped character.

type AllOfDestinyEntitiesItemsDestinyItemComponentMetricObjective ¶

type AllOfDestinyEntitiesItemsDestinyItemComponentMetricObjective struct {
	// The unique identifier of the Objective being referred to. Use to look up the DestinyObjectiveDefinition in static data.
	ObjectiveHash int32 `json:"objectiveHash,omitempty"`
	// If the Objective has a Destination associated with it, this is the unique identifier of the Destination being referred to. Use to look up the DestinyDestinationDefinition in static data. This will give localized data about *where* in the universe the objective should be achieved.
	DestinationHash int32 `json:"destinationHash,omitempty"`
	// If the Objective has an Activity associated with it, this is the unique identifier of the Activity being referred to. Use to look up the DestinyActivityDefinition in static data. This will give localized data about *what* you should be playing for the objective to be achieved.
	ActivityHash int32 `json:"activityHash,omitempty"`
	// If progress has been made, and the progress can be measured numerically, this will be the value of that progress. You can compare it to the DestinyObjectiveDefinition.completionValue property for current vs. upper bounds, and use DestinyObjectiveDefinition.inProgressValueStyle or completedValueStyle to determine how this should be rendered. Note that progress, in Destiny 2, need not be a literal numeric progression. It could be one of a number of possible values, even a Timestamp. Always examine DestinyObjectiveDefinition.inProgressValueStyle or completedValueStyle before rendering progress.
	Progress int32 `json:"progress,omitempty"`
	// As of Forsaken, objectives' completion value is determined dynamically at runtime.  This value represents the threshold of progress you need to surpass in order for this objective to be considered \"complete\".  If you were using objective data, switch from using the DestinyObjectiveDefinition's \"completionValue\" to this value.
	CompletionValue int32 `json:"completionValue,omitempty"`
	// Whether or not the Objective is completed.
	Complete bool `json:"complete,omitempty"`
	// If this is true, the objective is visible in-game. Otherwise, it's not yet visible to the player. Up to you if you want to honor this property.
	Visible bool `json:"visible,omitempty"`
}

The objective progress for the currently-selected metric definition, to be displayed on the emblem nameplate.

type AllOfDestinyEntitiesItemsDestinyItemInstanceComponentEnergy ¶

type AllOfDestinyEntitiesItemsDestinyItemInstanceComponentEnergy struct {
	// The type of energy for this item. Plugs that require Energy can only be inserted if they have the \"Any\" Energy Type or the matching energy type of this item. This is a reference to the DestinyEnergyTypeDefinition for the energy type, where you can find extended info about it.
	EnergyTypeHash int32 `json:"energyTypeHash,omitempty"`
	// This is the enum version of the Energy Type value, for convenience.
	EnergyType int32 `json:"energyType,omitempty"`
	// The total capacity of Energy that the item currently has, regardless of if it is currently being used.
	EnergyCapacity int32 `json:"energyCapacity,omitempty"`
	// The amount of Energy currently in use by inserted plugs.
	EnergyUsed int32 `json:"energyUsed,omitempty"`
	// The amount of energy still available for inserting new plugs.
	EnergyUnused int32 `json:"energyUnused,omitempty"`
}

IF populated, this item supports Energy mechanics (i.e. Armor 2.0), and these are the current details of its energy type and available capacity to spend energy points.

type AllOfDestinyEntitiesItemsDestinyItemInstanceComponentPrimaryStat ¶

type AllOfDestinyEntitiesItemsDestinyItemInstanceComponentPrimaryStat struct {
	// The hash identifier for the Stat. Use it to look up the DestinyStatDefinition for static data about the stat.
	StatHash int32 `json:"statHash,omitempty"`
	// The current value of the Stat.
	Value int32 `json:"value,omitempty"`
}

The item stat that we consider to be \"primary\" for the item. For instance, this would be \"Attack\" for Weapons or \"Defense\" for armor.

type AllOfDestinyEntitiesItemsDestinyItemObjectivesComponentFlavorObjective ¶

type AllOfDestinyEntitiesItemsDestinyItemObjectivesComponentFlavorObjective struct {
	// The unique identifier of the Objective being referred to. Use to look up the DestinyObjectiveDefinition in static data.
	ObjectiveHash int32 `json:"objectiveHash,omitempty"`
	// If the Objective has a Destination associated with it, this is the unique identifier of the Destination being referred to. Use to look up the DestinyDestinationDefinition in static data. This will give localized data about *where* in the universe the objective should be achieved.
	DestinationHash int32 `json:"destinationHash,omitempty"`
	// If the Objective has an Activity associated with it, this is the unique identifier of the Activity being referred to. Use to look up the DestinyActivityDefinition in static data. This will give localized data about *what* you should be playing for the objective to be achieved.
	ActivityHash int32 `json:"activityHash,omitempty"`
	// If progress has been made, and the progress can be measured numerically, this will be the value of that progress. You can compare it to the DestinyObjectiveDefinition.completionValue property for current vs. upper bounds, and use DestinyObjectiveDefinition.inProgressValueStyle or completedValueStyle to determine how this should be rendered. Note that progress, in Destiny 2, need not be a literal numeric progression. It could be one of a number of possible values, even a Timestamp. Always examine DestinyObjectiveDefinition.inProgressValueStyle or completedValueStyle before rendering progress.
	Progress int32 `json:"progress,omitempty"`
	// As of Forsaken, objectives' completion value is determined dynamically at runtime.  This value represents the threshold of progress you need to surpass in order for this objective to be considered \"complete\".  If you were using objective data, switch from using the DestinyObjectiveDefinition's \"completionValue\" to this value.
	CompletionValue int32 `json:"completionValue,omitempty"`
	// Whether or not the Objective is completed.
	Complete bool `json:"complete,omitempty"`
	// If this is true, the objective is visible in-game. Otherwise, it's not yet visible to the player. Up to you if you want to honor this property.
	Visible bool `json:"visible,omitempty"`
}

I may regret naming it this way - but this represents when an item has an objective that doesn't serve a beneficial purpose, but rather is used for \"flavor\" or additional information. For instance, when Emblems track specific stats, those stats are represented as Objectives on the item.

type AllOfDestinyEntitiesItemsDestinyItemTalentGridComponentGridProgression ¶

type AllOfDestinyEntitiesItemsDestinyItemTalentGridComponentGridProgression struct {
	// The hash identifier of the Progression in question. Use it to look up the DestinyProgressionDefinition in static data.
	ProgressionHash int32 `json:"progressionHash,omitempty"`
	// The amount of progress earned today for this progression.
	DailyProgress int32 `json:"dailyProgress,omitempty"`
	// If this progression has a daily limit, this is that limit.
	DailyLimit int32 `json:"dailyLimit,omitempty"`
	// The amount of progress earned toward this progression in the current week.
	WeeklyProgress int32 `json:"weeklyProgress,omitempty"`
	// If this progression has a weekly limit, this is that limit.
	WeeklyLimit int32 `json:"weeklyLimit,omitempty"`
	// This is the total amount of progress obtained overall for this progression (for instance, the total amount of Character Level experience earned)
	CurrentProgress int32 `json:"currentProgress,omitempty"`
	// This is the level of the progression (for instance, the Character Level).
	Level int32 `json:"level,omitempty"`
	// This is the maximum possible level you can achieve for this progression (for example, the maximum character level obtainable)
	LevelCap int32 `json:"levelCap,omitempty"`
	// Progressions define their levels in \"steps\". Since the last step may be repeatable, the user may be at a higher level than the actual Step achieved in the progression. Not necessarily useful, but potentially interesting for those cruising the API. Relate this to the \"steps\" property of the DestinyProgression to see which step the user is on, if you care about that. (Note that this is Content Version dependent since it refers to indexes.)
	StepIndex int32 `json:"stepIndex,omitempty"`
	// The amount of progression (i.e. \"Experience\") needed to reach the next level of this Progression. Jeez, progression is such an overloaded word.
	ProgressToNextLevel int32 `json:"progressToNextLevel,omitempty"`
	// The total amount of progression (i.e. \"Experience\") needed in order to reach the next level.
	NextLevelAt int32 `json:"nextLevelAt,omitempty"`
	// The number of resets of this progression you've executed this season, if applicable to this progression.
	CurrentResetCount int32 `json:"currentResetCount,omitempty"`
	// Information about historical resets of this progression, if there is any data for it.
	SeasonResets []DestinyDestinyProgressionResetEntry `json:"seasonResets,omitempty"`
	// Information about historical rewards for this progression, if there is any data for it.
	RewardItemStates []int32 `json:"rewardItemStates,omitempty"`
}

If the item has a progression, it will be detailed here. A progression means that the item can gain experience. Thresholds of experience are what determines whether and when a talent node can be activated.

type AllOfDestinyEntitiesProfilesDestinyProfileComponentUserInfo ¶

type AllOfDestinyEntitiesProfilesDestinyProfileComponentUserInfo struct {
	// A platform specific additional display name - ex: psn Real Name, bnet Unique Name, etc.
	SupplementalDisplayName string `json:"supplementalDisplayName,omitempty"`
	// URL the Icon if available.
	IconPath string `json:"iconPath,omitempty"`
	// If there is a cross save override in effect, this value will tell you the type that is overridding this one.
	CrossSaveOverride int32 `json:"crossSaveOverride,omitempty"`
	// 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
	ApplicableMembershipTypes []int32 `json:"applicableMembershipTypes,omitempty"`
	// If True, this is a public user membership.
	IsPublic bool `json:"isPublic,omitempty"`
	// Type of the membership. Not necessarily the native type.
	MembershipType int32 `json:"membershipType,omitempty"`
	// Membership ID as they user is known in the Accounts service
	MembershipId int64 `json:"membershipId,omitempty"`
	// 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.
	DisplayName string `json:"displayName,omitempty"`
	// The bungie global display name, if set.
	BungieGlobalDisplayName string `json:"bungieGlobalDisplayName,omitempty"`
	// The bungie global display name code, if set.
	BungieGlobalDisplayNameCode int32 `json:"bungieGlobalDisplayNameCode,omitempty"`
}

If you need to render the Profile (their platform name, icon, etc...) somewhere, this property contains that information.

type AllOfDestinyEntitiesVendorsDestinyVendorComponentProgression ¶

type AllOfDestinyEntitiesVendorsDestinyVendorComponentProgression struct {
	// The hash identifier of the Progression in question. Use it to look up the DestinyProgressionDefinition in static data.
	ProgressionHash int32 `json:"progressionHash,omitempty"`
	// The amount of progress earned today for this progression.
	DailyProgress int32 `json:"dailyProgress,omitempty"`
	// If this progression has a daily limit, this is that limit.
	DailyLimit int32 `json:"dailyLimit,omitempty"`
	// The amount of progress earned toward this progression in the current week.
	WeeklyProgress int32 `json:"weeklyProgress,omitempty"`
	// If this progression has a weekly limit, this is that limit.
	WeeklyLimit int32 `json:"weeklyLimit,omitempty"`
	// This is the total amount of progress obtained overall for this progression (for instance, the total amount of Character Level experience earned)
	CurrentProgress int32 `json:"currentProgress,omitempty"`
	// This is the level of the progression (for instance, the Character Level).
	Level int32 `json:"level,omitempty"`
	// This is the maximum possible level you can achieve for this progression (for example, the maximum character level obtainable)
	LevelCap int32 `json:"levelCap,omitempty"`
	// Progressions define their levels in \"steps\". Since the last step may be repeatable, the user may be at a higher level than the actual Step achieved in the progression. Not necessarily useful, but potentially interesting for those cruising the API. Relate this to the \"steps\" property of the DestinyProgression to see which step the user is on, if you care about that. (Note that this is Content Version dependent since it refers to indexes.)
	StepIndex int32 `json:"stepIndex,omitempty"`
	// The amount of progression (i.e. \"Experience\") needed to reach the next level of this Progression. Jeez, progression is such an overloaded word.
	ProgressToNextLevel int32 `json:"progressToNextLevel,omitempty"`
	// The total amount of progression (i.e. \"Experience\") needed in order to reach the next level.
	NextLevelAt int32 `json:"nextLevelAt,omitempty"`
	// The number of resets of this progression you've executed this season, if applicable to this progression.
	CurrentResetCount int32 `json:"currentResetCount,omitempty"`
	// Information about historical resets of this progression, if there is any data for it.
	SeasonResets []DestinyDestinyProgressionResetEntry `json:"seasonResets,omitempty"`
	// Information about historical rewards for this progression, if there is any data for it.
	RewardItemStates []int32 `json:"rewardItemStates,omitempty"`
}

If the Vendor has a related Reputation, this is the Progression data that represents the character's Reputation level with this Vendor.

type AllOfDestinyHistoricalStatsDestinyClanAggregateStatValue ¶

type AllOfDestinyHistoricalStatsDestinyClanAggregateStatValue struct {
	// Unique ID for this stat
	StatId string `json:"statId,omitempty"`
	// Basic stat value.
	Basic *interface{} `json:"basic,omitempty"`
	// Per game average for the statistic, if applicable
	Pga *interface{} `json:"pga,omitempty"`
	// Weighted value of the stat if a weight greater than 1 has been assigned.
	Weighted *interface{} `json:"weighted,omitempty"`
	// When a stat represents the best, most, longest, fastest or some other personal best, the actual activity ID where that personal best was established is available on this property.
	ActivityId int64 `json:"activityId,omitempty"`
}

Value of the stat for this player

type AllOfDestinyHistoricalStatsDestinyHistoricalStatsPeriodGroupActivityDetails ¶

type AllOfDestinyHistoricalStatsDestinyHistoricalStatsPeriodGroupActivityDetails struct {
	// The unique hash identifier of the DestinyActivityDefinition that was played. If I had this to do over, it'd be named activityHash. Too late now.
	ReferenceId int32 `json:"referenceId,omitempty"`
	// The unique hash identifier of the DestinyActivityDefinition that was played.
	DirectorActivityHash int32 `json:"directorActivityHash,omitempty"`
	// The unique identifier for this *specific* match that was played.  This value can be used to get additional data about this activity such as who else was playing via the GetPostGameCarnageReport endpoint.
	InstanceId int64 `json:"instanceId,omitempty"`
	// Indicates the most specific game mode of the activity that we could find.
	Mode int32 `json:"mode,omitempty"`
	// The list of all Activity Modes to which this activity applies, including aggregates. This will let you see, for example, whether the activity was both Clash and part of the Trials of the Nine event.
	Modes []int32 `json:"modes,omitempty"`
	// Whether or not the match was a private match.
	IsPrivate bool `json:"isPrivate,omitempty"`
	// The Membership Type indicating the platform on which this match was played.
	MembershipType int32 `json:"membershipType,omitempty"`
}

If the period group is for a specific activity, this property will be set.

type AllOfDestinyHistoricalStatsDestinyHistoricalStatsValueBasic ¶

type AllOfDestinyHistoricalStatsDestinyHistoricalStatsValueBasic struct {
	// Raw value of the statistic
	Value float64 `json:"value,omitempty"`
	// Localized formated version of the value.
	DisplayValue string `json:"displayValue,omitempty"`
}

Basic stat value.

type AllOfDestinyHistoricalStatsDestinyHistoricalStatsValuePga ¶

type AllOfDestinyHistoricalStatsDestinyHistoricalStatsValuePga struct {
	// Raw value of the statistic
	Value float64 `json:"value,omitempty"`
	// Localized formated version of the value.
	DisplayValue string `json:"displayValue,omitempty"`
}

Per game average for the statistic, if applicable

type AllOfDestinyHistoricalStatsDestinyHistoricalStatsValueWeighted ¶

type AllOfDestinyHistoricalStatsDestinyHistoricalStatsValueWeighted struct {
	// Raw value of the statistic
	Value float64 `json:"value,omitempty"`
	// Localized formated version of the value.
	DisplayValue string `json:"displayValue,omitempty"`
}

Weighted value of the stat if a weight greater than 1 has been assigned.

type AllOfDestinyHistoricalStatsDestinyLeaderboardEntryPlayer ¶

type AllOfDestinyHistoricalStatsDestinyLeaderboardEntryPlayer struct {
	// Details about the player as they are known in game (platform display name, Destiny emblem)
	DestinyUserInfo *interface{} `json:"destinyUserInfo,omitempty"`
	// Class of the character if applicable and available.
	CharacterClass string `json:"characterClass,omitempty"`
	ClassHash      int32  `json:"classHash,omitempty"`
	RaceHash       int32  `json:"raceHash,omitempty"`
	GenderHash     int32  `json:"genderHash,omitempty"`
	// Level of the character if available. Zero if it is not available.
	CharacterLevel int32 `json:"characterLevel,omitempty"`
	// Light Level of the character if available. Zero if it is not available.
	LightLevel int32 `json:"lightLevel,omitempty"`
	// Details about the player as they are known on BungieNet. This will be undefined if the player has marked their credential private, or does not have a BungieNet account.
	BungieNetUserInfo *interface{} `json:"bungieNetUserInfo,omitempty"`
	// Current clan name for the player. This value may be null or an empty string if the user does not have a clan.
	ClanName string `json:"clanName,omitempty"`
	// Current clan tag for the player. This value may be null or an empty string if the user does not have a clan.
	ClanTag string `json:"clanTag,omitempty"`
	// If we know the emblem's hash, this can be used to look up the player's emblem at the time of a match when receiving PGCR data, or otherwise their currently equipped emblem (if we are able to obtain it).
	EmblemHash int32 `json:"emblemHash,omitempty"`
}

Identity details of the player

type AllOfDestinyHistoricalStatsDestinyLeaderboardEntryValue ¶

type AllOfDestinyHistoricalStatsDestinyLeaderboardEntryValue struct {
	// Unique ID for this stat
	StatId string `json:"statId,omitempty"`
	// Basic stat value.
	Basic *interface{} `json:"basic,omitempty"`
	// Per game average for the statistic, if applicable
	Pga *interface{} `json:"pga,omitempty"`
	// Weighted value of the stat if a weight greater than 1 has been assigned.
	Weighted *interface{} `json:"weighted,omitempty"`
	// When a stat represents the best, most, longest, fastest or some other personal best, the actual activity ID where that personal best was established is available on this property.
	ActivityId int64 `json:"activityId,omitempty"`
}

Value of the stat for this player

type AllOfDestinyHistoricalStatsDestinyPlayerBungieNetUserInfo ¶

type AllOfDestinyHistoricalStatsDestinyPlayerBungieNetUserInfo struct {
	// A platform specific additional display name - ex: psn Real Name, bnet Unique Name, etc.
	SupplementalDisplayName string `json:"supplementalDisplayName,omitempty"`
	// URL the Icon if available.
	IconPath string `json:"iconPath,omitempty"`
	// If there is a cross save override in effect, this value will tell you the type that is overridding this one.
	CrossSaveOverride int32 `json:"crossSaveOverride,omitempty"`
	// 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
	ApplicableMembershipTypes []int32 `json:"applicableMembershipTypes,omitempty"`
	// If True, this is a public user membership.
	IsPublic bool `json:"isPublic,omitempty"`
	// Type of the membership. Not necessarily the native type.
	MembershipType int32 `json:"membershipType,omitempty"`
	// Membership ID as they user is known in the Accounts service
	MembershipId int64 `json:"membershipId,omitempty"`
	// 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.
	DisplayName string `json:"displayName,omitempty"`
	// The bungie global display name, if set.
	BungieGlobalDisplayName string `json:"bungieGlobalDisplayName,omitempty"`
	// The bungie global display name code, if set.
	BungieGlobalDisplayNameCode int32 `json:"bungieGlobalDisplayNameCode,omitempty"`
}

Details about the player as they are known on BungieNet. This will be undefined if the player has marked their credential private, or does not have a BungieNet account.

type AllOfDestinyHistoricalStatsDestinyPlayerDestinyUserInfo ¶

type AllOfDestinyHistoricalStatsDestinyPlayerDestinyUserInfo struct {
	// A platform specific additional display name - ex: psn Real Name, bnet Unique Name, etc.
	SupplementalDisplayName string `json:"supplementalDisplayName,omitempty"`
	// URL the Icon if available.
	IconPath string `json:"iconPath,omitempty"`
	// If there is a cross save override in effect, this value will tell you the type that is overridding this one.
	CrossSaveOverride int32 `json:"crossSaveOverride,omitempty"`
	// 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
	ApplicableMembershipTypes []int32 `json:"applicableMembershipTypes,omitempty"`
	// If True, this is a public user membership.
	IsPublic bool `json:"isPublic,omitempty"`
	// Type of the membership. Not necessarily the native type.
	MembershipType int32 `json:"membershipType,omitempty"`
	// Membership ID as they user is known in the Accounts service
	MembershipId int64 `json:"membershipId,omitempty"`
	// 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.
	DisplayName string `json:"displayName,omitempty"`
	// The bungie global display name, if set.
	BungieGlobalDisplayName string `json:"bungieGlobalDisplayName,omitempty"`
	// The bungie global display name code, if set.
	BungieGlobalDisplayNameCode int32 `json:"bungieGlobalDisplayNameCode,omitempty"`
}

Details about the player as they are known in game (platform display name, Destiny emblem)

type AllOfDestinyHistoricalStatsDestinyPostGameCarnageReportDataActivityDetails ¶

type AllOfDestinyHistoricalStatsDestinyPostGameCarnageReportDataActivityDetails struct {
	// The unique hash identifier of the DestinyActivityDefinition that was played. If I had this to do over, it'd be named activityHash. Too late now.
	ReferenceId int32 `json:"referenceId,omitempty"`
	// The unique hash identifier of the DestinyActivityDefinition that was played.
	DirectorActivityHash int32 `json:"directorActivityHash,omitempty"`
	// The unique identifier for this *specific* match that was played.  This value can be used to get additional data about this activity such as who else was playing via the GetPostGameCarnageReport endpoint.
	InstanceId int64 `json:"instanceId,omitempty"`
	// Indicates the most specific game mode of the activity that we could find.
	Mode int32 `json:"mode,omitempty"`
	// The list of all Activity Modes to which this activity applies, including aggregates. This will let you see, for example, whether the activity was both Clash and part of the Trials of the Nine event.
	Modes []int32 `json:"modes,omitempty"`
	// Whether or not the match was a private match.
	IsPrivate bool `json:"isPrivate,omitempty"`
	// The Membership Type indicating the platform on which this match was played.
	MembershipType int32 `json:"membershipType,omitempty"`
}

Details about the activity.

type AllOfDestinyHistoricalStatsDestinyPostGameCarnageReportEntryExtended ¶

type AllOfDestinyHistoricalStatsDestinyPostGameCarnageReportEntryExtended struct {
	// List of weapons and their perspective values.
	Weapons []DestinyHistoricalStatsDestinyHistoricalWeaponStats `json:"weapons,omitempty"`
	// Collection of stats for the player in this activity.
	Values map[string]DestinyHistoricalStatsDestinyHistoricalStatsValue `json:"values,omitempty"`
}

Extended data extracted from the activity blob.

type AllOfDestinyHistoricalStatsDestinyPostGameCarnageReportEntryPlayer ¶

type AllOfDestinyHistoricalStatsDestinyPostGameCarnageReportEntryPlayer struct {
	// Details about the player as they are known in game (platform display name, Destiny emblem)
	DestinyUserInfo *interface{} `json:"destinyUserInfo,omitempty"`
	// Class of the character if applicable and available.
	CharacterClass string `json:"characterClass,omitempty"`
	ClassHash      int32  `json:"classHash,omitempty"`
	RaceHash       int32  `json:"raceHash,omitempty"`
	GenderHash     int32  `json:"genderHash,omitempty"`
	// Level of the character if available. Zero if it is not available.
	CharacterLevel int32 `json:"characterLevel,omitempty"`
	// Light Level of the character if available. Zero if it is not available.
	LightLevel int32 `json:"lightLevel,omitempty"`
	// Details about the player as they are known on BungieNet. This will be undefined if the player has marked their credential private, or does not have a BungieNet account.
	BungieNetUserInfo *interface{} `json:"bungieNetUserInfo,omitempty"`
	// Current clan name for the player. This value may be null or an empty string if the user does not have a clan.
	ClanName string `json:"clanName,omitempty"`
	// Current clan tag for the player. This value may be null or an empty string if the user does not have a clan.
	ClanTag string `json:"clanTag,omitempty"`
	// If we know the emblem's hash, this can be used to look up the player's emblem at the time of a match when receiving PGCR data, or otherwise their currently equipped emblem (if we are able to obtain it).
	EmblemHash int32 `json:"emblemHash,omitempty"`
}

Identity details of the player

type AllOfDestinyHistoricalStatsDestinyPostGameCarnageReportEntryScore ¶

type AllOfDestinyHistoricalStatsDestinyPostGameCarnageReportEntryScore struct {
	// Unique ID for this stat
	StatId string `json:"statId,omitempty"`
	// Basic stat value.
	Basic *interface{} `json:"basic,omitempty"`
	// Per game average for the statistic, if applicable
	Pga *interface{} `json:"pga,omitempty"`
	// Weighted value of the stat if a weight greater than 1 has been assigned.
	Weighted *interface{} `json:"weighted,omitempty"`
	// When a stat represents the best, most, longest, fastest or some other personal best, the actual activity ID where that personal best was established is available on this property.
	ActivityId int64 `json:"activityId,omitempty"`
}

Score of the player if available

type AllOfDestinyHistoricalStatsDestinyPostGameCarnageReportTeamEntryScore ¶

type AllOfDestinyHistoricalStatsDestinyPostGameCarnageReportTeamEntryScore struct {
	// Unique ID for this stat
	StatId string `json:"statId,omitempty"`
	// Basic stat value.
	Basic *interface{} `json:"basic,omitempty"`
	// Per game average for the statistic, if applicable
	Pga *interface{} `json:"pga,omitempty"`
	// Weighted value of the stat if a weight greater than 1 has been assigned.
	Weighted *interface{} `json:"weighted,omitempty"`
	// When a stat represents the best, most, longest, fastest or some other personal best, the actual activity ID where that personal best was established is available on this property.
	ActivityId int64 `json:"activityId,omitempty"`
}

Score earned by the team

type AllOfDestinyHistoricalStatsDestinyPostGameCarnageReportTeamEntryStanding ¶

type AllOfDestinyHistoricalStatsDestinyPostGameCarnageReportTeamEntryStanding struct {
	// Unique ID for this stat
	StatId string `json:"statId,omitempty"`
	// Basic stat value.
	Basic *interface{} `json:"basic,omitempty"`
	// Per game average for the statistic, if applicable
	Pga *interface{} `json:"pga,omitempty"`
	// Weighted value of the stat if a weight greater than 1 has been assigned.
	Weighted *interface{} `json:"weighted,omitempty"`
	// When a stat represents the best, most, longest, fastest or some other personal best, the actual activity ID where that personal best was established is available on this property.
	ActivityId int64 `json:"activityId,omitempty"`
}

Team's standing relative to other teams.

type AllOfDestinyMilestonesDestinyMilestoneActivityVariantCompletionStatus ¶

type AllOfDestinyMilestonesDestinyMilestoneActivityVariantCompletionStatus struct {
	// If the activity has been \"completed\", that information will be returned here.
	Completed bool `json:"completed,omitempty"`
	// If the Activity has discrete \"phases\" that we can track, that info will be here. Otherwise, this value will be NULL. Note that this is a list and not a dictionary: the order implies the ascending order of phases or progression in this activity.
	Phases []DestinyMilestonesDestinyMilestoneActivityPhase `json:"phases,omitempty"`
}

An OPTIONAL component: if it makes sense to talk about this activity variant in terms of whether or not it has been completed or what progress you have made in it, this will be returned. Otherwise, this will be NULL.

type AllOfDestinyMilestonesDestinyMilestoneQuestActivity ¶

type AllOfDestinyMilestonesDestinyMilestoneQuestActivity struct {
	// The hash of an arbitrarily chosen variant of this activity. We'll go ahead and call that the \"canonical\" activity, because if you're using this value you should only use it for properties that are common across the variants: things like the name of the activity, it's location, etc... Use this hash to look up the DestinyActivityDefinition of this activity for rendering data.
	ActivityHash int32 `json:"activityHash,omitempty"`
	// The hash identifier of the most specific Activity Mode under which this activity is played. This is useful for situations where the activity in question is - for instance - a PVP map, but it's not clear what mode the PVP map is being played under. If it's a playlist, this will be less specific: but hopefully useful in some way.
	ActivityModeHash int32 `json:"activityModeHash,omitempty"`
	// The enumeration equivalent of the most specific Activity Mode under which this activity is played.
	ActivityModeType int32 `json:"activityModeType,omitempty"`
	// If the activity has modifiers, this will be the list of modifiers that all variants have in common. Perform lookups against DestinyActivityModifierDefinition which defines the modifier being applied to get at the modifier data. Note that, in the DestiyActivityDefinition, you will see many more modifiers than this being referred to: those are all *possible* modifiers for the activity, not the active ones. Use only the active ones to match what's really live.
	ModifierHashes []int32 `json:"modifierHashes,omitempty"`
	// If you want more than just name/location/etc... you're going to have to dig into and show the variants of the conceptual activity. These will differ in seemingly arbitrary ways, like difficulty level and modifiers applied. Show it in whatever way tickles your fancy.
	Variants []DestinyMilestonesDestinyMilestoneActivityVariant `json:"variants,omitempty"`
}

*IF* the Milestone has an active Activity that can give you greater details about what you need to do, it will be returned here. Remember to associate this with the DestinyMilestoneDefinition's activities to get details about the activity, including what specific quest it is related to if you have multiple quests to choose from.

type AllOfDestinyMilestonesDestinyMilestoneQuestStatus ¶

type AllOfDestinyMilestonesDestinyMilestoneQuestStatus struct {
	// The hash identifier for the Quest Item. (Note: Quests are defined as Items, and thus you would use this to look up the quest's DestinyInventoryItemDefinition). For information on all steps in the quest, you can then examine its DestinyInventoryItemDefinition.setData property for Quest Steps (which are *also* items). You can use the Item Definition to display human readable data about the overall quest.
	QuestHash int32 `json:"questHash,omitempty"`
	// The hash identifier of the current Quest Step, which is also a DestinyInventoryItemDefinition. You can use this to get human readable data about the current step and what to do in that step.
	StepHash int32 `json:"stepHash,omitempty"`
	// A step can have multiple objectives. This will give you the progress for each objective in the current step, in the order in which they are rendered in-game.
	StepObjectives []DestinyQuestsDestinyObjectiveProgress `json:"stepObjectives,omitempty"`
	// Whether or not the quest is tracked
	Tracked bool `json:"tracked,omitempty"`
	// The current Quest Step will be an instanced item in the player's inventory. If you care about that, this is the instance ID of that item.
	ItemInstanceId int64 `json:"itemInstanceId,omitempty"`
	// Whether or not the whole quest has been completed, regardless of whether or not you have redeemed the rewards for the quest.
	Completed bool `json:"completed,omitempty"`
	// Whether or not you have redeemed rewards for this quest.
	Redeemed bool `json:"redeemed,omitempty"`
	// Whether or not you have started this quest.
	Started bool `json:"started,omitempty"`
	// If the quest has a related Vendor that you should talk to in order to initiate the quest/earn rewards/continue the quest, this will be the hash identifier of that Vendor. Look it up its DestinyVendorDefinition.
	VendorHash int32 `json:"vendorHash,omitempty"`
}

The current status of the quest for the character making the request.

type AllOfDestinyMilestonesDestinyPublicMilestoneQuestActivity ¶

type AllOfDestinyMilestonesDestinyPublicMilestoneQuestActivity struct {
	// The hash identifier of the activity that's been chosen to be considered the canonical \"conceptual\" activity definition. This may have many variants, defined herein.
	ActivityHash int32 `json:"activityHash,omitempty"`
	// The activity may have 0-to-many modifiers: if it does, this will contain the hashes to the DestinyActivityModifierDefinition that defines the modifier being applied.
	ModifierHashes []int32 `json:"modifierHashes,omitempty"`
	// Every relevant variation of this conceptual activity, including the conceptual activity itself, have variants defined here.
	Variants []DestinyMilestonesDestinyPublicMilestoneActivityVariant `json:"variants,omitempty"`
	// The hash identifier of the most specific Activity Mode under which this activity is played. This is useful for situations where the activity in question is - for instance - a PVP map, but it's not clear what mode the PVP map is being played under. If it's a playlist, this will be less specific: but hopefully useful in some way.
	ActivityModeHash int32 `json:"activityModeHash,omitempty"`
	// The enumeration equivalent of the most specific Activity Mode under which this activity is played.
	ActivityModeType int32 `json:"activityModeType,omitempty"`
}

A milestone need not have an active activity, but if there is one it will be returned here, along with any variant and additional information.

type AllOfDestinyRequestsActionsDestinyInsertPlugsActionRequestPlug ¶

type AllOfDestinyRequestsActionsDestinyInsertPlugsActionRequestPlug struct {
	// The index into the socket array, which identifies the specific socket being operated on. We also need to know the socketArrayType in order to uniquely identify the socket.  Don't point to or try to insert a plug into an infusion socket. It won't work.
	SocketIndex int32 `json:"socketIndex,omitempty"`
	// This property, combined with the socketIndex, tells us which socket we are referring to (since operations can be performed on both Intrinsic and \"default\" sockets, and they occupy different arrays in the Inventory Item Definition). I know, I know. Don't give me that look.
	SocketArrayType int32 `json:"socketArrayType,omitempty"`
	// Plugs are never instanced (except in infusion). So with the hash alone, we should be able to: 1) Infer whether the player actually needs to have the item, or if it's a reusable plug 2) Perform any operation needed to use the Plug, including removing the plug item and running reward sheets.
	PlugItemHash int32 `json:"plugItemHash,omitempty"`
}

The plugs being inserted.

type AllOfDestinyRequestsActionsDestinyInsertPlugsFreeActionRequestPlug ¶

type AllOfDestinyRequestsActionsDestinyInsertPlugsFreeActionRequestPlug struct {
	// The index into the socket array, which identifies the specific socket being operated on. We also need to know the socketArrayType in order to uniquely identify the socket.  Don't point to or try to insert a plug into an infusion socket. It won't work.
	SocketIndex int32 `json:"socketIndex,omitempty"`
	// This property, combined with the socketIndex, tells us which socket we are referring to (since operations can be performed on both Intrinsic and \"default\" sockets, and they occupy different arrays in the Inventory Item Definition). I know, I know. Don't give me that look.
	SocketArrayType int32 `json:"socketArrayType,omitempty"`
	// Plugs are never instanced (except in infusion). So with the hash alone, we should be able to: 1) Infer whether the player actually needs to have the item, or if it's a reusable plug 2) Perform any operation needed to use the Plug, including removing the plug item and running reward sheets.
	PlugItemHash int32 `json:"plugItemHash,omitempty"`
}

The plugs being inserted.

type AllOfDestinyResponsesDestinyCharacterResponseActivities ¶

type AllOfDestinyResponsesDestinyCharacterResponseActivities struct {
	Data    *DestinyEntitiesCharactersDestinyCharacterActivitiesComponent `json:"data,omitempty"`
	Privacy int32                                                         `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

Activity data - info about current activities available to the player. COMPONENT TYPE: CharacterActivities

type AllOfDestinyResponsesDestinyCharacterResponseCharacter ¶

type AllOfDestinyResponsesDestinyCharacterResponseCharacter struct {
	Data    *DestinyEntitiesCharactersDestinyCharacterComponent `json:"data,omitempty"`
	Privacy int32                                               `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

Base information about the character in question. COMPONENT TYPE: Characters

type AllOfDestinyResponsesDestinyCharacterResponseCollectibles ¶

type AllOfDestinyResponsesDestinyCharacterResponseCollectibles struct {
	Data    *DestinyComponentsCollectiblesDestinyCollectiblesComponent `json:"data,omitempty"`
	Privacy int32                                                      `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

COMPONENT TYPE: Collectibles

type AllOfDestinyResponsesDestinyCharacterResponseCurrencyLookups ¶

type AllOfDestinyResponsesDestinyCharacterResponseCurrencyLookups struct {
	Data    *DestinyComponentsInventoryDestinyCurrenciesComponent `json:"data,omitempty"`
	Privacy int32                                                 `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

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

type AllOfDestinyResponsesDestinyCharacterResponseEquipment ¶

type AllOfDestinyResponsesDestinyCharacterResponseEquipment struct {
	Data    *DestinyEntitiesInventoryDestinyInventoryComponent `json:"data,omitempty"`
	Privacy int32                                              `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

Equipped items on the character. COMPONENT TYPE: CharacterEquipment

type AllOfDestinyResponsesDestinyCharacterResponseInventory ¶

type AllOfDestinyResponsesDestinyCharacterResponseInventory struct {
	Data    *DestinyEntitiesInventoryDestinyInventoryComponent `json:"data,omitempty"`
	Privacy int32                                              `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

The character-level non-equipped inventory items. COMPONENT TYPE: CharacterInventories

type AllOfDestinyResponsesDestinyCharacterResponseItemComponents ¶

type AllOfDestinyResponsesDestinyCharacterResponseItemComponents struct {
	Instances      *DictionaryComponentResponseOfint64AndDestinyItemInstanceComponent       `json:"instances,omitempty"`
	RenderData     *DictionaryComponentResponseOfint64AndDestinyItemRenderComponent         `json:"renderData,omitempty"`
	Stats          *DictionaryComponentResponseOfint64AndDestinyItemStatsComponent          `json:"stats,omitempty"`
	Sockets        *DictionaryComponentResponseOfint64AndDestinyItemSocketsComponent        `json:"sockets,omitempty"`
	ReusablePlugs  *DictionaryComponentResponseOfint64AndDestinyItemReusablePlugsComponent  `json:"reusablePlugs,omitempty"`
	PlugObjectives *DictionaryComponentResponseOfint64AndDestinyItemPlugObjectivesComponent `json:"plugObjectives,omitempty"`
	TalentGrids    *DictionaryComponentResponseOfint64AndDestinyItemTalentGridComponent     `json:"talentGrids,omitempty"`
	PlugStates     *DictionaryComponentResponseOfuint32AndDestinyItemPlugComponent          `json:"plugStates,omitempty"`
	Objectives     *DictionaryComponentResponseOfint64AndDestinyItemObjectivesComponent     `json:"objectives,omitempty"`
	Perks          *DictionaryComponentResponseOfint64AndDestinyItemPerksComponent          `json:"perks,omitempty"`
}

The set of components belonging to the player's instanced items. COMPONENT TYPE: [See inside the DestinyItemComponentSet contract for component types.]

type AllOfDestinyResponsesDestinyCharacterResponseKiosks ¶

type AllOfDestinyResponsesDestinyCharacterResponseKiosks struct {
	Data    *DestinyComponentsKiosksDestinyKiosksComponent `json:"data,omitempty"`
	Privacy int32                                          `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

Items available from Kiosks that are available to this specific character. COMPONENT TYPE: Kiosks

type AllOfDestinyResponsesDestinyCharacterResponseLoadouts ¶

type AllOfDestinyResponsesDestinyCharacterResponseLoadouts struct {
	Data    *DestinyComponentsLoadoutsDestinyLoadoutsComponent `json:"data,omitempty"`
	Privacy int32                                              `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

The loadouts available to the character. COMPONENT TYPE: CharacterLoadouts

type AllOfDestinyResponsesDestinyCharacterResponsePlugSets ¶

type AllOfDestinyResponsesDestinyCharacterResponsePlugSets struct {
	Data    *DestinyComponentsPlugSetsDestinyPlugSetsComponent `json:"data,omitempty"`
	Privacy int32                                              `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

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

type AllOfDestinyResponsesDestinyCharacterResponsePresentationNodes ¶

type AllOfDestinyResponsesDestinyCharacterResponsePresentationNodes struct {
	Data    *DestinyComponentsPresentationDestinyPresentationNodesComponent `json:"data,omitempty"`
	Privacy int32                                                           `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

COMPONENT TYPE: PresentationNodes

type AllOfDestinyResponsesDestinyCharacterResponseProgressions ¶

type AllOfDestinyResponsesDestinyCharacterResponseProgressions struct {
	Data    *DestinyEntitiesCharactersDestinyCharacterProgressionComponent `json:"data,omitempty"`
	Privacy int32                                                          `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

Character progression data, including Milestones. COMPONENT TYPE: CharacterProgressions

type AllOfDestinyResponsesDestinyCharacterResponseRecords ¶

type AllOfDestinyResponsesDestinyCharacterResponseRecords struct {
	Data    *DestinyComponentsRecordsDestinyCharacterRecordsComponent `json:"data,omitempty"`
	Privacy int32                                                     `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

COMPONENT TYPE: Records

type AllOfDestinyResponsesDestinyCharacterResponseRenderData ¶

type AllOfDestinyResponsesDestinyCharacterResponseRenderData struct {
	Data    *DestinyEntitiesCharactersDestinyCharacterRenderComponent `json:"data,omitempty"`
	Privacy int32                                                     `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

Character rendering data - a minimal set of information about equipment and dyes used for rendering. COMPONENT TYPE: CharacterRenderData

type AllOfDestinyResponsesDestinyCharacterResponseUninstancedItemComponents ¶

type AllOfDestinyResponsesDestinyCharacterResponseUninstancedItemComponents struct {
	Objectives *DictionaryComponentResponseOfuint32AndDestinyItemObjectivesComponent `json:"objectives,omitempty"`
	Perks      *DictionaryComponentResponseOfuint32AndDestinyItemPerksComponent      `json:"perks,omitempty"`
}

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.]

type AllOfDestinyResponsesDestinyCollectibleNodeDetailResponseCollectibleItemComponents ¶

type AllOfDestinyResponsesDestinyCollectibleNodeDetailResponseCollectibleItemComponents struct {
	Instances      *DictionaryComponentResponseOfuint32AndDestinyItemInstanceComponent       `json:"instances,omitempty"`
	RenderData     *DictionaryComponentResponseOfuint32AndDestinyItemRenderComponent         `json:"renderData,omitempty"`
	Stats          *DictionaryComponentResponseOfuint32AndDestinyItemStatsComponent          `json:"stats,omitempty"`
	Sockets        *DictionaryComponentResponseOfuint32AndDestinyItemSocketsComponent        `json:"sockets,omitempty"`
	ReusablePlugs  *DictionaryComponentResponseOfuint32AndDestinyItemReusablePlugsComponent  `json:"reusablePlugs,omitempty"`
	PlugObjectives *DictionaryComponentResponseOfuint32AndDestinyItemPlugObjectivesComponent `json:"plugObjectives,omitempty"`
	TalentGrids    *DictionaryComponentResponseOfuint32AndDestinyItemTalentGridComponent     `json:"talentGrids,omitempty"`
	PlugStates     *DictionaryComponentResponseOfuint32AndDestinyItemPlugComponent           `json:"plugStates,omitempty"`
	Objectives     *DictionaryComponentResponseOfuint32AndDestinyItemObjectivesComponent     `json:"objectives,omitempty"`
	Perks          *DictionaryComponentResponseOfuint32AndDestinyItemPerksComponent          `json:"perks,omitempty"`
}

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.]

type AllOfDestinyResponsesDestinyCollectibleNodeDetailResponseCollectibles ¶

type AllOfDestinyResponsesDestinyCollectibleNodeDetailResponseCollectibles struct {
	Data    *DestinyComponentsCollectiblesDestinyCollectiblesComponent `json:"data,omitempty"`
	Privacy int32                                                      `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

COMPONENT TYPE: Collectibles

type AllOfDestinyResponsesDestinyErrorProfileInfoCard ¶

type AllOfDestinyResponsesDestinyErrorProfileInfoCard struct {
	// A platform specific additional display name - ex: psn Real Name, bnet Unique Name, etc.
	SupplementalDisplayName string `json:"supplementalDisplayName,omitempty"`
	// URL the Icon if available.
	IconPath string `json:"iconPath,omitempty"`
	// If there is a cross save override in effect, this value will tell you the type that is overridding this one.
	CrossSaveOverride int32 `json:"crossSaveOverride,omitempty"`
	// 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
	ApplicableMembershipTypes []int32 `json:"applicableMembershipTypes,omitempty"`
	// If True, this is a public user membership.
	IsPublic bool `json:"isPublic,omitempty"`
	// Type of the membership. Not necessarily the native type.
	MembershipType int32 `json:"membershipType,omitempty"`
	// Membership ID as they user is known in the Accounts service
	MembershipId int64 `json:"membershipId,omitempty"`
	// 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.
	DisplayName string `json:"displayName,omitempty"`
	// The bungie global display name, if set.
	BungieGlobalDisplayName string `json:"bungieGlobalDisplayName,omitempty"`
	// The bungie global display name code, if set.
	BungieGlobalDisplayNameCode int32 `json:"bungieGlobalDisplayNameCode,omitempty"`
}

Basic info about the account that failed. Don't expect anything other than membership ID, Membership Type, and displayName to be populated.

type AllOfDestinyResponsesDestinyItemResponseInstance ¶

type AllOfDestinyResponsesDestinyItemResponseInstance struct {
	Data    *DestinyEntitiesItemsDestinyItemInstanceComponent `json:"data,omitempty"`
	Privacy int32                                             `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

Basic instance data for the item. COMPONENT TYPE: ItemInstances

type AllOfDestinyResponsesDestinyItemResponseItem ¶

type AllOfDestinyResponsesDestinyItemResponseItem struct {
	Data    *DestinyEntitiesItemsDestinyItemComponent `json:"data,omitempty"`
	Privacy int32                                     `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

Common data for the item relevant to its non-instanced properties. COMPONENT TYPE: ItemCommonData

type AllOfDestinyResponsesDestinyItemResponseObjectives ¶

type AllOfDestinyResponsesDestinyItemResponseObjectives struct {
	Data    *DestinyEntitiesItemsDestinyItemObjectivesComponent `json:"data,omitempty"`
	Privacy int32                                               `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

Information specifically about the item's objectives. COMPONENT TYPE: ItemObjectives

type AllOfDestinyResponsesDestinyItemResponsePerks ¶

type AllOfDestinyResponsesDestinyItemResponsePerks struct {
	Data    *DestinyEntitiesItemsDestinyItemPerksComponent `json:"data,omitempty"`
	Privacy int32                                          `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

Information specifically about the perks currently active on the item. COMPONENT TYPE: ItemPerks

type AllOfDestinyResponsesDestinyItemResponsePlugObjectives ¶

type AllOfDestinyResponsesDestinyItemResponsePlugObjectives struct {
	Data    *DestinyComponentsItemsDestinyItemPlugObjectivesComponent `json:"data,omitempty"`
	Privacy int32                                                     `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

Information about objectives on Plugs for a given item. See the component's documentation for more info. COMPONENT TYPE: ItemPlugObjectives

type AllOfDestinyResponsesDestinyItemResponseRenderData ¶

type AllOfDestinyResponsesDestinyItemResponseRenderData struct {
	Data    *DestinyEntitiesItemsDestinyItemRenderComponent `json:"data,omitempty"`
	Privacy int32                                           `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

Information about how to render the item in 3D. COMPONENT TYPE: ItemRenderData

type AllOfDestinyResponsesDestinyItemResponseReusablePlugs ¶

type AllOfDestinyResponsesDestinyItemResponseReusablePlugs struct {
	Data    *DestinyComponentsItemsDestinyItemReusablePlugsComponent `json:"data,omitempty"`
	Privacy int32                                                    `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

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

type AllOfDestinyResponsesDestinyItemResponseSockets ¶

type AllOfDestinyResponsesDestinyItemResponseSockets struct {
	Data    *DestinyEntitiesItemsDestinyItemSocketsComponent `json:"data,omitempty"`
	Privacy int32                                            `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

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

type AllOfDestinyResponsesDestinyItemResponseStats ¶

type AllOfDestinyResponsesDestinyItemResponseStats struct {
	Data    *DestinyEntitiesItemsDestinyItemStatsComponent `json:"data,omitempty"`
	Privacy int32                                          `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

Information about the computed stats of the item: power, defense, etc... COMPONENT TYPE: ItemStats

type AllOfDestinyResponsesDestinyItemResponseTalentGrid ¶

type AllOfDestinyResponsesDestinyItemResponseTalentGrid struct {
	Data    *DestinyEntitiesItemsDestinyItemTalentGridComponent `json:"data,omitempty"`
	Privacy int32                                               `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

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

type AllOfDestinyResponsesDestinyLinkedProfilesResponseBnetMembership ¶

type AllOfDestinyResponsesDestinyLinkedProfilesResponseBnetMembership struct {
	// A platform specific additional display name - ex: psn Real Name, bnet Unique Name, etc.
	SupplementalDisplayName string `json:"supplementalDisplayName,omitempty"`
	// URL the Icon if available.
	IconPath string `json:"iconPath,omitempty"`
	// If there is a cross save override in effect, this value will tell you the type that is overridding this one.
	CrossSaveOverride int32 `json:"crossSaveOverride,omitempty"`
	// 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
	ApplicableMembershipTypes []int32 `json:"applicableMembershipTypes,omitempty"`
	// If True, this is a public user membership.
	IsPublic bool `json:"isPublic,omitempty"`
	// Type of the membership. Not necessarily the native type.
	MembershipType int32 `json:"membershipType,omitempty"`
	// Membership ID as they user is known in the Accounts service
	MembershipId int64 `json:"membershipId,omitempty"`
	// 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.
	DisplayName string `json:"displayName,omitempty"`
	// The bungie global display name, if set.
	BungieGlobalDisplayName string `json:"bungieGlobalDisplayName,omitempty"`
	// The bungie global display name code, if set.
	BungieGlobalDisplayNameCode int32 `json:"bungieGlobalDisplayNameCode,omitempty"`
}

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

type AllOfDestinyResponsesDestinyProfileResponseCharacterActivities ¶

type AllOfDestinyResponsesDestinyProfileResponseCharacterActivities struct {
	Data    map[string]DestinyEntitiesCharactersDestinyCharacterActivitiesComponent `json:"data,omitempty"`
	Privacy int32                                                                   `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

Character activity data - the activities available to this character and its status, keyed by the Character's Id. COMPONENT TYPE: CharacterActivities

type AllOfDestinyResponsesDestinyProfileResponseCharacterCollectibles ¶

type AllOfDestinyResponsesDestinyProfileResponseCharacterCollectibles struct {
	Data    map[string]DestinyComponentsCollectiblesDestinyCollectiblesComponent `json:"data,omitempty"`
	Privacy int32                                                                `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

COMPONENT TYPE: Collectibles

type AllOfDestinyResponsesDestinyProfileResponseCharacterCraftables ¶

type AllOfDestinyResponsesDestinyProfileResponseCharacterCraftables struct {
	Data    map[string]DestinyComponentsCraftablesDestinyCraftablesComponent `json:"data,omitempty"`
	Privacy int32                                                            `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

COMPONENT TYPE: Craftables

type AllOfDestinyResponsesDestinyProfileResponseCharacterCurrencyLookups ¶

type AllOfDestinyResponsesDestinyProfileResponseCharacterCurrencyLookups struct {
	Data    map[string]DestinyComponentsInventoryDestinyCurrenciesComponent `json:"data,omitempty"`
	Privacy int32                                                           `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

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

type AllOfDestinyResponsesDestinyProfileResponseCharacterEquipment ¶

type AllOfDestinyResponsesDestinyProfileResponseCharacterEquipment struct {
	Data    map[string]DestinyEntitiesInventoryDestinyInventoryComponent `json:"data,omitempty"`
	Privacy int32                                                        `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

The character's equipped items, keyed by the Character's Id. COMPONENT TYPE: CharacterEquipment

type AllOfDestinyResponsesDestinyProfileResponseCharacterInventories ¶

type AllOfDestinyResponsesDestinyProfileResponseCharacterInventories struct {
	Data    map[string]DestinyEntitiesInventoryDestinyInventoryComponent `json:"data,omitempty"`
	Privacy int32                                                        `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

The character-level non-equipped inventory items, keyed by the Character's Id. COMPONENT TYPE: CharacterInventories

type AllOfDestinyResponsesDestinyProfileResponseCharacterKiosks ¶

type AllOfDestinyResponsesDestinyProfileResponseCharacterKiosks struct {
	Data    map[string]DestinyComponentsKiosksDestinyKiosksComponent `json:"data,omitempty"`
	Privacy int32                                                    `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

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

type AllOfDestinyResponsesDestinyProfileResponseCharacterLoadouts ¶

type AllOfDestinyResponsesDestinyProfileResponseCharacterLoadouts struct {
	Data    map[string]DestinyComponentsLoadoutsDestinyLoadoutsComponent `json:"data,omitempty"`
	Privacy int32                                                        `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

The character loadouts, keyed by the Character's Id. COMPONENT TYPE: CharacterLoadouts

type AllOfDestinyResponsesDestinyProfileResponseCharacterPlugSets ¶

type AllOfDestinyResponsesDestinyProfileResponseCharacterPlugSets struct {
	Data    map[string]DestinyComponentsPlugSetsDestinyPlugSetsComponent `json:"data,omitempty"`
	Privacy int32                                                        `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

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

type AllOfDestinyResponsesDestinyProfileResponseCharacterPresentationNodes ¶

type AllOfDestinyResponsesDestinyProfileResponseCharacterPresentationNodes struct {
	Data    map[string]DestinyComponentsPresentationDestinyPresentationNodesComponent `json:"data,omitempty"`
	Privacy int32                                                                     `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

COMPONENT TYPE: PresentationNodes

type AllOfDestinyResponsesDestinyProfileResponseCharacterProgressions ¶

type AllOfDestinyResponsesDestinyProfileResponseCharacterProgressions struct {
	Data    map[string]DestinyEntitiesCharactersDestinyCharacterProgressionComponent `json:"data,omitempty"`
	Privacy int32                                                                    `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

Character-level progression data, keyed by the Character's Id. COMPONENT TYPE: CharacterProgressions

type AllOfDestinyResponsesDestinyProfileResponseCharacterRecords ¶

type AllOfDestinyResponsesDestinyProfileResponseCharacterRecords struct {
	Data    map[string]DestinyComponentsRecordsDestinyCharacterRecordsComponent `json:"data,omitempty"`
	Privacy int32                                                               `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

COMPONENT TYPE: Records

type AllOfDestinyResponsesDestinyProfileResponseCharacterRenderData ¶

type AllOfDestinyResponsesDestinyProfileResponseCharacterRenderData struct {
	Data    map[string]DestinyEntitiesCharactersDestinyCharacterRenderComponent `json:"data,omitempty"`
	Privacy int32                                                               `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

Character rendering data - a minimal set of info needed to render a character in 3D - keyed by the Character's Id. COMPONENT TYPE: CharacterRenderData

type AllOfDestinyResponsesDestinyProfileResponseCharacterStringVariables ¶

type AllOfDestinyResponsesDestinyProfileResponseCharacterStringVariables struct {
	Data    map[string]DestinyComponentsStringVariablesDestinyStringVariablesComponent `json:"data,omitempty"`
	Privacy int32                                                                      `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

COMPONENT TYPE: StringVariables

type AllOfDestinyResponsesDestinyProfileResponseCharacters ¶

type AllOfDestinyResponsesDestinyProfileResponseCharacters struct {
	Data    map[string]DestinyEntitiesCharactersDestinyCharacterComponent `json:"data,omitempty"`
	Privacy int32                                                         `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

Basic information about each character, keyed by the CharacterId. COMPONENT TYPE: Characters

type AllOfDestinyResponsesDestinyProfileResponseItemComponents ¶

type AllOfDestinyResponsesDestinyProfileResponseItemComponents struct {
	Instances      *DictionaryComponentResponseOfint64AndDestinyItemInstanceComponent       `json:"instances,omitempty"`
	RenderData     *DictionaryComponentResponseOfint64AndDestinyItemRenderComponent         `json:"renderData,omitempty"`
	Stats          *DictionaryComponentResponseOfint64AndDestinyItemStatsComponent          `json:"stats,omitempty"`
	Sockets        *DictionaryComponentResponseOfint64AndDestinyItemSocketsComponent        `json:"sockets,omitempty"`
	ReusablePlugs  *DictionaryComponentResponseOfint64AndDestinyItemReusablePlugsComponent  `json:"reusablePlugs,omitempty"`
	PlugObjectives *DictionaryComponentResponseOfint64AndDestinyItemPlugObjectivesComponent `json:"plugObjectives,omitempty"`
	TalentGrids    *DictionaryComponentResponseOfint64AndDestinyItemTalentGridComponent     `json:"talentGrids,omitempty"`
	PlugStates     *DictionaryComponentResponseOfuint32AndDestinyItemPlugComponent          `json:"plugStates,omitempty"`
	Objectives     *DictionaryComponentResponseOfint64AndDestinyItemObjectivesComponent     `json:"objectives,omitempty"`
	Perks          *DictionaryComponentResponseOfint64AndDestinyItemPerksComponent          `json:"perks,omitempty"`
}

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.]

type AllOfDestinyResponsesDestinyProfileResponseMetrics ¶

type AllOfDestinyResponsesDestinyProfileResponseMetrics struct {
	Data    *DestinyComponentsMetricsDestinyMetricsComponent `json:"data,omitempty"`
	Privacy int32                                            `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

COMPONENT TYPE: Metrics

type AllOfDestinyResponsesDestinyProfileResponsePlatformSilver ¶

type AllOfDestinyResponsesDestinyProfileResponsePlatformSilver struct {
	Data    *DestinyComponentsInventoryDestinyPlatformSilverComponent `json:"data,omitempty"`
	Privacy int32                                                     `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

Silver quantities for any platform on which this Profile plays destiny. COMPONENT TYPE: PlatformSilver

type AllOfDestinyResponsesDestinyProfileResponseProfile ¶

type AllOfDestinyResponsesDestinyProfileResponseProfile struct {
	Data    *DestinyEntitiesProfilesDestinyProfileComponent `json:"data,omitempty"`
	Privacy int32                                           `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

The basic information about the Destiny Profile (formerly \"Account\"). COMPONENT TYPE: Profiles

type AllOfDestinyResponsesDestinyProfileResponseProfileCollectibles ¶

type AllOfDestinyResponsesDestinyProfileResponseProfileCollectibles struct {
	Data    *DestinyComponentsCollectiblesDestinyProfileCollectiblesComponent `json:"data,omitempty"`
	Privacy int32                                                             `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

COMPONENT TYPE: Collectibles

type AllOfDestinyResponsesDestinyProfileResponseProfileCommendations ¶

type AllOfDestinyResponsesDestinyProfileResponseProfileCommendations struct {
	Data    *DestinyComponentsSocialDestinySocialCommendationsComponent `json:"data,omitempty"`
	Privacy int32                                                       `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

COMPONENT TYPE: SocialCommendations

type AllOfDestinyResponsesDestinyProfileResponseProfileCurrencies ¶

type AllOfDestinyResponsesDestinyProfileResponseProfileCurrencies struct {
	Data    *DestinyEntitiesInventoryDestinyInventoryComponent `json:"data,omitempty"`
	Privacy int32                                              `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

The profile-level currencies owned by the Destiny Profile. COMPONENT TYPE: ProfileCurrencies

type AllOfDestinyResponsesDestinyProfileResponseProfileInventory ¶

type AllOfDestinyResponsesDestinyProfileResponseProfileInventory struct {
	Data    *DestinyEntitiesInventoryDestinyInventoryComponent `json:"data,omitempty"`
	Privacy int32                                              `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

The profile-level inventory of the Destiny Profile. COMPONENT TYPE: ProfileInventories

type AllOfDestinyResponsesDestinyProfileResponseProfileKiosks ¶

type AllOfDestinyResponsesDestinyProfileResponseProfileKiosks struct {
	Data    *DestinyComponentsKiosksDestinyKiosksComponent `json:"data,omitempty"`
	Privacy int32                                          `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

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

type AllOfDestinyResponsesDestinyProfileResponseProfilePlugSets ¶

type AllOfDestinyResponsesDestinyProfileResponseProfilePlugSets struct {
	Data    *DestinyComponentsPlugSetsDestinyPlugSetsComponent `json:"data,omitempty"`
	Privacy int32                                              `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

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

type AllOfDestinyResponsesDestinyProfileResponseProfilePresentationNodes ¶

type AllOfDestinyResponsesDestinyProfileResponseProfilePresentationNodes struct {
	Data    *DestinyComponentsPresentationDestinyPresentationNodesComponent `json:"data,omitempty"`
	Privacy int32                                                           `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

COMPONENT TYPE: PresentationNodes

type AllOfDestinyResponsesDestinyProfileResponseProfileProgression ¶

type AllOfDestinyResponsesDestinyProfileResponseProfileProgression struct {
	Data    *DestinyComponentsProfilesDestinyProfileProgressionComponent `json:"data,omitempty"`
	Privacy int32                                                        `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

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

type AllOfDestinyResponsesDestinyProfileResponseProfileRecords ¶

type AllOfDestinyResponsesDestinyProfileResponseProfileRecords struct {
	Data    *DestinyComponentsRecordsDestinyProfileRecordsComponent `json:"data,omitempty"`
	Privacy int32                                                   `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

COMPONENT TYPE: Records

type AllOfDestinyResponsesDestinyProfileResponseProfileStringVariables ¶

type AllOfDestinyResponsesDestinyProfileResponseProfileStringVariables struct {
	Data    *DestinyComponentsStringVariablesDestinyStringVariablesComponent `json:"data,omitempty"`
	Privacy int32                                                            `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

COMPONENT TYPE: StringVariables

type AllOfDestinyResponsesDestinyProfileResponseProfileTransitoryData ¶

type AllOfDestinyResponsesDestinyProfileResponseProfileTransitoryData struct {
	Data    *DestinyComponentsProfilesDestinyProfileTransitoryComponent `json:"data,omitempty"`
	Privacy int32                                                       `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

COMPONENT TYPE: Transitory

type AllOfDestinyResponsesDestinyProfileResponseVendorReceipts ¶

type AllOfDestinyResponsesDestinyProfileResponseVendorReceipts struct {
	Data    *DestinyEntitiesProfilesDestinyVendorReceiptsComponent `json:"data,omitempty"`
	Privacy int32                                                  `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

Recent, refundable purchases you have made from vendors. When will you use it? Couldn't say... COMPONENT TYPE: VendorReceipts

type AllOfDestinyResponsesDestinyProfileUserInfoCardPlatformSilver ¶

type AllOfDestinyResponsesDestinyProfileUserInfoCardPlatformSilver struct {
	// If a Profile is played on multiple platforms, this is the silver they have for each platform, keyed by Membership Type.
	PlatformSilver map[string]DestinyEntitiesItemsDestinyItemComponent `json:"platformSilver,omitempty"`
}

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.

type AllOfDestinyResponsesDestinyPublicVendorsResponseCategories ¶

type AllOfDestinyResponsesDestinyPublicVendorsResponseCategories struct {
	Data    map[string]DestinyEntitiesVendorsDestinyVendorCategoriesComponent `json:"data,omitempty"`
	Privacy int32                                                             `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

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

type AllOfDestinyResponsesDestinyPublicVendorsResponseSales ¶

type AllOfDestinyResponsesDestinyPublicVendorsResponseSales struct {
	Data    map[string]DestinyResponsesPublicDestinyVendorSaleItemSetComponent `json:"data,omitempty"`
	Privacy int32                                                              `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

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

type AllOfDestinyResponsesDestinyPublicVendorsResponseStringVariables ¶

type AllOfDestinyResponsesDestinyPublicVendorsResponseStringVariables struct {
	Data    *DestinyComponentsStringVariablesDestinyStringVariablesComponent `json:"data,omitempty"`
	Privacy int32                                                            `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

A set of string variable values by hash for a public vendors context. COMPONENT TYPE: StringVariables

type AllOfDestinyResponsesDestinyPublicVendorsResponseVendorGroups ¶

type AllOfDestinyResponsesDestinyPublicVendorsResponseVendorGroups struct {
	Data    *DestinyComponentsVendorsDestinyVendorGroupComponent `json:"data,omitempty"`
	Privacy int32                                                `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

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

type AllOfDestinyResponsesDestinyPublicVendorsResponseVendors ¶

type AllOfDestinyResponsesDestinyPublicVendorsResponseVendors struct {
	Data    map[string]DestinyComponentsVendorsDestinyPublicVendorComponent `json:"data,omitempty"`
	Privacy int32                                                           `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

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

type AllOfDestinyResponsesDestinyVendorResponseCategories ¶

type AllOfDestinyResponsesDestinyVendorResponseCategories struct {
	Data    *DestinyEntitiesVendorsDestinyVendorCategoriesComponent `json:"data,omitempty"`
	Privacy int32                                                   `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

Categories that the vendor has available, and references to the sales therein. COMPONENT TYPE: VendorCategories

type AllOfDestinyResponsesDestinyVendorResponseCurrencyLookups ¶

type AllOfDestinyResponsesDestinyVendorResponseCurrencyLookups struct {
	Data    *DestinyComponentsInventoryDestinyCurrenciesComponent `json:"data,omitempty"`
	Privacy int32                                                 `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

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

type AllOfDestinyResponsesDestinyVendorResponseItemComponents ¶

type AllOfDestinyResponsesDestinyVendorResponseItemComponents struct {
	Instances      *DictionaryComponentResponseOfint32AndDestinyItemInstanceComponent       `json:"instances,omitempty"`
	RenderData     *DictionaryComponentResponseOfint32AndDestinyItemRenderComponent         `json:"renderData,omitempty"`
	Stats          *DictionaryComponentResponseOfint32AndDestinyItemStatsComponent          `json:"stats,omitempty"`
	Sockets        *DictionaryComponentResponseOfint32AndDestinyItemSocketsComponent        `json:"sockets,omitempty"`
	ReusablePlugs  *DictionaryComponentResponseOfint32AndDestinyItemReusablePlugsComponent  `json:"reusablePlugs,omitempty"`
	PlugObjectives *DictionaryComponentResponseOfint32AndDestinyItemPlugObjectivesComponent `json:"plugObjectives,omitempty"`
	TalentGrids    *DictionaryComponentResponseOfint32AndDestinyItemTalentGridComponent     `json:"talentGrids,omitempty"`
	PlugStates     *DictionaryComponentResponseOfuint32AndDestinyItemPlugComponent          `json:"plugStates,omitempty"`
	Objectives     *DictionaryComponentResponseOfint32AndDestinyItemObjectivesComponent     `json:"objectives,omitempty"`
	Perks          *DictionaryComponentResponseOfint32AndDestinyItemPerksComponent          `json:"perks,omitempty"`
}

Item components, keyed by the vendorItemIndex of the active sale items. COMPONENT TYPE: [See inside the DestinyItemComponentSet contract for component types.]

type AllOfDestinyResponsesDestinyVendorResponseSales ¶

type AllOfDestinyResponsesDestinyVendorResponseSales struct {
	Data    map[string]DestinyEntitiesVendorsDestinyVendorSaleItemComponent `json:"data,omitempty"`
	Privacy int32                                                           `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

Sales, keyed by the vendorItemIndex of the item being sold. COMPONENT TYPE: VendorSales

type AllOfDestinyResponsesDestinyVendorResponseStringVariables ¶

type AllOfDestinyResponsesDestinyVendorResponseStringVariables struct {
	Data    *DestinyComponentsStringVariablesDestinyStringVariablesComponent `json:"data,omitempty"`
	Privacy int32                                                            `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

A map of string variable values by hash for this character context. COMPONENT TYPE: StringVariables

type AllOfDestinyResponsesDestinyVendorResponseVendor ¶

type AllOfDestinyResponsesDestinyVendorResponseVendor struct {
	Data    *DestinyEntitiesVendorsDestinyVendorComponent `json:"data,omitempty"`
	Privacy int32                                         `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

The base properties of the vendor. COMPONENT TYPE: Vendors

type AllOfDestinyResponsesDestinyVendorsResponseCategories ¶

type AllOfDestinyResponsesDestinyVendorsResponseCategories struct {
	Data    map[string]DestinyEntitiesVendorsDestinyVendorCategoriesComponent `json:"data,omitempty"`
	Privacy int32                                                             `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

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

type AllOfDestinyResponsesDestinyVendorsResponseCurrencyLookups ¶

type AllOfDestinyResponsesDestinyVendorsResponseCurrencyLookups struct {
	Data    *DestinyComponentsInventoryDestinyCurrenciesComponent `json:"data,omitempty"`
	Privacy int32                                                 `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

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

type AllOfDestinyResponsesDestinyVendorsResponseSales ¶

type AllOfDestinyResponsesDestinyVendorsResponseSales struct {
	Data    map[string]DestinyResponsesPersonalDestinyVendorSaleItemSetComponent `json:"data,omitempty"`
	Privacy int32                                                                `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

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

type AllOfDestinyResponsesDestinyVendorsResponseStringVariables ¶

type AllOfDestinyResponsesDestinyVendorsResponseStringVariables struct {
	Data    *DestinyComponentsStringVariablesDestinyStringVariablesComponent `json:"data,omitempty"`
	Privacy int32                                                            `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

A map of string variable values by hash for this character context. COMPONENT TYPE: StringVariables

type AllOfDestinyResponsesDestinyVendorsResponseVendorGroups ¶

type AllOfDestinyResponsesDestinyVendorsResponseVendorGroups struct {
	Data    *DestinyComponentsVendorsDestinyVendorGroupComponent `json:"data,omitempty"`
	Privacy int32                                                `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

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

type AllOfDestinyResponsesDestinyVendorsResponseVendors ¶

type AllOfDestinyResponsesDestinyVendorsResponseVendors struct {
	Data    map[string]DestinyEntitiesVendorsDestinyVendorComponent `json:"data,omitempty"`
	Privacy int32                                                   `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

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

type AllOfDestinyVendorsDestinyVendorReceiptItemReceived ¶

type AllOfDestinyVendorsDestinyVendorReceiptItemReceived struct {
	// The hash identifier for the item in question. Use it to look up the item's DestinyInventoryItemDefinition.
	ItemHash int32 `json:"itemHash,omitempty"`
	// If this quantity is referring to a specific instance of an item, this will have the item's instance ID. Normally, this will be null.
	ItemInstanceId int64 `json:"itemInstanceId,omitempty"`
	// The amount of the item needed/available depending on the context of where DestinyItemQuantity is being used.
	Quantity int32 `json:"quantity,omitempty"`
	// Indicates that this item quantity may be conditionally shown or hidden, based on various sources of state. For example: server flags, account state, or character progress.
	HasConditionalVisibility bool `json:"hasConditionalVisibility,omitempty"`
}

The item that was received, and its quantity.

type AllOfTrendingTrendingEntryDestinyRitualEventContent ¶

type AllOfTrendingTrendingEntryDestinyRitualEventContent struct {
	// The \"About this Milestone\" text from the Firehose.
	About string `json:"about,omitempty"`
	// The Current Status of the Milestone, as driven by the Firehose.
	Status string `json:"status,omitempty"`
	// A list of tips, provided by the Firehose.
	Tips []string `json:"tips,omitempty"`
	// If DPS has defined items related to this Milestone, they can categorize those items in the Firehose. That data will then be returned as item categories here.
	ItemCategories []DestinyMilestonesDestinyMilestoneContentItemCategory `json:"itemCategories,omitempty"`
}

A destiny event will not necessarily have milestone \"custom content\", but if it does the details will be here.

type AllOfTrendingTrendingEntryDestinyRitualMilestoneDetails ¶

type AllOfTrendingTrendingEntryDestinyRitualMilestoneDetails struct {
	// The hash identifier for the milestone. Use it to look up the DestinyMilestoneDefinition for static data about the Milestone.
	MilestoneHash int32 `json:"milestoneHash,omitempty"`
	// A milestone not need have even a single quest, but if there are active quests they will be returned here.
	AvailableQuests []DestinyMilestonesDestinyPublicMilestoneQuest             `json:"availableQuests,omitempty"`
	Activities      []DestinyMilestonesDestinyPublicMilestoneChallengeActivity `json:"activities,omitempty"`
	// Sometimes milestones - or activities active in milestones - will have relevant vendors. These are the vendors that are currently relevant.  Deprecated, already, for the sake of the new \"vendors\" property that has more data. What was I thinking.
	VendorHashes []int32 `json:"vendorHashes,omitempty"`
	// This is why we can't have nice things. This is the ordered list of vendors to be shown that relate to this milestone, potentially along with other interesting data.
	Vendors []DestinyMilestonesDestinyPublicMilestoneVendor `json:"vendors,omitempty"`
	// If known, this is the date when the Milestone started/became active.
	StartDate time.Time `json:"startDate,omitempty"`
	// If known, this is the date when the Milestone will expire/recycle/end.
	EndDate time.Time `json:"endDate,omitempty"`
	// Used for ordering milestones in a display to match how we order them in BNet. May pull from static data, or possibly in the future from dynamic information.
	Order int32 `json:"order,omitempty"`
}

A destiny event does not necessarily have a related Milestone, but if it does the details will be returned here.

type AppApiAppGetApplicationApiUsageOpts ¶

type AppApiAppGetApplicationApiUsageOpts struct {
	End   optional.Time
	Start optional.Time
}

type AppApiService ¶

type AppApiService service

func (*AppApiService) AppGetApplicationApiUsage ¶

func (a *AppApiService) AppGetApplicationApiUsage(ctx context.Context, applicationId int32, localVarOptionals *AppApiAppGetApplicationApiUsageOpts) (*http.Response, error)

func (*AppApiService) AppGetBungieApplications ¶

func (a *AppApiService) AppGetBungieApplications(ctx context.Context) (*http.Response, error)

AppApiService Get list of applications created by Bungie.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

type ApplicationsApiUsage ¶

type ApplicationsApiUsage struct {
	// Counts for on API calls made for the time range.
	ApiCalls []ApplicationsSeries `json:"apiCalls,omitempty"`
	// Instances of blocked requests or requests that crossed the warn threshold during the time range.
	ThrottledRequests []ApplicationsSeries `json:"throttledRequests,omitempty"`
}

type ApplicationsApplication ¶

type ApplicationsApplication struct {
	// Unique ID assigned to the application
	ApplicationId int32 `json:"applicationId,omitempty"`
	// Name of the application
	Name string `json:"name,omitempty"`
	// URL used to pass the user's authorization code to the application
	RedirectUrl string `json:"redirectUrl,omitempty"`
	// Link to website for the application where a user can learn more about the app.
	Link string `json:"link,omitempty"`
	// Permissions the application needs to work
	Scope int64 `json:"scope,omitempty"`
	// Value of the Origin header sent in requests generated by this application.
	Origin string `json:"origin,omitempty"`
	// Current status of the application.
	Status int32 `json:"status,omitempty"`
	// Date the application was first added to our database.
	CreationDate time.Time `json:"creationDate,omitempty"`
	// Date the application status last changed.
	StatusChanged time.Time `json:"statusChanged,omitempty"`
	// Date the first time the application status entered the 'Public' status.
	FirstPublished time.Time `json:"firstPublished,omitempty"`
	// List of team members who manage this application on Bungie.net. Will always consist of at least the application owner.
	Team []ApplicationsApplicationDeveloper `json:"team,omitempty"`
	// An optional override for the Authorize view name.
	OverrideAuthorizeViewName string `json:"overrideAuthorizeViewName,omitempty"`
}

type ApplicationsApplicationDeveloper ¶

type ApplicationsApplicationDeveloper struct {
	Role           int32             `json:"role,omitempty"`
	ApiEulaVersion int32             `json:"apiEulaVersion,omitempty"`
	User           *UserUserInfoCard `json:"user,omitempty"`
}

type ApplicationsApplicationScopes ¶

type ApplicationsApplicationScopes int64

type ApplicationsApplicationStatus ¶

type ApplicationsApplicationStatus int32

type ApplicationsDatapoint ¶

type ApplicationsDatapoint struct {
	// Timestamp for the related count.
	Time time.Time `json:"time,omitempty"`
	// Count associated with timestamp
	Count float64 `json:"count,omitempty"`
}

type ApplicationsDeveloperRole ¶

type ApplicationsDeveloperRole int32

type ApplicationsSeries ¶

type ApplicationsSeries struct {
	// Collection of samples with time and value.
	Datapoints []ApplicationsDatapoint `json:"datapoints,omitempty"`
	// Target to which to datapoints apply.
	Target string `json:"target,omitempty"`
}

type BasicAuth ¶

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BungieCredentialType ¶

type BungieCredentialType int32

BungieCredentialType : The types of credentials the Accounts system supports. This is the external facing enum used in place of the internal-only Bungie.SharedDefinitions.CredentialType.

type BungieResponse ¶

type BungieResponse[T any] struct {
	Response           *T                `json:"Response,omitempty"`
	ErrorCode          int32             `json:"ErrorCode,omitempty"`
	ThrottleSeconds    int32             `json:"ThrottleSeconds,omitempty"`
	ErrorStatus        string            `json:"ErrorStatus,omitempty"`
	Message            string            `json:"Message,omitempty"`
	MessageData        map[string]string `json:"MessageData,omitempty"`
	DetailedErrorTrace string            `json:"DetailedErrorTrace,omitempty"`
}

type CommonModelsCoreSetting ¶

type CommonModelsCoreSetting struct {
	Identifier    string                    `json:"identifier,omitempty"`
	IsDefault     bool                      `json:"isDefault,omitempty"`
	DisplayName   string                    `json:"displayName,omitempty"`
	Summary       string                    `json:"summary,omitempty"`
	ImagePath     string                    `json:"imagePath,omitempty"`
	ChildSettings []CommonModelsCoreSetting `json:"childSettings,omitempty"`
}

type CommonModelsCoreSettingsConfiguration ¶

type CommonModelsCoreSettingsConfiguration struct {
	Environment                    string                            `json:"environment,omitempty"`
	Systems                        map[string]CommonModelsCoreSystem `json:"systems,omitempty"`
	IgnoreReasons                  []CommonModelsCoreSetting         `json:"ignoreReasons,omitempty"`
	ForumCategories                []CommonModelsCoreSetting         `json:"forumCategories,omitempty"`
	GroupAvatars                   []CommonModelsCoreSetting         `json:"groupAvatars,omitempty"`
	DefaultGroupTheme              *CommonModelsCoreSetting          `json:"defaultGroupTheme,omitempty"`
	DestinyMembershipTypes         []CommonModelsCoreSetting         `json:"destinyMembershipTypes,omitempty"`
	RecruitmentPlatformTags        []CommonModelsCoreSetting         `json:"recruitmentPlatformTags,omitempty"`
	RecruitmentMiscTags            []CommonModelsCoreSetting         `json:"recruitmentMiscTags,omitempty"`
	RecruitmentActivities          []CommonModelsCoreSetting         `json:"recruitmentActivities,omitempty"`
	UserContentLocales             []CommonModelsCoreSetting         `json:"userContentLocales,omitempty"`
	SystemContentLocales           []CommonModelsCoreSetting         `json:"systemContentLocales,omitempty"`
	ClanBannerDecals               []CommonModelsCoreSetting         `json:"clanBannerDecals,omitempty"`
	ClanBannerDecalColors          []CommonModelsCoreSetting         `json:"clanBannerDecalColors,omitempty"`
	ClanBannerGonfalons            []CommonModelsCoreSetting         `json:"clanBannerGonfalons,omitempty"`
	ClanBannerGonfalonColors       []CommonModelsCoreSetting         `json:"clanBannerGonfalonColors,omitempty"`
	ClanBannerGonfalonDetails      []CommonModelsCoreSetting         `json:"clanBannerGonfalonDetails,omitempty"`
	ClanBannerGonfalonDetailColors []CommonModelsCoreSetting         `json:"clanBannerGonfalonDetailColors,omitempty"`
	ClanBannerStandards            []CommonModelsCoreSetting         `json:"clanBannerStandards,omitempty"`
	Destiny2CoreSettings           *CommonModelsDestiny2CoreSettings `json:"destiny2CoreSettings,omitempty"`
	EmailSettings                  *UserEmailSettings                `json:"emailSettings,omitempty"`
	FireteamActivities             []CommonModelsCoreSetting         `json:"fireteamActivities,omitempty"`
}

type CommonModelsCoreSystem ¶

type CommonModelsCoreSystem struct {
	Enabled    bool              `json:"enabled,omitempty"`
	Parameters map[string]string `json:"parameters,omitempty"`
}

type CommonModelsDestiny2CoreSettings ¶

type CommonModelsDestiny2CoreSettings struct {
	CollectionRootNode                     int32   `json:"collectionRootNode,omitempty"`
	BadgesRootNode                         int32   `json:"badgesRootNode,omitempty"`
	RecordsRootNode                        int32   `json:"recordsRootNode,omitempty"`
	MedalsRootNode                         int32   `json:"medalsRootNode,omitempty"`
	MetricsRootNode                        int32   `json:"metricsRootNode,omitempty"`
	ActiveTriumphsRootNodeHash             int32   `json:"activeTriumphsRootNodeHash,omitempty"`
	ActiveSealsRootNodeHash                int32   `json:"activeSealsRootNodeHash,omitempty"`
	LegacyTriumphsRootNodeHash             int32   `json:"legacyTriumphsRootNodeHash,omitempty"`
	LegacySealsRootNodeHash                int32   `json:"legacySealsRootNodeHash,omitempty"`
	MedalsRootNodeHash                     int32   `json:"medalsRootNodeHash,omitempty"`
	ExoticCatalystsRootNodeHash            int32   `json:"exoticCatalystsRootNodeHash,omitempty"`
	LoreRootNodeHash                       int32   `json:"loreRootNodeHash,omitempty"`
	CraftingRootNodeHash                   int32   `json:"craftingRootNodeHash,omitempty"`
	LoadoutConstantsHash                   int32   `json:"loadoutConstantsHash,omitempty"`
	GuardianRankConstantsHash              int32   `json:"guardianRankConstantsHash,omitempty"`
	GuardianRanksRootNodeHash              int32   `json:"guardianRanksRootNodeHash,omitempty"`
	CurrentRankProgressionHashes           []int32 `json:"currentRankProgressionHashes,omitempty"`
	InsertPlugFreeProtectedPlugItemHashes  []int32 `json:"insertPlugFreeProtectedPlugItemHashes,omitempty"`
	InsertPlugFreeBlockedSocketTypeHashes  []int32 `json:"insertPlugFreeBlockedSocketTypeHashes,omitempty"`
	UndiscoveredCollectibleImage           string  `json:"undiscoveredCollectibleImage,omitempty"`
	AmmoTypeHeavyIcon                      string  `json:"ammoTypeHeavyIcon,omitempty"`
	AmmoTypeSpecialIcon                    string  `json:"ammoTypeSpecialIcon,omitempty"`
	AmmoTypePrimaryIcon                    string  `json:"ammoTypePrimaryIcon,omitempty"`
	CurrentSeasonalArtifactHash            int32   `json:"currentSeasonalArtifactHash,omitempty"`
	CurrentSeasonHash                      int32   `json:"currentSeasonHash,omitempty"`
	SeasonalChallengesPresentationNodeHash int32   `json:"seasonalChallengesPresentationNodeHash,omitempty"`
	FutureSeasonHashes                     []int32 `json:"futureSeasonHashes,omitempty"`
	PastSeasonHashes                       []int32 `json:"pastSeasonHashes,omitempty"`
}

type CommunityContentApiService ¶

type CommunityContentApiService service

func (*CommunityContentApiService) CommunityContentGetCommunityContent ¶

func (a *CommunityContentApiService) CommunityContentGetCommunityContent(ctx context.Context, mediaFilter int32, page int32, sort int32) (*http.Response, error)

CommunityContentApiService Returns community content.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param mediaFilter The type of media to get
@param page Zero based page
@param sort The sort mode.

type ComponentsComponentPrivacySetting ¶

type ComponentsComponentPrivacySetting int32

ComponentsComponentPrivacySetting : A set of flags for reason(s) why the component populated in the way that it did. Inspect the individual flags for the reasons.

type ComponentsComponentResponse ¶

type ComponentsComponentResponse struct {
	Privacy int32 `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

The base class for any component-returning object that may need to indicate information about the state of the component being returned.

type ConfigClanBannerClanBannerDecal ¶

type ConfigClanBannerClanBannerDecal struct {
	Identifier     string `json:"identifier,omitempty"`
	ForegroundPath string `json:"foregroundPath,omitempty"`
	BackgroundPath string `json:"backgroundPath,omitempty"`
}

type ConfigClanBannerClanBannerSource ¶

type ConfigClanBannerClanBannerSource struct {
}

type ConfigGroupTheme ¶

type ConfigGroupTheme struct {
	Name        string `json:"name,omitempty"`
	Folder      string `json:"folder,omitempty"`
	Description string `json:"description,omitempty"`
}

type ConfigUserTheme ¶

type ConfigUserTheme struct {
	UserThemeId          int32  `json:"userThemeId,omitempty"`
	UserThemeName        string `json:"userThemeName,omitempty"`
	UserThemeDescription string `json:"userThemeDescription,omitempty"`
}

type Configuration ¶

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

type ContentApiContentGetContentByIdOpts ¶

type ContentApiContentGetContentByIdOpts struct {
	Head optional.Bool
}

type ContentApiContentGetContentByTagAndTypeOpts ¶

type ContentApiContentGetContentByTagAndTypeOpts struct {
	Head optional.Bool
}

type ContentApiContentRssNewsArticlesOpts ¶

type ContentApiContentRssNewsArticlesOpts struct {
	Categoryfilter optional.String
	Includebody    optional.Bool
}

type ContentApiContentSearchContentByTagAndTypeOpts ¶

type ContentApiContentSearchContentByTagAndTypeOpts struct {
	Currentpage  optional.Int32
	Head         optional.Bool
	Itemsperpage optional.Int32
}

type ContentApiContentSearchContentWithTextOpts ¶

type ContentApiContentSearchContentWithTextOpts struct {
	Ctype       optional.String
	Currentpage optional.Int32
	Head        optional.Bool
	Searchtext  optional.String
	Source      optional.String
	Tag         optional.String
}

type ContentApiService ¶

type ContentApiService service

func (*ContentApiService) ContentGetContentById ¶

func (a *ContentApiService) ContentGetContentById(ctx context.Context, id int64, locale string, localVarOptionals *ContentApiContentGetContentByIdOpts) (*http.Response, error)

func (*ContentApiService) ContentGetContentByTagAndType ¶

func (a *ContentApiService) ContentGetContentByTagAndType(ctx context.Context, locale string, tag string, type_ string, localVarOptionals *ContentApiContentGetContentByTagAndTypeOpts) (*http.Response, error)

func (*ContentApiService) ContentGetContentType ¶

func (a *ContentApiService) ContentGetContentType(ctx context.Context, type_ string) (*http.Response, error)

ContentApiService Gets an object describing a particular variant of content.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param type_

func (*ContentApiService) ContentRssNewsArticles ¶

func (a *ContentApiService) ContentRssNewsArticles(ctx context.Context, pageToken string, localVarOptionals *ContentApiContentRssNewsArticlesOpts) (*http.Response, error)

func (*ContentApiService) ContentSearchContentByTagAndType ¶

func (a *ContentApiService) ContentSearchContentByTagAndType(ctx context.Context, locale string, tag string, type_ string, localVarOptionals *ContentApiContentSearchContentByTagAndTypeOpts) (*http.Response, error)

func (*ContentApiService) ContentSearchContentWithText ¶

func (a *ContentApiService) ContentSearchContentWithText(ctx context.Context, locale string, localVarOptionals *ContentApiContentSearchContentWithTextOpts) (*http.Response, error)

func (*ContentApiService) ContentSearchHelpArticles ¶

func (a *ContentApiService) ContentSearchHelpArticles(ctx context.Context, searchtext string, size string) (*http.Response, error)

ContentApiService Search for Help Articles.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param searchtext
@param size

type ContentCommentSummary ¶

type ContentCommentSummary struct {
	TopicId      int64 `json:"topicId,omitempty"`
	CommentCount int32 `json:"commentCount,omitempty"`
}

type ContentContentItemPublicContract ¶

type ContentContentItemPublicContract struct {
	ContentId                   int64            `json:"contentId,omitempty"`
	CType                       string           `json:"cType,omitempty"`
	CmsPath                     string           `json:"cmsPath,omitempty"`
	CreationDate                time.Time        `json:"creationDate,omitempty"`
	ModifyDate                  time.Time        `json:"modifyDate,omitempty"`
	AllowComments               bool             `json:"allowComments,omitempty"`
	HasAgeGate                  bool             `json:"hasAgeGate,omitempty"`
	MinimumAge                  int32            `json:"minimumAge,omitempty"`
	RatingImagePath             string           `json:"ratingImagePath,omitempty"`
	Author                      *UserGeneralUser `json:"author,omitempty"`
	AutoEnglishPropertyFallback bool             `json:"autoEnglishPropertyFallback,omitempty"`
	// Firehose content is really a collection of metadata and \"properties\", which are the potentially-but-not-strictly localizable data that comprises the meat of whatever content is being shown.  As Cole Porter would have crooned, \"Anything Goes\" with Firehose properties. They are most often strings, but they can theoretically be anything. They are JSON encoded, and could be JSON structures, simple strings, numbers etc... The Content Type of the item (cType) will describe the properties, and thus how they ought to be deserialized.
	Properties      map[string]interface{}         `json:"properties,omitempty"`
	Representations []ContentContentRepresentation `json:"representations,omitempty"`
	// NOTE: Tags will always be lower case.
	Tags           []string               `json:"tags,omitempty"`
	CommentSummary *ContentCommentSummary `json:"commentSummary,omitempty"`
}

type ContentContentRepresentation ¶

type ContentContentRepresentation struct {
	Name             string `json:"name,omitempty"`
	Path             string `json:"path,omitempty"`
	ValidationString string `json:"validationString,omitempty"`
}

type ContentModelsContentPreview ¶

type ContentModelsContentPreview struct {
	Name       string `json:"name,omitempty"`
	Path       string `json:"path,omitempty"`
	ItemInSet  bool   `json:"itemInSet,omitempty"`
	SetTag     string `json:"setTag,omitempty"`
	SetNesting int32  `json:"setNesting,omitempty"`
	UseSetId   int32  `json:"useSetId,omitempty"`
}

type ContentModelsContentPropertyDataTypeEnum ¶

type ContentModelsContentPropertyDataTypeEnum int32

type ContentModelsContentTypeDefaultValue ¶

type ContentModelsContentTypeDefaultValue struct {
	WhenClause   string `json:"whenClause,omitempty"`
	WhenValue    string `json:"whenValue,omitempty"`
	DefaultValue string `json:"defaultValue,omitempty"`
}

type ContentModelsContentTypeDescription ¶

type ContentModelsContentTypeDescription struct {
	CType                       string                                    `json:"cType,omitempty"`
	Name                        string                                    `json:"name,omitempty"`
	ContentDescription          string                                    `json:"contentDescription,omitempty"`
	PreviewImage                string                                    `json:"previewImage,omitempty"`
	Priority                    int32                                     `json:"priority,omitempty"`
	Reminder                    string                                    `json:"reminder,omitempty"`
	Properties                  []ContentModelsContentTypeProperty        `json:"properties,omitempty"`
	TagMetadata                 []ContentModelsTagMetadataDefinition      `json:"tagMetadata,omitempty"`
	TagMetadataItems            map[string]ContentModelsTagMetadataItem   `json:"tagMetadataItems,omitempty"`
	UsageExamples               []string                                  `json:"usageExamples,omitempty"`
	ShowInContentEditor         bool                                      `json:"showInContentEditor,omitempty"`
	TypeOf                      string                                    `json:"typeOf,omitempty"`
	BindIdentifierToProperty    string                                    `json:"bindIdentifierToProperty,omitempty"`
	BoundRegex                  string                                    `json:"boundRegex,omitempty"`
	ForceIdentifierBinding      bool                                      `json:"forceIdentifierBinding,omitempty"`
	AllowComments               bool                                      `json:"allowComments,omitempty"`
	AutoEnglishPropertyFallback bool                                      `json:"autoEnglishPropertyFallback,omitempty"`
	BulkUploadable              bool                                      `json:"bulkUploadable,omitempty"`
	Previews                    []ContentModelsContentPreview             `json:"previews,omitempty"`
	SuppressCmsPath             bool                                      `json:"suppressCmsPath,omitempty"`
	PropertySections            []ContentModelsContentTypePropertySection `json:"propertySections,omitempty"`
}

type ContentModelsContentTypeProperty ¶

type ContentModelsContentTypeProperty struct {
	Name                           string                                 `json:"name,omitempty"`
	RootPropertyName               string                                 `json:"rootPropertyName,omitempty"`
	ReadableName                   string                                 `json:"readableName,omitempty"`
	Value                          string                                 `json:"value,omitempty"`
	PropertyDescription            string                                 `json:"propertyDescription,omitempty"`
	Localizable                    bool                                   `json:"localizable,omitempty"`
	Fallback                       bool                                   `json:"fallback,omitempty"`
	Enabled                        bool                                   `json:"enabled,omitempty"`
	Order                          int32                                  `json:"order,omitempty"`
	Visible                        bool                                   `json:"visible,omitempty"`
	IsTitle                        bool                                   `json:"isTitle,omitempty"`
	Required                       bool                                   `json:"required,omitempty"`
	MaxLength                      int32                                  `json:"maxLength,omitempty"`
	MaxByteLength                  int32                                  `json:"maxByteLength,omitempty"`
	MaxFileSize                    int32                                  `json:"maxFileSize,omitempty"`
	Regexp                         string                                 `json:"regexp,omitempty"`
	ValidateAs                     string                                 `json:"validateAs,omitempty"`
	RssAttribute                   string                                 `json:"rssAttribute,omitempty"`
	VisibleDependency              string                                 `json:"visibleDependency,omitempty"`
	VisibleOn                      string                                 `json:"visibleOn,omitempty"`
	Datatype                       int32                                  `json:"datatype,omitempty"`
	Attributes                     map[string]string                      `json:"attributes,omitempty"`
	ChildProperties                []ContentModelsContentTypeProperty     `json:"childProperties,omitempty"`
	ContentTypeAllowed             string                                 `json:"contentTypeAllowed,omitempty"`
	BindToProperty                 string                                 `json:"bindToProperty,omitempty"`
	BoundRegex                     string                                 `json:"boundRegex,omitempty"`
	RepresentationSelection        map[string]string                      `json:"representationSelection,omitempty"`
	DefaultValues                  []ContentModelsContentTypeDefaultValue `json:"defaultValues,omitempty"`
	IsExternalAllowed              bool                                   `json:"isExternalAllowed,omitempty"`
	PropertySection                string                                 `json:"propertySection,omitempty"`
	Weight                         int32                                  `json:"weight,omitempty"`
	Entitytype                     string                                 `json:"entitytype,omitempty"`
	IsCombo                        bool                                   `json:"isCombo,omitempty"`
	SuppressProperty               bool                                   `json:"suppressProperty,omitempty"`
	LegalContentTypes              []string                               `json:"legalContentTypes,omitempty"`
	RepresentationValidationString string                                 `json:"representationValidationString,omitempty"`
	MinWidth                       int32                                  `json:"minWidth,omitempty"`
	MaxWidth                       int32                                  `json:"maxWidth,omitempty"`
	MinHeight                      int32                                  `json:"minHeight,omitempty"`
	MaxHeight                      int32                                  `json:"maxHeight,omitempty"`
	IsVideo                        bool                                   `json:"isVideo,omitempty"`
	IsImage                        bool                                   `json:"isImage,omitempty"`
}

type ContentModelsContentTypePropertySection ¶

type ContentModelsContentTypePropertySection struct {
	Name         string `json:"name,omitempty"`
	ReadableName string `json:"readableName,omitempty"`
	Collapsed    bool   `json:"collapsed,omitempty"`
}

type ContentModelsTagMetadataDefinition ¶

type ContentModelsTagMetadataDefinition struct {
	Description string                         `json:"description,omitempty"`
	Order       int32                          `json:"order,omitempty"`
	Items       []ContentModelsTagMetadataItem `json:"items,omitempty"`
	Datatype    string                         `json:"datatype,omitempty"`
	Name        string                         `json:"name,omitempty"`
	IsRequired  bool                           `json:"isRequired,omitempty"`
}

type ContentModelsTagMetadataItem ¶

type ContentModelsTagMetadataItem struct {
	Description string   `json:"description,omitempty"`
	TagText     string   `json:"tagText,omitempty"`
	Groups      []string `json:"groups,omitempty"`
	IsDefault   bool     `json:"isDefault,omitempty"`
	Name        string   `json:"name,omitempty"`
}

type ContentNewsArticleRssItem ¶

type ContentNewsArticleRssItem struct {
	Title                   string    `json:"Title,omitempty"`
	Link                    string    `json:"Link,omitempty"`
	PubDate                 time.Time `json:"PubDate,omitempty"`
	UniqueIdentifier        string    `json:"UniqueIdentifier,omitempty"`
	Description             string    `json:"Description,omitempty"`
	HtmlContent             string    `json:"HtmlContent,omitempty"`
	ImagePath               string    `json:"ImagePath,omitempty"`
	OptionalMobileImagePath string    `json:"OptionalMobileImagePath,omitempty"`
}

type ContentNewsArticleRssResponse ¶

type ContentNewsArticleRssResponse struct {
	NewsArticles           []ContentNewsArticleRssItem `json:"NewsArticles,omitempty"`
	CurrentPaginationToken int32                       `json:"CurrentPaginationToken,omitempty"`
	NextPaginationToken    int32                       `json:"NextPaginationToken,omitempty"`
	ResultCountThisPage    int32                       `json:"ResultCountThisPage,omitempty"`
	CategoryFilter         string                      `json:"CategoryFilter,omitempty"`
}

type DatesDateRange ¶

type DatesDateRange struct {
	Start time.Time `json:"start,omitempty"`
	End   time.Time `json:"end,omitempty"`
}

type DefaultApiGetGlobalAlertsOpts ¶

type DefaultApiGetGlobalAlertsOpts struct {
	Includestreaming optional.Bool
}

type DefaultApiService ¶

type DefaultApiService service

func (*DefaultApiService) GetAvailableLocales ¶

func (a *DefaultApiService) GetAvailableLocales(ctx context.Context) (*http.Response, error)

DefaultApiService List of available localization cultures

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*DefaultApiService) GetCommonSettings ¶

func (a *DefaultApiService) GetCommonSettings(ctx context.Context) (*http.Response, error)

DefaultApiService Get the common settings used by the Bungie.Net environment.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*DefaultApiService) GetGlobalAlerts ¶

func (a *DefaultApiService) GetGlobalAlerts(ctx context.Context, localVarOptionals *DefaultApiGetGlobalAlertsOpts) (*http.Response, error)

func (*DefaultApiService) GetUserSystemOverrides ¶

func (a *DefaultApiService) GetUserSystemOverrides(ctx context.Context) (*http.Response, error)

DefaultApiService Get the user-specific system overrides that should be respected alongside common systems.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

type Destiny2ApiDestiny2GetActivityHistoryOpts ¶

type Destiny2ApiDestiny2GetActivityHistoryOpts struct {
	Count optional.Int32
	Mode  optional.Int32
	Page  optional.Int32
}

type Destiny2ApiDestiny2GetCharacterOpts ¶

type Destiny2ApiDestiny2GetCharacterOpts struct {
	Components optional.Interface
}

type Destiny2ApiDestiny2GetClanAggregateStatsOpts ¶

type Destiny2ApiDestiny2GetClanAggregateStatsOpts struct {
	Modes optional.String
}

type Destiny2ApiDestiny2GetClanLeaderboardsOpts ¶

type Destiny2ApiDestiny2GetClanLeaderboardsOpts struct {
	Maxtop optional.Int32
	Modes  optional.String
	Statid optional.String
}

type Destiny2ApiDestiny2GetCollectibleNodeDetailsOpts ¶

type Destiny2ApiDestiny2GetCollectibleNodeDetailsOpts struct {
	Components optional.Interface
}

type Destiny2ApiDestiny2GetHistoricalStatsForAccountOpts ¶

type Destiny2ApiDestiny2GetHistoricalStatsForAccountOpts struct {
	Groups optional.Interface
}

type Destiny2ApiDestiny2GetHistoricalStatsOpts ¶

type Destiny2ApiDestiny2GetHistoricalStatsOpts struct {
	Dayend     optional.Time
	Daystart   optional.Time
	Groups     optional.Interface
	Modes      optional.Interface
	PeriodType optional.Int32
}

type Destiny2ApiDestiny2GetItemOpts ¶

type Destiny2ApiDestiny2GetItemOpts struct {
	Components optional.Interface
}

type Destiny2ApiDestiny2GetLeaderboardsForCharacterOpts ¶

type Destiny2ApiDestiny2GetLeaderboardsForCharacterOpts struct {
	Maxtop optional.Int32
	Modes  optional.String
	Statid optional.String
}

type Destiny2ApiDestiny2GetLeaderboardsOpts ¶

type Destiny2ApiDestiny2GetLeaderboardsOpts struct {
	Maxtop optional.Int32
	Modes  optional.String
	Statid optional.String
}

type Destiny2ApiDestiny2GetLinkedProfilesOpts ¶

type Destiny2ApiDestiny2GetLinkedProfilesOpts struct {
	GetAllMemberships optional.Bool
}

type Destiny2ApiDestiny2GetProfileOpts ¶

type Destiny2ApiDestiny2GetProfileOpts struct {
	Components optional.Interface
}

type Destiny2ApiDestiny2GetPublicVendorsOpts ¶

type Destiny2ApiDestiny2GetPublicVendorsOpts struct {
	Components optional.Interface
}

type Destiny2ApiDestiny2GetVendorOpts ¶

type Destiny2ApiDestiny2GetVendorOpts struct {
	Components optional.Interface
}

type Destiny2ApiDestiny2GetVendorsOpts ¶

type Destiny2ApiDestiny2GetVendorsOpts struct {
	Components optional.Interface
	Filter     optional.Int32
}

type Destiny2ApiDestiny2SearchDestinyEntitiesOpts ¶

type Destiny2ApiDestiny2SearchDestinyEntitiesOpts struct {
	Page optional.Int32
}

type Destiny2ApiService ¶

type Destiny2ApiService service

func (*Destiny2ApiService) Destiny2AwaGetActionToken ¶

func (a *Destiny2ApiService) Destiny2AwaGetActionToken(ctx context.Context, correlationId string) (*http.Response, error)

Destiny2ApiService Returns the action token if user approves the request.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param correlationId The identifier for the advanced write action request.

func (*Destiny2ApiService) Destiny2AwaInitializeRequest ¶

func (a *Destiny2ApiService) Destiny2AwaInitializeRequest(ctx context.Context, body DestinyAdvancedAwaPermissionRequested) (*http.Response, error)

Destiny2ApiService Initialize a request to perform an advanced write action.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*Destiny2ApiService) Destiny2AwaProvideAuthorizationResult ¶

func (a *Destiny2ApiService) Destiny2AwaProvideAuthorizationResult(ctx context.Context, body DestinyAdvancedAwaUserResponse) (*http.Response, error)

Destiny2ApiService Provide the result of the user interaction. Called by the Bungie Destiny App to approve or reject a request.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*Destiny2ApiService) Destiny2ClearLoadout ¶

func (a *Destiny2ApiService) Destiny2ClearLoadout(ctx context.Context, body DestinyRequestsActionsDestinyLoadoutActionRequest) (*http.Response, error)

Destiny2ApiService Clear the identifiers and items of a loadout.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*Destiny2ApiService) Destiny2EquipItem ¶

func (a *Destiny2ApiService) Destiny2EquipItem(ctx context.Context, body DestinyRequestsActionsDestinyItemActionRequest) (*http.Response, error)

Destiny2ApiService Equip an item. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*Destiny2ApiService) Destiny2EquipItems ¶

func (a *Destiny2ApiService) Destiny2EquipItems(ctx context.Context, body DestinyRequestsActionsDestinyItemSetActionRequest) (*http.Response, error)

Destiny2ApiService Equip a list of items by itemInstanceIds. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline. Any items not found on your character will be ignored.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*Destiny2ApiService) Destiny2EquipLoadout ¶

func (a *Destiny2ApiService) Destiny2EquipLoadout(ctx context.Context, body DestinyRequestsActionsDestinyLoadoutActionRequest) (*http.Response, error)

Destiny2ApiService Equip a loadout. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*Destiny2ApiService) Destiny2GetActivityHistory ¶

func (a *Destiny2ApiService) Destiny2GetActivityHistory(ctx context.Context, characterId int64, destinyMembershipId int64, membershipType int32, localVarOptionals *Destiny2ApiDestiny2GetActivityHistoryOpts) (*http.Response, error)

func (*Destiny2ApiService) Destiny2GetCharacter ¶

func (a *Destiny2ApiService) Destiny2GetCharacter(ctx context.Context, characterId int64, destinyMembershipId int64, membershipType int32, localVarOptionals *Destiny2ApiDestiny2GetCharacterOpts) (*http.Response, error)

func (*Destiny2ApiService) Destiny2GetClanAggregateStats ¶

func (a *Destiny2ApiService) Destiny2GetClanAggregateStats(ctx context.Context, groupId int64, localVarOptionals *Destiny2ApiDestiny2GetClanAggregateStatsOpts) (*http.Response, error)

func (*Destiny2ApiService) Destiny2GetClanBannerSource ¶

func (a *Destiny2ApiService) Destiny2GetClanBannerSource(ctx context.Context) (*http.Response, error)

Destiny2ApiService Returns the dictionary of values for the Clan Banner

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*Destiny2ApiService) Destiny2GetClanLeaderboards ¶

func (a *Destiny2ApiService) Destiny2GetClanLeaderboards(ctx context.Context, groupId int64, localVarOptionals *Destiny2ApiDestiny2GetClanLeaderboardsOpts) (*http.Response, error)

func (*Destiny2ApiService) Destiny2GetClanWeeklyRewardState ¶

func (a *Destiny2ApiService) Destiny2GetClanWeeklyRewardState(ctx context.Context, groupId int64) (*http.Response, error)

Destiny2ApiService Returns information on the weekly clan rewards and if the clan has earned them or not. Note that this will always report rewards as not redeemed.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId A valid group id of clan.

func (*Destiny2ApiService) Destiny2GetCollectibleNodeDetails ¶

func (a *Destiny2ApiService) Destiny2GetCollectibleNodeDetails(ctx context.Context, characterId int64, collectiblePresentationNodeHash int32, destinyMembershipId int64, membershipType int32, localVarOptionals *Destiny2ApiDestiny2GetCollectibleNodeDetailsOpts) (*http.Response, error)

func (*Destiny2ApiService) Destiny2GetDestinyAggregateActivityStats ¶

func (a *Destiny2ApiService) Destiny2GetDestinyAggregateActivityStats(ctx context.Context, characterId int64, destinyMembershipId int64, membershipType int32) (*http.Response, error)

Destiny2ApiService Gets all activities the character has participated in together with aggregate statistics for those activities.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param characterId The specific character whose activities should be returned.
@param destinyMembershipId The Destiny membershipId of the user to retrieve.
@param membershipType A valid non-BungieNet membership type.

func (*Destiny2ApiService) Destiny2GetDestinyEntityDefinition ¶

func (a *Destiny2ApiService) Destiny2GetDestinyEntityDefinition(ctx context.Context, entityType string, hashIdentifier int32) (*http.Response, error)

Destiny2ApiService Returns the static definition of an entity of the given Type and hash identifier. Examine the API Documentation for the Type Names of entities that have their own definitions. Note that the return type will always *inherit from* DestinyDefinition, but the specific type returned will be the requested entity type if it can be found. Please don't use this as a chatty alternative to the Manifest database if you require large sets of data, but for simple and one-off accesses this should be handy.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param entityType The type of entity for whom you would like results. These correspond to the entity's definition contract name. For instance, if you are looking for items, this property should be 'DestinyInventoryItemDefinition'. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is tentatively in final form, but there may be bugs that prevent desirable operation.
@param hashIdentifier The hash identifier for the specific Entity you want returned.

func (*Destiny2ApiService) Destiny2GetDestinyManifest ¶

func (a *Destiny2ApiService) Destiny2GetDestinyManifest(ctx context.Context) (*http.Response, error)

Destiny2ApiService Returns the current version of the manifest as a json object.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*Destiny2ApiService) Destiny2GetHistoricalStats ¶

func (a *Destiny2ApiService) Destiny2GetHistoricalStats(ctx context.Context, characterId int64, destinyMembershipId int64, membershipType int32, localVarOptionals *Destiny2ApiDestiny2GetHistoricalStatsOpts) (*http.Response, error)

func (*Destiny2ApiService) Destiny2GetHistoricalStatsDefinition ¶

func (a *Destiny2ApiService) Destiny2GetHistoricalStatsDefinition(ctx context.Context) (*http.Response, error)

Destiny2ApiService Gets historical stats definitions.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*Destiny2ApiService) Destiny2GetHistoricalStatsForAccount ¶

func (a *Destiny2ApiService) Destiny2GetHistoricalStatsForAccount(ctx context.Context, destinyMembershipId int64, membershipType int32, localVarOptionals *Destiny2ApiDestiny2GetHistoricalStatsForAccountOpts) (*http.Response, error)

func (*Destiny2ApiService) Destiny2GetItem ¶

func (a *Destiny2ApiService) Destiny2GetItem(ctx context.Context, destinyMembershipId int64, itemInstanceId int64, membershipType int32, localVarOptionals *Destiny2ApiDestiny2GetItemOpts) (*http.Response, error)

func (*Destiny2ApiService) Destiny2GetLeaderboards ¶

func (a *Destiny2ApiService) Destiny2GetLeaderboards(ctx context.Context, destinyMembershipId int64, membershipType int32, localVarOptionals *Destiny2ApiDestiny2GetLeaderboardsOpts) (*http.Response, error)

func (*Destiny2ApiService) Destiny2GetLeaderboardsForCharacter ¶

func (a *Destiny2ApiService) Destiny2GetLeaderboardsForCharacter(ctx context.Context, characterId int64, destinyMembershipId int64, membershipType int32, localVarOptionals *Destiny2ApiDestiny2GetLeaderboardsForCharacterOpts) (*http.Response, error)

func (*Destiny2ApiService) Destiny2GetLinkedProfiles ¶

func (a *Destiny2ApiService) Destiny2GetLinkedProfiles(ctx context.Context, membershipId int64, membershipType int32, localVarOptionals *Destiny2ApiDestiny2GetLinkedProfilesOpts) (*http.Response, error)

func (*Destiny2ApiService) Destiny2GetPostGameCarnageReport ¶

func (a *Destiny2ApiService) Destiny2GetPostGameCarnageReport(ctx context.Context, activityId int64) (*http.Response, error)

Destiny2ApiService Gets the available post game carnage report for the activity ID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param activityId The ID of the activity whose PGCR is requested.

func (*Destiny2ApiService) Destiny2GetProfile ¶

func (a *Destiny2ApiService) Destiny2GetProfile(ctx context.Context, destinyMembershipId int64, membershipType int32, localVarOptionals *Destiny2ApiDestiny2GetProfileOpts) (*http.Response, error)

func (*Destiny2ApiService) Destiny2GetPublicMilestoneContent ¶

func (a *Destiny2ApiService) Destiny2GetPublicMilestoneContent(ctx context.Context, milestoneHash int32) (*http.Response, error)

Destiny2ApiService Gets custom localized content for the milestone of the given hash, if it exists.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param milestoneHash The identifier for the milestone to be returned.

func (*Destiny2ApiService) Destiny2GetPublicMilestones ¶

func (a *Destiny2ApiService) Destiny2GetPublicMilestones(ctx context.Context) (*http.Response, error)

Destiny2ApiService Gets public information about currently available Milestones.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*Destiny2ApiService) Destiny2GetPublicVendors ¶

func (a *Destiny2ApiService) Destiny2GetPublicVendors(ctx context.Context, localVarOptionals *Destiny2ApiDestiny2GetPublicVendorsOpts) (*http.Response, error)

func (*Destiny2ApiService) Destiny2GetUniqueWeaponHistory ¶

func (a *Destiny2ApiService) Destiny2GetUniqueWeaponHistory(ctx context.Context, characterId int64, destinyMembershipId int64, membershipType int32) (*http.Response, error)

Destiny2ApiService Gets details about unique weapon usage, including all exotic weapons.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param characterId The id of the character to retrieve.
@param destinyMembershipId The Destiny membershipId of the user to retrieve.
@param membershipType A valid non-BungieNet membership type.

func (*Destiny2ApiService) Destiny2GetVendor ¶

func (a *Destiny2ApiService) Destiny2GetVendor(ctx context.Context, characterId int64, destinyMembershipId int64, membershipType int32, vendorHash int32, localVarOptionals *Destiny2ApiDestiny2GetVendorOpts) (*http.Response, error)

func (*Destiny2ApiService) Destiny2GetVendors ¶

func (a *Destiny2ApiService) Destiny2GetVendors(ctx context.Context, characterId int64, destinyMembershipId int64, membershipType int32, localVarOptionals *Destiny2ApiDestiny2GetVendorsOpts) (*http.Response, error)

func (*Destiny2ApiService) Destiny2InsertSocketPlug ¶

func (a *Destiny2ApiService) Destiny2InsertSocketPlug(ctx context.Context, body DestinyRequestsActionsDestinyInsertPlugsActionRequest) (*http.Response, error)

Destiny2ApiService Insert a plug into a socketed item. I know how it sounds, but I assure you it's much more G-rated than you might be guessing. We haven't decided yet whether this will be able to insert plugs that have side effects, but if we do it will require special scope permission for an application attempting to do so. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline. Request must include proof of permission for 'InsertPlugs' from the account owner.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*Destiny2ApiService) Destiny2InsertSocketPlugFree ¶

func (a *Destiny2ApiService) Destiny2InsertSocketPlugFree(ctx context.Context, body DestinyRequestsActionsDestinyInsertPlugsFreeActionRequest) (*http.Response, error)

Destiny2ApiService Insert a 'free' plug into an item's socket. This does not require 'Advanced Write Action' authorization and is available to 3rd-party apps, but will only work on 'free and reversible' socket actions (Perks, Armor Mods, Shaders, Ornaments, etc.). You must have a valid Destiny Account, and the character must either be in a social space, in orbit, or offline.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*Destiny2ApiService) Destiny2PullFromPostmaster ¶

func (a *Destiny2ApiService) Destiny2PullFromPostmaster(ctx context.Context, body DestinyRequestsActionsDestinyPostmasterTransferRequest) (*http.Response, error)

Destiny2ApiService Extract an item from the Postmaster, with whatever implications that may entail. You must have a valid Destiny account. You must also pass BOTH a reference AND an instance ID if it's an instanced item.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*Destiny2ApiService) Destiny2ReportOffensivePostGameCarnageReportPlayer ¶

func (a *Destiny2ApiService) Destiny2ReportOffensivePostGameCarnageReportPlayer(ctx context.Context, body DestinyReportingRequestsDestinyReportOffensePgcrRequest, activityId int64) (*http.Response, error)

Destiny2ApiService Report a player that you met in an activity that was engaging in ToS-violating activities. Both you and the offending player must have played in the activityId passed in. Please use this judiciously and only when you have strong suspicions of violation, pretty please.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param activityId The ID of the activity where you ran into the brigand that you're reporting.

func (*Destiny2ApiService) Destiny2SearchDestinyEntities ¶

func (a *Destiny2ApiService) Destiny2SearchDestinyEntities(ctx context.Context, searchTerm string, type_ string, localVarOptionals *Destiny2ApiDestiny2SearchDestinyEntitiesOpts) (*http.Response, error)

func (*Destiny2ApiService) Destiny2SearchDestinyPlayerByBungieName ¶

func (a *Destiny2ApiService) Destiny2SearchDestinyPlayerByBungieName(ctx context.Context, body UserExactSearchRequest, membershipType int32) (*http.Response, error)

Destiny2ApiService Returns a list of Destiny memberships given a global Bungie Display Name. This method will hide overridden memberships due to cross save.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param membershipType A valid non-BungieNet membership type, or All. Indicates which memberships to return. You probably want this set to All.

func (*Destiny2ApiService) Destiny2SetItemLockState ¶

func (a *Destiny2ApiService) Destiny2SetItemLockState(ctx context.Context, body DestinyRequestsActionsDestinyItemStateRequest) (*http.Response, error)

Destiny2ApiService Set the Lock State for an instanced item. You must have a valid Destiny Account.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*Destiny2ApiService) Destiny2SetQuestTrackedState ¶

func (a *Destiny2ApiService) Destiny2SetQuestTrackedState(ctx context.Context, body DestinyRequestsActionsDestinyItemStateRequest) (*http.Response, error)

Destiny2ApiService Set the Tracking State for an instanced item, if that item is a Quest or Bounty. You must have a valid Destiny Account. Yeah, it's an item.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*Destiny2ApiService) Destiny2SnapshotLoadout ¶

func (a *Destiny2ApiService) Destiny2SnapshotLoadout(ctx context.Context, body DestinyRequestsActionsDestinyLoadoutUpdateActionRequest) (*http.Response, error)

Destiny2ApiService Snapshot a loadout with the currently equipped items.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*Destiny2ApiService) Destiny2TransferItem ¶

func (a *Destiny2ApiService) Destiny2TransferItem(ctx context.Context, body DestinyRequestsDestinyItemTransferRequest) (*http.Response, error)

Destiny2ApiService Transfer an item to/from your vault. You must have a valid Destiny account. You must also pass BOTH a reference AND an instance ID if it's an instanced item. itshappening.gif

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*Destiny2ApiService) Destiny2UpdateLoadoutIdentifiers ¶

func (a *Destiny2ApiService) Destiny2UpdateLoadoutIdentifiers(ctx context.Context, body DestinyRequestsActionsDestinyLoadoutUpdateActionRequest) (*http.Response, error)

Destiny2ApiService Update the color, icon, and name of a loadout.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

type DestinyActivitiesDestinyPublicActivityStatus ¶

type DestinyActivitiesDestinyPublicActivityStatus struct {
	// Active Challenges for the activity, if any - represented as hashes for DestinyObjectiveDefinitions.
	ChallengeObjectiveHashes []int32 `json:"challengeObjectiveHashes,omitempty"`
	// The active modifiers on this activity, if any - represented as hashes for DestinyActivityModifierDefinitions.
	ModifierHashes []int32 `json:"modifierHashes,omitempty"`
	// If the activity itself provides any specific \"mock\" rewards, this will be the items and their quantity.  Why \"mock\", you ask? Because these are the rewards as they are represented in the tooltip of the Activity.  These are often pointers to fake items that look good in a tooltip, but represent an abstract concept of what you will get for a reward rather than the specific items you may obtain.
	RewardTooltipItems []DestinyDestinyItemQuantity `json:"rewardTooltipItems,omitempty"`
}

Represents the public-facing status of an activity: any data about what is currently active in the Activity, regardless of an individual character's progress in it.

type DestinyActivityGraphNodeHighlightType ¶

type DestinyActivityGraphNodeHighlightType int32

DestinyActivityGraphNodeHighlightType : The various known UI styles in which an item can be highlighted. It'll be up to you to determine what you want to show based on this highlighting, BNet doesn't have any assets that correspond to these states. And yeah, RiseOfIron and Comet have their own special highlight states. Don't ask me, I can't imagine they're still used.

type DestinyAdvancedAwaAuthorizationResult ¶

type DestinyAdvancedAwaAuthorizationResult struct {
	// Indication of how the user responded to the request. If the value is \"Approved\" the actionToken will contain the token that can be presented when performing the advanced write action.
	UserSelection  int32 `json:"userSelection,omitempty"`
	ResponseReason int32 `json:"responseReason,omitempty"`
	// Message to the app developer to help understand the response.
	DeveloperNote string `json:"developerNote,omitempty"`
	// Credential used to prove the user authorized an advanced write action.
	ActionToken string `json:"actionToken,omitempty"`
	// This token may be used to perform the requested action this number of times, at a maximum. If this value is 0, then there is no limit.
	MaximumNumberOfUses int32 `json:"maximumNumberOfUses,omitempty"`
	// Time, UTC, when token expires.
	ValidUntil time.Time `json:"validUntil,omitempty"`
	// Advanced Write Action Type from the permission request.
	Type_ int32 `json:"type,omitempty"`
	// MembershipType from the permission request.
	MembershipType int32 `json:"membershipType,omitempty"`
}

type DestinyAdvancedAwaInitializeResponse ¶

type DestinyAdvancedAwaInitializeResponse struct {
	// ID used to get the token. Present this ID to the user as it will identify this specific request on their device.
	CorrelationId string `json:"correlationId,omitempty"`
	// True if the PUSH message will only be sent to the device that made this request.
	SentToSelf bool `json:"sentToSelf,omitempty"`
}

type DestinyAdvancedAwaPermissionRequested ¶

type DestinyAdvancedAwaPermissionRequested struct {
	// Type of advanced write action.
	Type_ int32 `json:"type,omitempty"`
	// Item instance ID the action shall be applied to. This is optional for all but a new AwaType values. Rule of thumb is to provide the item instance ID if one is available.
	AffectedItemId int64 `json:"affectedItemId,omitempty"`
	// Destiny membership type of the account to modify.
	MembershipType int32 `json:"membershipType,omitempty"`
	// Destiny character ID, if applicable, that will be affected by the action.
	CharacterId int64 `json:"characterId,omitempty"`
}

type DestinyAdvancedAwaResponseReason ¶

type DestinyAdvancedAwaResponseReason int32

type DestinyAdvancedAwaType ¶

type DestinyAdvancedAwaType int32

type DestinyAdvancedAwaUserResponse ¶

type DestinyAdvancedAwaUserResponse struct {
	// Indication of the selection the user has made (Approving or rejecting the action)
	Selection int32 `json:"selection,omitempty"`
	// Correlation ID of the request
	CorrelationId string `json:"correlationId,omitempty"`
	// Secret nonce received via the PUSH notification.
	Nonce []string `json:"nonce,omitempty"`
}

type DestinyAdvancedAwaUserSelection ¶

type DestinyAdvancedAwaUserSelection int32

type DestinyArtifactsDestinyArtifactCharacterScoped ¶

type DestinyArtifactsDestinyArtifactCharacterScoped struct {
	ArtifactHash int32                                 `json:"artifactHash,omitempty"`
	PointsUsed   int32                                 `json:"pointsUsed,omitempty"`
	ResetCount   int32                                 `json:"resetCount,omitempty"`
	Tiers        []DestinyArtifactsDestinyArtifactTier `json:"tiers,omitempty"`
}

type DestinyArtifactsDestinyArtifactProfileScoped ¶

type DestinyArtifactsDestinyArtifactProfileScoped struct {
	ArtifactHash          int32                      `json:"artifactHash,omitempty"`
	PointProgression      *DestinyDestinyProgression `json:"pointProgression,omitempty"`
	PointsAcquired        int32                      `json:"pointsAcquired,omitempty"`
	PowerBonusProgression *DestinyDestinyProgression `json:"powerBonusProgression,omitempty"`
	PowerBonus            int32                      `json:"powerBonus,omitempty"`
}

Represents a Seasonal Artifact and all data related to it for the requested Account. It can be combined with Character-scoped data for a full picture of what a character has available/has chosen, or just these settings can be used for overview information.

type DestinyArtifactsDestinyArtifactTier ¶

type DestinyArtifactsDestinyArtifactTier struct {
	TierHash       int32                                     `json:"tierHash,omitempty"`
	IsUnlocked     bool                                      `json:"isUnlocked,omitempty"`
	PointsToUnlock int32                                     `json:"pointsToUnlock,omitempty"`
	Items          []DestinyArtifactsDestinyArtifactTierItem `json:"items,omitempty"`
}

type DestinyArtifactsDestinyArtifactTierItem ¶

type DestinyArtifactsDestinyArtifactTierItem struct {
	ItemHash int32 `json:"itemHash,omitempty"`
	IsActive bool  `json:"isActive,omitempty"`
}

type DestinyBaseItemComponentSetOfint32 ¶

type DestinyBaseItemComponentSetOfint32 struct {
	Objectives *DictionaryComponentResponseOfint32AndDestinyItemObjectivesComponent `json:"objectives,omitempty"`
	Perks      *DictionaryComponentResponseOfint32AndDestinyItemPerksComponent      `json:"perks,omitempty"`
}

type DestinyBaseItemComponentSetOfint64 ¶

type DestinyBaseItemComponentSetOfint64 struct {
	Objectives *DictionaryComponentResponseOfint64AndDestinyItemObjectivesComponent `json:"objectives,omitempty"`
	Perks      *DictionaryComponentResponseOfint64AndDestinyItemPerksComponent      `json:"perks,omitempty"`
}

type DestinyBaseItemComponentSetOfuint32 ¶

type DestinyBaseItemComponentSetOfuint32 struct {
	Objectives *DictionaryComponentResponseOfuint32AndDestinyItemObjectivesComponent `json:"objectives,omitempty"`
	Perks      *DictionaryComponentResponseOfuint32AndDestinyItemPerksComponent      `json:"perks,omitempty"`
}

type DestinyBucketCategory ¶

type DestinyBucketCategory int32

type DestinyBucketScope ¶

type DestinyBucketScope int32

type DestinyChallengesDestinyChallengeStatus ¶

type DestinyChallengesDestinyChallengeStatus struct {
	// The progress - including completion status - of the active challenge.
	Objective *AllOfDestinyChallengesDestinyChallengeStatusObjective `json:"objective,omitempty"`
}

Represents the status and other related information for a challenge that is - or was - available to a player. A challenge is a bonus objective, generally tacked onto Quests or Activities, that provide additional variations on play.

type DestinyCharacterDestinyCharacterCustomization ¶

type DestinyCharacterDestinyCharacterCustomization struct {
	Personality   int32   `json:"personality,omitempty"`
	Face          int32   `json:"face,omitempty"`
	SkinColor     int32   `json:"skinColor,omitempty"`
	LipColor      int32   `json:"lipColor,omitempty"`
	EyeColor      int32   `json:"eyeColor,omitempty"`
	HairColors    []int32 `json:"hairColors,omitempty"`
	FeatureColors []int32 `json:"featureColors,omitempty"`
	DecalColor    int32   `json:"decalColor,omitempty"`
	WearHelmet    bool    `json:"wearHelmet,omitempty"`
	HairIndex     int32   `json:"hairIndex,omitempty"`
	FeatureIndex  int32   `json:"featureIndex,omitempty"`
	DecalIndex    int32   `json:"decalIndex,omitempty"`
}

Raw data about the customization options chosen for a character's face and appearance. You can look up the relevant class/race/gender combo in DestinyCharacterCustomizationOptionDefinition for the character, and then look up these values within the CustomizationOptions found to pull some data about their choices. Warning: not all of that data is meaningful. Some data has useful icons. Others have nothing, and are only meant for 3D rendering purposes (which we sadly do not expose yet)

type DestinyCharacterDestinyCharacterPeerView ¶

type DestinyCharacterDestinyCharacterPeerView struct {
	Equipment []DestinyCharacterDestinyItemPeerView `json:"equipment,omitempty"`
}

A minimal view of a character's equipped items, for the purpose of rendering a summary screen or showing the character in 3D.

type DestinyCharacterDestinyItemPeerView ¶

type DestinyCharacterDestinyItemPeerView struct {
	// The hash identifier of the item in question. Use it to look up the DestinyInventoryItemDefinition of the item for static rendering data.
	ItemHash int32 `json:"itemHash,omitempty"`
	// The list of dyes that have been applied to this item.
	Dyes []DestinyDyeReference `json:"dyes,omitempty"`
}

Bare minimum summary information for an item, for the sake of 3D rendering the item.

type DestinyComponentsCollectiblesDestinyCollectibleComponent ¶

type DestinyComponentsCollectiblesDestinyCollectibleComponent struct {
	State int32 `json:"state,omitempty"`
}

type DestinyComponentsCollectiblesDestinyCollectiblesComponent ¶

type DestinyComponentsCollectiblesDestinyCollectiblesComponent struct {
	Collectibles map[string]DestinyComponentsCollectiblesDestinyCollectibleComponent `json:"collectibles,omitempty"`
	// The hash for the root presentation node definition of Collection categories.
	CollectionCategoriesRootNodeHash int32 `json:"collectionCategoriesRootNodeHash,omitempty"`
	// The hash for the root presentation node definition of Collection Badges.
	CollectionBadgesRootNodeHash int32 `json:"collectionBadgesRootNodeHash,omitempty"`
}

type DestinyComponentsCollectiblesDestinyProfileCollectiblesComponent ¶

type DestinyComponentsCollectiblesDestinyProfileCollectiblesComponent struct {
	// The list of collectibles determined by the game as having been \"recently\" acquired.
	RecentCollectibleHashes []int32 `json:"recentCollectibleHashes,omitempty"`
	// The list of collectibles determined by the game as having been \"recently\" acquired.  The game client itself actually controls this data, so I personally question whether anyone will get much use out of this: because we can't edit this value through the API. But in case anyone finds it useful, here it is.
	NewnessFlaggedCollectibleHashes []int32                                                             `json:"newnessFlaggedCollectibleHashes,omitempty"`
	Collectibles                    map[string]DestinyComponentsCollectiblesDestinyCollectibleComponent `json:"collectibles,omitempty"`
	// The hash for the root presentation node definition of Collection categories.
	CollectionCategoriesRootNodeHash int32 `json:"collectionCategoriesRootNodeHash,omitempty"`
	// The hash for the root presentation node definition of Collection Badges.
	CollectionBadgesRootNodeHash int32 `json:"collectionBadgesRootNodeHash,omitempty"`
}

type DestinyComponentsCraftablesDestinyCraftableComponent ¶

type DestinyComponentsCraftablesDestinyCraftableComponent struct {
	Visible bool `json:"visible,omitempty"`
	// If the requirements are not met for crafting this item, these will index into the list of failure strings.
	FailedRequirementIndexes []int32 `json:"failedRequirementIndexes,omitempty"`
	// Plug item state for the crafting sockets.
	Sockets []DestinyComponentsCraftablesDestinyCraftableSocketComponent `json:"sockets,omitempty"`
}

type DestinyComponentsCraftablesDestinyCraftableSocketComponent ¶

type DestinyComponentsCraftablesDestinyCraftableSocketComponent struct {
	PlugSetHash int32 `json:"plugSetHash,omitempty"`
	// Unlock state for plugs in the socket plug set definition
	Plugs []DestinyComponentsCraftablesDestinyCraftableSocketPlugComponent `json:"plugs,omitempty"`
}

type DestinyComponentsCraftablesDestinyCraftableSocketPlugComponent ¶

type DestinyComponentsCraftablesDestinyCraftableSocketPlugComponent struct {
	PlugItemHash int32 `json:"plugItemHash,omitempty"`
	// Index into the unlock requirements to display failure descriptions
	FailedRequirementIndexes []int32 `json:"failedRequirementIndexes,omitempty"`
}

type DestinyComponentsCraftablesDestinyCraftablesComponent ¶

type DestinyComponentsCraftablesDestinyCraftablesComponent struct {
	// A map of craftable item hashes to craftable item state components.
	Craftables map[string]DestinyComponentsCraftablesDestinyCraftableComponent `json:"craftables,omitempty"`
	// The hash for the root presentation node definition of craftable item categories.
	CraftingRootNodeHash int32 `json:"craftingRootNodeHash,omitempty"`
}

type DestinyComponentsInventoryDestinyCurrenciesComponent ¶

type DestinyComponentsInventoryDestinyCurrenciesComponent struct {
	// A dictionary - keyed by the item's hash identifier (DestinyInventoryItemDefinition), and whose value is the amount of that item you have across all available inventory buckets for purchasing.  This allows you to see whether the requesting character can afford any given purchase/action without having to re-create this list itself.
	ItemQuantities map[string]int32 `json:"itemQuantities,omitempty"`
}

This component provides a quick lookup of every item the requested character has and how much of that item they have. Requesting this component will allow you to circumvent manually putting together the list of which currencies you have for the purpose of testing currency requirements on an item being purchased, or operations that have costs. You *could* figure this out yourself by doing a GetCharacter or GetProfile request and forming your own lookup table, but that is inconvenient enough that this feels like a worthwhile (and optional) redundency. Don't bother requesting it if you have already created your own lookup from prior GetCharacter/GetProfile calls.

type DestinyComponentsInventoryDestinyPlatformSilverComponent ¶

type DestinyComponentsInventoryDestinyPlatformSilverComponent struct {
	// If a Profile is played on multiple platforms, this is the silver they have for each platform, keyed by Membership Type.
	PlatformSilver map[string]DestinyEntitiesItemsDestinyItemComponent `json:"platformSilver,omitempty"`
}

type DestinyComponentsItemsDestinyItemPlugComponent ¶

type DestinyComponentsItemsDestinyItemPlugComponent struct {
	// Sometimes, Plugs may have objectives: these are often used for flavor and display purposes, but they can be used for any arbitrary purpose (both fortunately and unfortunately). Recently (with Season 2) they were expanded in use to be used as the \"gating\" for whether the plug can be inserted at all. For instance, a Plug might be tracking the number of PVP kills you have made. It will use the parent item's data about that tracking status to determine what to show, and will generally show it using the DestinyObjectiveDefinition's progressDescription property. Refer to the plug's itemHash and objective property for more information if you would like to display even more data.
	PlugObjectives []DestinyQuestsDestinyObjectiveProgress `json:"plugObjectives,omitempty"`
	// The hash identifier of the DestinyInventoryItemDefinition that represents this plug.
	PlugItemHash int32 `json:"plugItemHash,omitempty"`
	// If true, this plug has met all of its insertion requirements. Big if true.
	CanInsert bool `json:"canInsert,omitempty"`
	// If true, this plug will provide its benefits while inserted.
	Enabled bool `json:"enabled,omitempty"`
	// If the plug cannot be inserted for some reason, this will have the indexes into the plug item definition's plug.insertionRules property, so you can show the reasons why it can't be inserted.  This list will be empty if the plug can be inserted.
	InsertFailIndexes []int32 `json:"insertFailIndexes,omitempty"`
	// If a plug is not enabled, this will be populated with indexes into the plug item definition's plug.enabledRules property, so that you can show the reasons why it is not enabled.  This list will be empty if the plug is enabled.
	EnableFailIndexes []int32 `json:"enableFailIndexes,omitempty"`
}

Plugs are non-instanced items that can provide Stat and Perk benefits when socketed into an instanced item. Items have Sockets, and Plugs are inserted into Sockets. This component finds all items that are considered \"Plugs\" in your inventory, and return information about the plug aside from any specific Socket into which it could be inserted.

type DestinyComponentsItemsDestinyItemPlugObjectivesComponent ¶

type DestinyComponentsItemsDestinyItemPlugObjectivesComponent struct {
	// This set of data is keyed by the Item Hash (DestinyInventoryItemDefinition) of the plug whose objectives are being returned, with the value being the list of those objectives.   What if two plugs with the same hash are returned for an item, you ask?   Good question! They share the same item-scoped state, and as such would have identical objective state as a result. How's that for convenient.   Sometimes, Plugs may have objectives: generally, these are used for flavor and display purposes. For instance, a Plug might be tracking the number of PVP kills you have made. It will use the parent item's data about that tracking status to determine what to show, and will generally show it using the DestinyObjectiveDefinition's progressDescription property. Refer to the plug's itemHash and objective property for more information if you would like to display even more data.
	ObjectivesPerPlug map[string][]DestinyQuestsDestinyObjectiveProgress `json:"objectivesPerPlug,omitempty"`
}

type DestinyComponentsItemsDestinyItemReusablePlugsComponent ¶

type DestinyComponentsItemsDestinyItemReusablePlugsComponent struct {
	// If the item supports reusable plugs, this is the list of plugs that are allowed to be used for the socket, and any relevant information about whether they are \"enabled\", whether they are allowed to be inserted, and any other information such as objectives.   A Reusable Plug is a plug that you can always insert into this socket as long as its insertion rules are passed, regardless of whether or not you have the plug in your inventory. An example of it failing an insertion rule would be if it has an Objective that needs to be completed before it can be inserted, and that objective hasn't been completed yet.   In practice, a socket will *either* have reusable plugs *or* it will allow for plugs in your inventory to be inserted. See DestinyInventoryItemDefinition.socket for more info.   KEY = The INDEX into the item's list of sockets. VALUE = The set of plugs for that socket.   If a socket doesn't have any reusable plugs defined at the item scope, there will be no entry for that socket.
	Plugs map[string][]DestinySocketsDestinyItemPlugBase `json:"plugs,omitempty"`
}

type DestinyComponentsKiosksDestinyKioskItem ¶

type DestinyComponentsKiosksDestinyKioskItem struct {
	// The index of the item in the related DestinyVendorDefintion's itemList property, representing the sale.
	Index int32 `json:"index,omitempty"`
	// If true, the user can not only see the item, but they can acquire it. It is possible that a user can see a kiosk item and not be able to acquire it.
	CanAcquire bool `json:"canAcquire,omitempty"`
	// Indexes into failureStrings for the Vendor, indicating the reasons why it failed if any.
	FailureIndexes []int32 `json:"failureIndexes,omitempty"`
	// I may regret naming it this way - but this represents when an item has an objective that doesn't serve a beneficial purpose, but rather is used for \"flavor\" or additional information. For instance, when Emblems track specific stats, those stats are represented as Objectives on the item.
	FlavorObjective *AllOfDestinyComponentsKiosksDestinyKioskItemFlavorObjective `json:"flavorObjective,omitempty"`
}

type DestinyComponentsKiosksDestinyKiosksComponent ¶

type DestinyComponentsKiosksDestinyKiosksComponent struct {
	// A dictionary keyed by the Kiosk Vendor's hash identifier (use it to look up the DestinyVendorDefinition for the relevant kiosk vendor), and whose value is a list of all the items that the user can \"see\" in the Kiosk, and any other interesting metadata.
	KioskItems map[string][]DestinyComponentsKiosksDestinyKioskItem `json:"kioskItems,omitempty"`
}

A Kiosk is a Vendor (DestinyVendorDefinition) that sells items based on whether you have already acquired that item before. 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 individual character's DestinyCharacterKiosksComponent. Note that, because this component returns vendorItemIndexes (that is to say, indexes into the Kiosk Vendor's itemList property), these results are necessarily content version dependent. Make sure that you have the latest version of the content manifest databases before using this data.

type DestinyComponentsLoadoutsDestinyLoadoutComponent ¶

type DestinyComponentsLoadoutsDestinyLoadoutComponent struct {
	ColorHash int32                                                  `json:"colorHash,omitempty"`
	IconHash  int32                                                  `json:"iconHash,omitempty"`
	NameHash  int32                                                  `json:"nameHash,omitempty"`
	Items     []DestinyComponentsLoadoutsDestinyLoadoutItemComponent `json:"items,omitempty"`
}

type DestinyComponentsLoadoutsDestinyLoadoutItemComponent ¶

type DestinyComponentsLoadoutsDestinyLoadoutItemComponent struct {
	ItemInstanceId int64   `json:"itemInstanceId,omitempty"`
	PlugItemHashes []int32 `json:"plugItemHashes,omitempty"`
}

type DestinyComponentsLoadoutsDestinyLoadoutsComponent ¶

type DestinyComponentsLoadoutsDestinyLoadoutsComponent struct {
	Loadouts []DestinyComponentsLoadoutsDestinyLoadoutComponent `json:"loadouts,omitempty"`
}

type DestinyComponentsMetricsDestinyMetricComponent ¶

type DestinyComponentsMetricsDestinyMetricComponent struct {
	Invisible         bool                                   `json:"invisible,omitempty"`
	ObjectiveProgress *DestinyQuestsDestinyObjectiveProgress `json:"objectiveProgress,omitempty"`
}

type DestinyComponentsMetricsDestinyMetricsComponent ¶

type DestinyComponentsMetricsDestinyMetricsComponent struct {
	Metrics             map[string]DestinyComponentsMetricsDestinyMetricComponent `json:"metrics,omitempty"`
	MetricsRootNodeHash int32                                                     `json:"metricsRootNodeHash,omitempty"`
}

type DestinyComponentsPlugSetsDestinyPlugSetsComponent ¶

type DestinyComponentsPlugSetsDestinyPlugSetsComponent struct {
	// The shared list of plugs for each relevant PlugSet, keyed by the hash identifier of the PlugSet (DestinyPlugSetDefinition).
	Plugs map[string][]DestinySocketsDestinyItemPlug `json:"plugs,omitempty"`
}

Sockets may refer to a \"Plug Set\": a set of reusable plugs that may be shared across multiple sockets (or even, in theory, multiple sockets over multiple items). This is the set of those plugs that we came across in the users' inventory, along with the values for plugs in the set. Any given set in this component may be represented in Character and Profile-level, as some plugs may be Profile-level restricted, and some character-level restricted. (note that the ones that are even more specific will remain on the actual socket component itself, as they cannot be reused)

type DestinyComponentsPresentationDestinyPresentationNodeComponent ¶

type DestinyComponentsPresentationDestinyPresentationNodeComponent struct {
	State int32 `json:"state,omitempty"`
	// An optional property: presentation nodes MAY have objectives, which can be used to infer more human readable data about the progress. However, progressValue and completionValue ought to be considered the canonical values for progress on Progression Nodes.
	Objective *AllOfDestinyComponentsPresentationDestinyPresentationNodeComponentObjective `json:"objective,omitempty"`
	// How much of the presentation node is considered to be completed so far by the given character/profile.
	ProgressValue int32 `json:"progressValue,omitempty"`
	// The value at which the presentation node is considered to be completed.
	CompletionValue int32 `json:"completionValue,omitempty"`
	// If available, this is the current score for the record category that this node represents.
	RecordCategoryScore int32 `json:"recordCategoryScore,omitempty"`
}

type DestinyComponentsPresentationDestinyPresentationNodesComponent ¶

type DestinyComponentsPresentationDestinyPresentationNodesComponent struct {
	Nodes map[string]DestinyComponentsPresentationDestinyPresentationNodeComponent `json:"nodes,omitempty"`
}

type DestinyComponentsProfilesDestinyProfileProgressionComponent ¶

type DestinyComponentsProfilesDestinyProfileProgressionComponent struct {
	// The set of checklists that can be examined on a profile-wide basis, keyed by the hash identifier of the Checklist (DestinyChecklistDefinition)  For each checklist returned, its value is itself a Dictionary keyed by the checklist's hash identifier with the value being a boolean indicating if it's been discovered yet.
	Checklists map[string]map[string]bool `json:"checklists,omitempty"`
	// Data related to your progress on the current season's artifact that is the same across characters.
	SeasonalArtifact *AllOfDestinyComponentsProfilesDestinyProfileProgressionComponentSeasonalArtifact `json:"seasonalArtifact,omitempty"`
}

The set of progression-related information that applies at a Profile-wide level for your Destiny experience. This differs from the Jimi Hendrix Experience because there's less guitars on fire. Yet. #spoileralert? This will include information such as Checklist info.

type DestinyComponentsProfilesDestinyProfileTransitoryComponent ¶

type DestinyComponentsProfilesDestinyProfileTransitoryComponent struct {
	// If you have any members currently in your party, this is some (very) bare-bones information about those members.
	PartyMembers []DestinyComponentsProfilesDestinyProfileTransitoryPartyMember `json:"partyMembers,omitempty"`
	// If you are in an activity, this is some transitory info about the activity currently being played.
	CurrentActivity *AllOfDestinyComponentsProfilesDestinyProfileTransitoryComponentCurrentActivity `json:"currentActivity,omitempty"`
	// Information about whether and what might prevent you from joining this person on a fireteam.
	Joinability *AllOfDestinyComponentsProfilesDestinyProfileTransitoryComponentJoinability `json:"joinability,omitempty"`
	// Information about tracked entities.
	Tracking []DestinyComponentsProfilesDestinyProfileTransitoryTrackingEntry `json:"tracking,omitempty"`
	// The hash identifier for the DestinyDestinationDefinition of the last location you were orbiting when in orbit.
	LastOrbitedDestinationHash int32 `json:"lastOrbitedDestinationHash,omitempty"`
}

This is an experimental set of data that Bungie considers to be \"transitory\" - information that may be useful for API users, but that is coming from a non-authoritative data source about information that could potentially change at a more frequent pace than Bungie.net will receive updates about it. This information is provided exclusively for convenience should any of it be useful to users: we provide no guarantees to the accuracy or timeliness of data that comes from this source. Know that this data can potentially be out-of-date or even wrong entirely if the user disconnected from the game or suddenly changed their status before we can receive refreshed data.

type DestinyComponentsProfilesDestinyProfileTransitoryCurrentActivity ¶

type DestinyComponentsProfilesDestinyProfileTransitoryCurrentActivity struct {
	// When the activity started.
	StartTime time.Time `json:"startTime,omitempty"`
	// If you're still in it but it \"ended\" (like when folks are dancing around the loot after they beat a boss), this is when the activity ended.
	EndTime time.Time `json:"endTime,omitempty"`
	// This is what our non-authoritative source thought the score was.
	Score float32 `json:"score,omitempty"`
	// If you have human opponents, this is the highest opposing team's score.
	HighestOpposingFactionScore float32 `json:"highestOpposingFactionScore,omitempty"`
	// This is how many human or poorly crafted aimbot opponents you have.
	NumberOfOpponents int32 `json:"numberOfOpponents,omitempty"`
	// This is how many human or poorly crafted aimbots are on your team.
	NumberOfPlayers int32 `json:"numberOfPlayers,omitempty"`
}

If you are playing in an activity, this is some information about it. Note that we cannot guarantee any of this resembles what ends up in the PGCR in any way. They are sourced by two entirely separate systems with their own logic, and the one we source this data from should be considered non-authoritative in comparison.

type DestinyComponentsProfilesDestinyProfileTransitoryJoinability ¶

type DestinyComponentsProfilesDestinyProfileTransitoryJoinability struct {
	// The number of slots still available on this person's fireteam.
	OpenSlots int32 `json:"openSlots,omitempty"`
	// Who the person is currently allowing invites from.
	PrivacySetting int32 `json:"privacySetting,omitempty"`
	// Reasons why a person can't join this person's fireteam.
	ClosedReasons int32 `json:"closedReasons,omitempty"`
}

Some basic information about whether you can be joined, how many slots are left etc. Note that this can change quickly, so it may not actually be useful. But perhaps it will be in some use cases?

type DestinyComponentsProfilesDestinyProfileTransitoryPartyMember ¶

type DestinyComponentsProfilesDestinyProfileTransitoryPartyMember struct {
	// The Membership ID that matches the party member.
	MembershipId int64 `json:"membershipId,omitempty"`
	// The identifier for the DestinyInventoryItemDefinition of the player's emblem.
	EmblemHash int32 `json:"emblemHash,omitempty"`
	// The player's last known display name.
	DisplayName string `json:"displayName,omitempty"`
	// A Flags Enumeration value indicating the states that the player is in relevant to being on a fireteam.
	Status int32 `json:"status,omitempty"`
}

This is some bare minimum information about a party member in a Fireteam. Unfortunately, without great computational expense on our side we can only get at the data contained here. I'd like to give you a character ID for example, but we don't have it. But we do have these three pieces of information. May they help you on your quest to show meaningful data about current Fireteams. Notably, we don't and can't feasibly return info on characters. If you can, try to use just the data below for your UI and purposes. Only hit us with further queries if you absolutely must know the character ID of the currently playing character. Pretty please with sugar on top.

type DestinyComponentsProfilesDestinyProfileTransitoryTrackingEntry ¶

type DestinyComponentsProfilesDestinyProfileTransitoryTrackingEntry struct {
	// OPTIONAL - If this is tracking a DestinyLocationDefinition, this is the identifier for that location.
	LocationHash int32 `json:"locationHash,omitempty"`
	// OPTIONAL - If this is tracking the status of a DestinyInventoryItemDefinition, this is the identifier for that item.
	ItemHash int32 `json:"itemHash,omitempty"`
	// OPTIONAL - If this is tracking the status of a DestinyObjectiveDefinition, this is the identifier for that objective.
	ObjectiveHash int32 `json:"objectiveHash,omitempty"`
	// OPTIONAL - If this is tracking the status of a DestinyActivityDefinition, this is the identifier for that activity.
	ActivityHash int32 `json:"activityHash,omitempty"`
	// OPTIONAL - If this is tracking the status of a quest, this is the identifier for the DestinyInventoryItemDefinition that containst that questline data.
	QuestlineItemHash int32 `json:"questlineItemHash,omitempty"`
	// OPTIONAL - I've got to level with you, I don't really know what this is. Is it when you started tracking it? Is it only populated for tracked items that have time limits?  I don't know, but we can get at it - when I get time to actually test what it is, I'll update this. In the meantime, bask in the mysterious data.
	TrackedDate time.Time `json:"trackedDate,omitempty"`
}

This represents a single \"thing\" being tracked by the player. This can point to many types of entities, but only a subset of them will actually have a valid hash identifier for whatever it is being pointed to. It's up to you to interpret what it means when various combinations of these entries have values being tracked.

type DestinyComponentsRecordsDestinyCharacterRecordsComponent ¶

type DestinyComponentsRecordsDestinyCharacterRecordsComponent struct {
	FeaturedRecordHashes []int32                                                   `json:"featuredRecordHashes,omitempty"`
	Records              map[string]DestinyComponentsRecordsDestinyRecordComponent `json:"records,omitempty"`
	// The hash for the root presentation node definition of Triumph categories.
	RecordCategoriesRootNodeHash int32 `json:"recordCategoriesRootNodeHash,omitempty"`
	// The hash for the root presentation node definition of Triumph Seals.
	RecordSealsRootNodeHash int32 `json:"recordSealsRootNodeHash,omitempty"`
}

type DestinyComponentsRecordsDestinyProfileRecordsComponent ¶

type DestinyComponentsRecordsDestinyProfileRecordsComponent struct {
	// Your 'active' Triumphs score, maintained for backwards compatibility.
	Score int32 `json:"score,omitempty"`
	// Your 'active' Triumphs score.
	ActiveScore int32 `json:"activeScore,omitempty"`
	// Your 'legacy' Triumphs score.
	LegacyScore int32 `json:"legacyScore,omitempty"`
	// Your 'lifetime' Triumphs score.
	LifetimeScore int32 `json:"lifetimeScore,omitempty"`
	// If this profile is tracking a record, this is the hash identifier of the record it is tracking.
	TrackedRecordHash int32                                                     `json:"trackedRecordHash,omitempty"`
	Records           map[string]DestinyComponentsRecordsDestinyRecordComponent `json:"records,omitempty"`
	// The hash for the root presentation node definition of Triumph categories.
	RecordCategoriesRootNodeHash int32 `json:"recordCategoriesRootNodeHash,omitempty"`
	// The hash for the root presentation node definition of Triumph Seals.
	RecordSealsRootNodeHash int32 `json:"recordSealsRootNodeHash,omitempty"`
}

type DestinyComponentsRecordsDestinyRecordComponent ¶

type DestinyComponentsRecordsDestinyRecordComponent struct {
	State                  int32                                   `json:"state,omitempty"`
	Objectives             []DestinyQuestsDestinyObjectiveProgress `json:"objectives,omitempty"`
	IntervalObjectives     []DestinyQuestsDestinyObjectiveProgress `json:"intervalObjectives,omitempty"`
	IntervalsRedeemedCount int32                                   `json:"intervalsRedeemedCount,omitempty"`
	// If available, this is the number of times this record has been completed. For example, the number of times a seal title has been gilded.
	CompletedCount int32 `json:"completedCount,omitempty"`
	// If available, a list that describes which reward rewards should be shown (true) or hidden (false). This property is for regular record rewards, and not for interval objective rewards.
	RewardVisibilty []bool `json:"rewardVisibilty,omitempty"`
}

type DestinyComponentsRecordsDestinyRecordsComponent ¶

type DestinyComponentsRecordsDestinyRecordsComponent struct {
	Records map[string]DestinyComponentsRecordsDestinyRecordComponent `json:"records,omitempty"`
	// The hash for the root presentation node definition of Triumph categories.
	RecordCategoriesRootNodeHash int32 `json:"recordCategoriesRootNodeHash,omitempty"`
	// The hash for the root presentation node definition of Triumph Seals.
	RecordSealsRootNodeHash int32 `json:"recordSealsRootNodeHash,omitempty"`
}

type DestinyComponentsSocialDestinySocialCommendationsComponent ¶

type DestinyComponentsSocialDestinySocialCommendationsComponent struct {
	TotalScore                   int32            `json:"totalScore,omitempty"`
	ScoreDetailValues            []int32          `json:"scoreDetailValues,omitempty"`
	CommendationNodeScoresByHash map[string]int32 `json:"commendationNodeScoresByHash,omitempty"`
	CommendationScoresByHash     map[string]int32 `json:"commendationScoresByHash,omitempty"`
}

type DestinyComponentsStringVariablesDestinyStringVariablesComponent ¶

type DestinyComponentsStringVariablesDestinyStringVariablesComponent struct {
	IntegerValuesByHash map[string]int32 `json:"integerValuesByHash,omitempty"`
}

type DestinyComponentsVendorsDestinyPublicVendorComponent ¶

type DestinyComponentsVendorsDestinyPublicVendorComponent struct {
	// The unique identifier for the vendor. Use it to look up their DestinyVendorDefinition.
	VendorHash int32 `json:"vendorHash,omitempty"`
	// The date when this vendor's inventory will next rotate/refresh.  Note that this is distinct from the date ranges that the vendor is visible/available in-game: this field indicates the specific time when the vendor's available items refresh and rotate, regardless of whether the vendor is actually available at that time. Unfortunately, these two values may be (and are, for the case of important vendors like Xur) different.  Issue https://github.com/Bungie-net/api/issues/353 is tracking a fix to start providing visibility date ranges where possible in addition to this refresh date, so that all important dates for vendors are available for use.
	NextRefreshDate time.Time `json:"nextRefreshDate,omitempty"`
	// If True, the Vendor is currently accessible.   If False, they may not actually be visible in the world at the moment.
	Enabled bool `json:"enabled,omitempty"`
}

This component contains essential/summary information about the vendor from the perspective of a character-agnostic view.

type DestinyComponentsVendorsDestinyPublicVendorSaleItemComponent ¶

type DestinyComponentsVendorsDestinyPublicVendorSaleItemComponent struct {
	// The index into the DestinyVendorDefinition.itemList property. Note that this means Vendor data *is* Content Version dependent: make sure you have the latest content before you use Vendor data, or these indexes may mismatch.   Most systems avoid this problem, but Vendors is one area where we are unable to reasonably avoid content dependency at the moment.
	VendorItemIndex int32 `json:"vendorItemIndex,omitempty"`
	// The hash of the item being sold, as a quick shortcut for looking up the DestinyInventoryItemDefinition of the sale item.
	ItemHash int32 `json:"itemHash,omitempty"`
	// If populated, this is the hash of the item whose icon (and other secondary styles, but *not* the human readable strings) should override whatever icons/styles are on the item being sold.  If you don't do this, certain items whose styles are being overridden by socketed items - such as the \"Recycle Shader\" item - would show whatever their default icon/style is, and it wouldn't be pretty or look accurate.
	OverrideStyleItemHash int32 `json:"overrideStyleItemHash,omitempty"`
	// How much of the item you'll be getting.
	Quantity int32 `json:"quantity,omitempty"`
	// A summary of the current costs of the item.
	Costs []DestinyDestinyItemQuantity `json:"costs,omitempty"`
	// If this item has its own custom date where it may be removed from the Vendor's rotation, this is that date.  Note that there's not actually any guarantee that it will go away: it could be chosen again and end up still being in the Vendor's sale items! But this is the next date where that test will occur, and is also the date that the game shows for availability on things like Bounties being sold. So it's the best we can give.
	OverrideNextRefreshDate time.Time `json:"overrideNextRefreshDate,omitempty"`
	// If true, this item can be purchased through the Bungie.net API.
	ApiPurchasable bool `json:"apiPurchasable,omitempty"`
}

Has character-agnostic information about an item being sold by a vendor. Note that if you want instance, stats, etc... data for the item, you'll have to request additional components such as ItemInstances, ItemPerks etc... and acquire them from the DestinyVendorResponse's \"items\" property. For most of these, however, you'll have to ask for it in context of a specific character.

type DestinyComponentsVendorsDestinyVendorBaseComponent ¶

type DestinyComponentsVendorsDestinyVendorBaseComponent struct {
	// The unique identifier for the vendor. Use it to look up their DestinyVendorDefinition.
	VendorHash int32 `json:"vendorHash,omitempty"`
	// The date when this vendor's inventory will next rotate/refresh.  Note that this is distinct from the date ranges that the vendor is visible/available in-game: this field indicates the specific time when the vendor's available items refresh and rotate, regardless of whether the vendor is actually available at that time. Unfortunately, these two values may be (and are, for the case of important vendors like Xur) different.  Issue https://github.com/Bungie-net/api/issues/353 is tracking a fix to start providing visibility date ranges where possible in addition to this refresh date, so that all important dates for vendors are available for use.
	NextRefreshDate time.Time `json:"nextRefreshDate,omitempty"`
	// If True, the Vendor is currently accessible.   If False, they may not actually be visible in the world at the moment.
	Enabled bool `json:"enabled,omitempty"`
}

This component contains essential/summary information about the vendor.

type DestinyComponentsVendorsDestinyVendorGroup ¶

type DestinyComponentsVendorsDestinyVendorGroup struct {
	VendorGroupHash int32 `json:"vendorGroupHash,omitempty"`
	// The ordered list of vendors within a particular group.
	VendorHashes []int32 `json:"vendorHashes,omitempty"`
}

Represents a specific group of vendors that can be rendered in the recommended order. How do we figure out this order? It's a long story, and will likely get more complicated over time.

type DestinyComponentsVendorsDestinyVendorGroupComponent ¶

type DestinyComponentsVendorsDestinyVendorGroupComponent struct {
	// The ordered list of groups being returned.
	Groups []DestinyComponentsVendorsDestinyVendorGroup `json:"groups,omitempty"`
}

This component returns references to all of the Vendors in the response, grouped by categorizations that Bungie has deemed to be interesting, in the order in which both the groups and the vendors within that group should be rendered.

type DestinyComponentsVendorsDestinyVendorSaleItemBaseComponent ¶

type DestinyComponentsVendorsDestinyVendorSaleItemBaseComponent struct {
	// The index into the DestinyVendorDefinition.itemList property. Note that this means Vendor data *is* Content Version dependent: make sure you have the latest content before you use Vendor data, or these indexes may mismatch.   Most systems avoid this problem, but Vendors is one area where we are unable to reasonably avoid content dependency at the moment.
	VendorItemIndex int32 `json:"vendorItemIndex,omitempty"`
	// The hash of the item being sold, as a quick shortcut for looking up the DestinyInventoryItemDefinition of the sale item.
	ItemHash int32 `json:"itemHash,omitempty"`
	// If populated, this is the hash of the item whose icon (and other secondary styles, but *not* the human readable strings) should override whatever icons/styles are on the item being sold.  If you don't do this, certain items whose styles are being overridden by socketed items - such as the \"Recycle Shader\" item - would show whatever their default icon/style is, and it wouldn't be pretty or look accurate.
	OverrideStyleItemHash int32 `json:"overrideStyleItemHash,omitempty"`
	// How much of the item you'll be getting.
	Quantity int32 `json:"quantity,omitempty"`
	// A summary of the current costs of the item.
	Costs []DestinyDestinyItemQuantity `json:"costs,omitempty"`
	// If this item has its own custom date where it may be removed from the Vendor's rotation, this is that date.  Note that there's not actually any guarantee that it will go away: it could be chosen again and end up still being in the Vendor's sale items! But this is the next date where that test will occur, and is also the date that the game shows for availability on things like Bounties being sold. So it's the best we can give.
	OverrideNextRefreshDate time.Time `json:"overrideNextRefreshDate,omitempty"`
	// If true, this item can be purchased through the Bungie.net API.
	ApiPurchasable bool `json:"apiPurchasable,omitempty"`
}

The base class for Vendor Sale Item data. Has a bunch of character-agnostic state about the item being sold. Note that if you want instance, stats, etc... data for the item, you'll have to request additional components such as ItemInstances, ItemPerks etc... and acquire them from the DestinyVendorResponse's \"items\" property.

type DestinyConfigDestinyManifest ¶

type DestinyConfigDestinyManifest struct {
	Version                  string                                     `json:"version,omitempty"`
	MobileAssetContentPath   string                                     `json:"mobileAssetContentPath,omitempty"`
	MobileGearAssetDataBases []DestinyConfigGearAssetDataBaseDefinition `json:"mobileGearAssetDataBases,omitempty"`
	MobileWorldContentPaths  map[string]string                          `json:"mobileWorldContentPaths,omitempty"`
	// This points to the generated JSON that contains all the Definitions. Each key is a locale. The value is a path to the aggregated world definitions (warning: large file!)
	JsonWorldContentPaths map[string]string `json:"jsonWorldContentPaths,omitempty"`
	// This points to the generated JSON that contains all the Definitions. Each key is a locale. The value is a dictionary, where the key is a definition type by name, and the value is the path to the file for that definition. WARNING: This is unsafe and subject to change - do not depend on data in these files staying around long-term.
	JsonWorldComponentContentPaths map[string]map[string]string `json:"jsonWorldComponentContentPaths,omitempty"`
	MobileClanBannerDatabasePath   string                       `json:"mobileClanBannerDatabasePath,omitempty"`
	MobileGearCDN                  map[string]string            `json:"mobileGearCDN,omitempty"`
	// Information about the \"Image Pyramid\" for Destiny icons. Where possible, we create smaller versions of Destiny icons. These are found as subfolders under the location of the \"original/full size\" Destiny images, with the same file name and extension as the original image itself. (this lets us avoid sending largely redundant path info with every entity, at the expense of the smaller versions of the image being less discoverable)
	IconImagePyramidInfo []DestinyConfigImagePyramidEntry `json:"iconImagePyramidInfo,omitempty"`
}

DestinyManifest is the external-facing contract for just the properties needed by those calling the Destiny Platform.

type DestinyConfigGearAssetDataBaseDefinition ¶

type DestinyConfigGearAssetDataBaseDefinition struct {
	Version int32  `json:"version,omitempty"`
	Path    string `json:"path,omitempty"`
}

type DestinyConfigImagePyramidEntry ¶

type DestinyConfigImagePyramidEntry struct {
	// The name of the subfolder where these images are located.
	Name string `json:"name,omitempty"`
	// The factor by which the original image size has been reduced.
	Factor float32 `json:"factor,omitempty"`
}

type DestinyConstantsDestinyEnvironmentLocationMapping ¶

type DestinyConstantsDestinyEnvironmentLocationMapping struct {
	// The location that is revealed on the director by this mapping.
	LocationHash int32 `json:"locationHash,omitempty"`
	// A hint that the UI uses to figure out how this location is activated by the player.
	ActivationSource string `json:"activationSource,omitempty"`
	// If this is populated, it is the item that you must possess for this location to be active because of this mapping. (theoretically, a location can have multiple mappings, and some might require an item while others don't)
	ItemHash int32 `json:"itemHash,omitempty"`
	// If this is populated, this is an objective related to the location.
	ObjectiveHash int32 `json:"objectiveHash,omitempty"`
	// If this is populated, this is the activity you have to be playing in order to see this location appear because of this mapping. (theoretically, a location can have multiple mappings, and some might require you to be in a specific activity when others don't)
	ActivityHash int32 `json:"activityHash,omitempty"`
}

type DestinyDamageType ¶

type DestinyDamageType int32

type DestinyDefinitionsActivityModifiersDestinyActivityModifierDefinition ¶

type DestinyDefinitionsActivityModifiersDestinyActivityModifierDefinition struct {
	DisplayProperties          *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	DisplayInNavMode           bool                                                        `json:"displayInNavMode,omitempty"`
	DisplayInActivitySelection bool                                                        `json:"displayInActivitySelection,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

Modifiers - in Destiny 1, these were referred to as \"Skulls\" - are changes that can be applied to an Activity.

type DestinyDefinitionsAnimationsDestinyAnimationReference ¶

type DestinyDefinitionsAnimationsDestinyAnimationReference struct {
	AnimName       string `json:"animName,omitempty"`
	AnimIdentifier string `json:"animIdentifier,omitempty"`
	Path           string `json:"path,omitempty"`
}

type DestinyDefinitionsArtifactsDestinyArtifactDefinition ¶

type DestinyDefinitionsArtifactsDestinyArtifactDefinition struct {
	// Any basic display info we know about the Artifact. Currently sourced from a related inventory item, but the source of this data is subject to change.
	DisplayProperties *AllOfDestinyDefinitionsArtifactsDestinyArtifactDefinitionDisplayProperties `json:"displayProperties,omitempty"`
	// Any Geometry/3D info we know about the Artifact. Currently sourced from a related inventory item's gearset information, but the source of this data is subject to change.
	TranslationBlock *AllOfDestinyDefinitionsArtifactsDestinyArtifactDefinitionTranslationBlock `json:"translationBlock,omitempty"`
	// Any Tier/Rank data related to this artifact, listed in display order.  Currently sourced from a Vendor, but this source is subject to change.
	Tiers []DestinyDefinitionsArtifactsDestinyArtifactTierDefinition `json:"tiers,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

Represents known info about a Destiny Artifact. We cannot guarantee that artifact definitions will be immutable between seasons - in fact, we've been told that they will be replaced between seasons. But this definition is built both to minimize the amount of lookups for related data that have to occur, and is built in hope that, if this plan changes, we will be able to accommodate it more easily.

type DestinyDefinitionsArtifactsDestinyArtifactTierDefinition ¶

type DestinyDefinitionsArtifactsDestinyArtifactTierDefinition struct {
	// An identifier, unique within the Artifact, for this specific tier.
	TierHash int32 `json:"tierHash,omitempty"`
	// The human readable title of this tier, if any.
	DisplayTitle string `json:"displayTitle,omitempty"`
	// A string representing the localized minimum requirement text for this Tier, if any.
	ProgressRequirementMessage string `json:"progressRequirementMessage,omitempty"`
	// The items that can be earned within this tier.
	Items []DestinyDefinitionsArtifactsDestinyArtifactTierItemDefinition `json:"items,omitempty"`
	// The minimum number of \"unlock points\" that you must have used before you can unlock items from this tier.
	MinimumUnlockPointsUsedRequirement int32 `json:"minimumUnlockPointsUsedRequirement,omitempty"`
}

type DestinyDefinitionsArtifactsDestinyArtifactTierItemDefinition ¶

type DestinyDefinitionsArtifactsDestinyArtifactTierItemDefinition struct {
	// The identifier of the Plug Item unlocked by activating this item in the Artifact.
	ItemHash int32 `json:"itemHash,omitempty"`
}

type DestinyDefinitionsBreakerTypesDestinyBreakerTypeDefinition ¶

type DestinyDefinitionsBreakerTypesDestinyBreakerTypeDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// We have an enumeration for Breaker types for quick reference. This is the current definition's breaker type enum value.
	EnumValue int32 `json:"enumValue,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

type DestinyDefinitionsChecklistsDestinyChecklistDefinition ¶

type DestinyDefinitionsChecklistsDestinyChecklistDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// A localized string prompting you to view the checklist.
	ViewActionString string `json:"viewActionString,omitempty"`
	// Indicates whether you will find this checklist on the Profile or Character components.
	Scope int32 `json:"scope,omitempty"`
	// The individual checklist items. Gotta catch 'em all.
	Entries []DestinyDefinitionsChecklistsDestinyChecklistEntryDefinition `json:"entries,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

By public demand, Checklists are loose sets of \"things to do/things you have done\" in Destiny that we were actually able to track. They include easter eggs you find in the world, unique chests you unlock, and other such data where the first time you do it is significant enough to be tracked, and you have the potential to \"get them all\". These may be account-wide, or may be per character. The status of these will be returned in related \"Checklist\" data coming down from API requests such as GetProfile or GetCharacter. Generally speaking, the items in a checklist can be completed in any order: we return an ordered list which only implies the way we are showing them in our own UI, and you can feel free to alter it as you wish. Note that, in the future, there will be something resembling the old D1 Record Books in at least some vague form. When that is created, it may be that it will supercede much or all of this Checklist data. It remains to be seen if that will be the case, so for now assume that the Checklists will still exist even after the release of D2: Forsaken.

type DestinyDefinitionsChecklistsDestinyChecklistEntryDefinition ¶

type DestinyDefinitionsChecklistsDestinyChecklistEntryDefinition struct {
	// The identifier for this Checklist entry. Guaranteed unique only within this Checklist Definition, and not globally/for all checklists.
	Hash int32 `json:"hash,omitempty"`
	// Even if no other associations exist, we will give you *something* for display properties. In cases where we have no associated entities, it may be as simple as a numerical identifier.
	DisplayProperties *AllOfDestinyDefinitionsChecklistsDestinyChecklistEntryDefinitionDisplayProperties `json:"displayProperties,omitempty"`
	DestinationHash   int32                                                                              `json:"destinationHash,omitempty"`
	LocationHash      int32                                                                              `json:"locationHash,omitempty"`
	// Note that a Bubble's hash doesn't uniquely identify a \"top level\" entity in Destiny. Only the combination of location and bubble can uniquely identify a place in the world of Destiny: so if bubbleHash is populated, locationHash must too be populated for it to have any meaning.  You can use this property if it is populated to look up the DestinyLocationDefinition's associated .locationReleases[].activityBubbleName property.
	BubbleHash             int32 `json:"bubbleHash,omitempty"`
	ActivityHash           int32 `json:"activityHash,omitempty"`
	ItemHash               int32 `json:"itemHash,omitempty"`
	VendorHash             int32 `json:"vendorHash,omitempty"`
	VendorInteractionIndex int32 `json:"vendorInteractionIndex,omitempty"`
	// The scope at which this specific entry can be computed.
	Scope int32 `json:"scope,omitempty"`
}

The properties of an individual checklist item. Note that almost everything is optional: it is *highly* variable what kind of data we'll actually be able to return: at times we may have no other relationships to entities at all. Whatever UI you build, do it with the knowledge that any given entry might not actually be able to be associated with some other Destiny entity.

type DestinyDefinitionsCollectiblesDestinyCollectibleAcquisitionBlock ¶

type DestinyDefinitionsCollectiblesDestinyCollectibleAcquisitionBlock struct {
	AcquireMaterialRequirementHash  int32 `json:"acquireMaterialRequirementHash,omitempty"`
	AcquireTimestampUnlockValueHash int32 `json:"acquireTimestampUnlockValueHash,omitempty"`
}

type DestinyDefinitionsCollectiblesDestinyCollectibleDefinition ¶

type DestinyDefinitionsCollectiblesDestinyCollectibleDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// Indicates whether the state of this Collectible is determined on a per-character or on an account-wide basis.
	Scope int32 `json:"scope,omitempty"`
	// A human readable string for a hint about how to acquire the item.
	SourceString string `json:"sourceString,omitempty"`
	// This is a hash identifier we are building on the BNet side in an attempt to let people group collectibles by similar sources.  I can't promise that it's going to be 100% accurate, but if the designers were consistent in assigning the same source strings to items with the same sources, it *ought to* be. No promises though.  This hash also doesn't relate to an actual definition, just to note: we've got nothing useful other than the source string for this data.
	SourceHash           int32                                                             `json:"sourceHash,omitempty"`
	ItemHash             int32                                                             `json:"itemHash,omitempty"`
	AcquisitionInfo      *DestinyDefinitionsCollectiblesDestinyCollectibleAcquisitionBlock `json:"acquisitionInfo,omitempty"`
	StateInfo            *DestinyDefinitionsCollectiblesDestinyCollectibleStateBlock       `json:"stateInfo,omitempty"`
	PresentationInfo     *DestinyDefinitionsPresentationDestinyPresentationChildBlock      `json:"presentationInfo,omitempty"`
	PresentationNodeType int32                                                             `json:"presentationNodeType,omitempty"`
	TraitIds             []string                                                          `json:"traitIds,omitempty"`
	TraitHashes          []int32                                                           `json:"traitHashes,omitempty"`
	// A quick reference to presentation nodes that have this node as a child. Presentation nodes can be parented under multiple parents.
	ParentNodeHashes []int32 `json:"parentNodeHashes,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

Defines a

type DestinyDefinitionsCollectiblesDestinyCollectibleStateBlock ¶

type DestinyDefinitionsCollectiblesDestinyCollectibleStateBlock struct {
	ObscuredOverrideItemHash int32                                                                   `json:"obscuredOverrideItemHash,omitempty"`
	Requirements             *DestinyDefinitionsPresentationDestinyPresentationNodeRequirementsBlock `json:"requirements,omitempty"`
}

type DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition ¶

type DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

Many Destiny*Definition contracts - the \"first order\" entities of Destiny that have their own tables in the Manifest Database - also have displayable information. This is the base class for that display information.

type DestinyDefinitionsCommonDestinyIconSequenceDefinition ¶

type DestinyDefinitionsCommonDestinyIconSequenceDefinition struct {
	Frames []string `json:"frames,omitempty"`
}

type DestinyDefinitionsCommonDestinyPositionDefinition ¶

type DestinyDefinitionsCommonDestinyPositionDefinition struct {
	X int32 `json:"x,omitempty"`
	Y int32 `json:"y,omitempty"`
	Z int32 `json:"z,omitempty"`
}

type DestinyDefinitionsDestinyActivityChallengeDefinition ¶

type DestinyDefinitionsDestinyActivityChallengeDefinition struct {
	// The hash for the Objective that matches this challenge. Use it to look up the DestinyObjectiveDefinition.
	ObjectiveHash int32 `json:"objectiveHash,omitempty"`
	// The rewards as they're represented in the UI. Note that they generally link to \"dummy\" items that give a summary of rewards rather than direct, real items themselves.  If the quantity is 0, don't show the quantity.
	DummyRewards []DestinyDestinyItemQuantity `json:"dummyRewards,omitempty"`
}

Represents a reference to a Challenge, which for now is just an Objective.

type DestinyDefinitionsDestinyActivityDefinition ¶

type DestinyDefinitionsDestinyActivityDefinition struct {
	// The title, subtitle, and icon for the activity. We do a little post-processing on this to try and account for Activities where the designers have left this data too minimal to determine what activity is actually being played.
	DisplayProperties *AllOfDestinyDefinitionsDestinyActivityDefinitionDisplayProperties `json:"displayProperties,omitempty"`
	// The unadulterated form of the display properties, as they ought to be shown in the Director (if the activity appears in the director).
	OriginalDisplayProperties *AllOfDestinyDefinitionsDestinyActivityDefinitionOriginalDisplayProperties `json:"originalDisplayProperties,omitempty"`
	// The title, subtitle, and icon for the activity as determined by Selection Screen data, if there is any for this activity. There won't be data in this field if the activity is never shown in a selection/options screen.
	SelectionScreenDisplayProperties *AllOfDestinyDefinitionsDestinyActivityDefinitionSelectionScreenDisplayProperties `json:"selectionScreenDisplayProperties,omitempty"`
	// If the activity has an icon associated with a specific release (such as a DLC), this is the path to that release's icon.
	ReleaseIcon string `json:"releaseIcon,omitempty"`
	// If the activity will not be visible until a specific and known time, this will be the seconds since the Epoch when it will become visible.
	ReleaseTime int32 `json:"releaseTime,omitempty"`
	// The recommended light level for this activity.
	ActivityLightLevel int32 `json:"activityLightLevel,omitempty"`
	// The hash identifier for the Destination on which this Activity is played. Use it to look up the DestinyDestinationDefinition for human readable info about the destination. A Destination can be thought of as a more specific location than a \"Place\". For instance, if the \"Place\" is Earth, the \"Destination\" would be a specific city or region on Earth.
	DestinationHash int32 `json:"destinationHash,omitempty"`
	// The hash identifier for the \"Place\" on which this Activity is played. Use it to look up the DestinyPlaceDefinition for human readable info about the Place. A Place is the largest-scoped concept for location information. For instance, if the \"Place\" is Earth, the \"Destination\" would be a specific city or region on Earth.
	PlaceHash int32 `json:"placeHash,omitempty"`
	// The hash identifier for the Activity Type of this Activity. You may use it to look up the DestinyActivityTypeDefinition for human readable info, but be forewarned: Playlists and many PVP Map Activities will map to generic Activity Types. You'll have to use your knowledge of the Activity Mode being played to get more specific information about what the user is playing.
	ActivityTypeHash int32 `json:"activityTypeHash,omitempty"`
	// The difficulty tier of the activity.
	Tier int32 `json:"tier,omitempty"`
	// When Activities are completed, we generate a \"Post-Game Carnage Report\", or PGCR, with details about what happened in that activity (how many kills someone got, which team won, etc...) We use this image as the background when displaying PGCR information, and often use it when we refer to the Activity in general.
	PgcrImage string `json:"pgcrImage,omitempty"`
	// The expected possible rewards for the activity. These rewards may or may not be accessible for an individual player based on their character state, the account state, and even the game's state overall. But it is a useful reference for possible rewards you can earn in the activity. These match up to rewards displayed when you hover over the Activity in the in-game Director, and often refer to Placeholder or \"Dummy\" items: items that tell you what you can earn in vague terms rather than what you'll specifically be earning (partly because the game doesn't even know what you'll earn specifically until you roll for it at the end)
	Rewards []DestinyDefinitionsDestinyActivityRewardDefinition `json:"rewards,omitempty"`
	// Activities can have Modifiers, as defined in DestinyActivityModifierDefinition. These are references to the modifiers that *can* be applied to that activity, along with data that we use to determine if that modifier is actually active at any given point in time.
	Modifiers []DestinyDefinitionsDestinyActivityModifierReferenceDefinition `json:"modifiers,omitempty"`
	// If True, this Activity is actually a Playlist that refers to multiple possible specific Activities and Activity Modes. For instance, a Crucible Playlist may have references to multiple Activities (Maps) with multiple Activity Modes (specific PvP gameplay modes). If this is true, refer to the playlistItems property for the specific entries in the playlist.
	IsPlaylist bool `json:"isPlaylist,omitempty"`
	// An activity can have many Challenges, of which any subset of them may be active for play at any given period of time. This gives the information about the challenges and data that we use to understand when they're active and what rewards they provide. Sadly, at the moment there's no central definition for challenges: much like \"Skulls\" were in Destiny 1, these are defined on individual activities and there can be many duplicates/near duplicates across the Destiny 2 ecosystem. I have it in mind to centralize these in a future revision of the API, but we are out of time.
	Challenges []DestinyDefinitionsDestinyActivityChallengeDefinition `json:"challenges,omitempty"`
	// If there are status strings related to the activity and based on internal state of the game, account, or character, then this will be the definition of those strings and the states needed in order for the strings to be shown.
	OptionalUnlockStrings []DestinyDefinitionsDestinyActivityUnlockStringDefinition `json:"optionalUnlockStrings,omitempty"`
	// Represents all of the possible activities that could be played in the Playlist, along with information that we can use to determine if they are active at the present time.
	PlaylistItems []DestinyDefinitionsDestinyActivityPlaylistItemDefinition `json:"playlistItems,omitempty"`
	// Unfortunately, in practice this is almost never populated. In theory, this is supposed to tell which Activity Graph to show if you bring up the director while in this activity.
	ActivityGraphList []DestinyDefinitionsDestinyActivityGraphListEntryDefinition `json:"activityGraphList,omitempty"`
	// This block of data provides information about the Activity's matchmaking attributes: how many people can join and such.
	Matchmaking *AllOfDestinyDefinitionsDestinyActivityDefinitionMatchmaking `json:"matchmaking,omitempty"`
	// This block of data, if it exists, provides information about the guided game experience and restrictions for this activity. If it doesn't exist, the game is not able to be played as a guided game.
	GuidedGame *AllOfDestinyDefinitionsDestinyActivityDefinitionGuidedGame `json:"guidedGame,omitempty"`
	// If this activity had an activity mode directly defined on it, this will be the hash of that mode.
	DirectActivityModeHash int32 `json:"directActivityModeHash,omitempty"`
	// If the activity had an activity mode directly defined on it, this will be the enum value of that mode.
	DirectActivityModeType int32 `json:"directActivityModeType,omitempty"`
	// The set of all possible loadout requirements that could be active for this activity. Only one will be active at any given time, and you can discover which one through activity-associated data such as Milestones that have activity info on them.
	Loadouts []DestinyDefinitionsDestinyActivityLoadoutRequirementSet `json:"loadouts,omitempty"`
	// The hash identifiers for Activity Modes relevant to this activity.  Note that if this is a playlist, the specific playlist entry chosen will determine the actual activity modes that end up being relevant.
	ActivityModeHashes []int32 `json:"activityModeHashes,omitempty"`
	// The activity modes - if any - in enum form. Because we can't seem to escape the enums.
	ActivityModeTypes []int32 `json:"activityModeTypes,omitempty"`
	// If true, this activity is a PVP activity or playlist.
	IsPvP bool `json:"isPvP,omitempty"`
	// The list of phases or points of entry into an activity, along with information we can use to determine their gating and availability.
	InsertionPoints []DestinyDefinitionsDestinyActivityInsertionPointDefinition `json:"insertionPoints,omitempty"`
	// A list of location mappings that are affected by this activity. Pulled out of DestinyLocationDefinitions for our/your lookup convenience.
	ActivityLocationMappings []DestinyConstantsDestinyEnvironmentLocationMapping `json:"activityLocationMappings,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

The static data about Activities in Destiny 2. Note that an Activity must be combined with an ActivityMode to know - from a Gameplay perspective - what the user is \"Playing\". In most PvE activities, this is fairly straightforward. A Story Activity can only be played in the Story Activity Mode. However, in PvP activities, the Activity alone only tells you the map being played, or the Playlist that the user chose to enter. You'll need to know the Activity Mode they're playing to know that they're playing Mode X on Map Y. Activity Definitions tell a great deal of information about what *could* be relevant to a user: what rewards they can earn, what challenges could be performed, what modifiers could be applied. To figure out which of these properties is actually live, you'll need to combine the definition with \"Live\" data from one of the Destiny endpoints. Activities also have Activity Types, but unfortunately in Destiny 2 these are even less reliable of a source of information than they were in Destiny 1. I will be looking into ways to provide more reliable sources for type information as time goes on, but for now we're going to have to deal with the limitations. See DestinyActivityTypeDefinition for more information.

type DestinyDefinitionsDestinyActivityGraphListEntryDefinition ¶

type DestinyDefinitionsDestinyActivityGraphListEntryDefinition struct {
	// The hash identifier of the DestinyActivityGraphDefinition that should be shown when opening the director.
	ActivityGraphHash int32 `json:"activityGraphHash,omitempty"`
}

Destinations and Activities may have default Activity Graphs that should be shown when you bring up the Director and are playing in either. This contract defines the graph referred to and the gating for when it is relevant.

type DestinyDefinitionsDestinyActivityGuidedBlockDefinition ¶

type DestinyDefinitionsDestinyActivityGuidedBlockDefinition struct {
	// The maximum amount of people that can be in the waiting lobby.
	GuidedMaxLobbySize int32 `json:"guidedMaxLobbySize,omitempty"`
	// The minimum amount of people that can be in the waiting lobby.
	GuidedMinLobbySize int32 `json:"guidedMinLobbySize,omitempty"`
	// If -1, the guided group cannot be disbanded. Otherwise, take the total # of players in the activity and subtract this number: that is the total # of votes needed for the guided group to disband.
	GuidedDisbandCount int32 `json:"guidedDisbandCount,omitempty"`
}

Guided Game information for this activity.

type DestinyDefinitionsDestinyActivityInsertionPointDefinition ¶

type DestinyDefinitionsDestinyActivityInsertionPointDefinition struct {
	// A unique hash value representing the phase. This can be useful for, for example, comparing how different instances of Raids have phases in different orders!
	PhaseHash int32 `json:"phaseHash,omitempty"`
}

A point of entry into an activity, gated by an unlock flag and with some more-or-less useless (for our purposes) phase information. I'm including it in case we end up being able to bolt more useful information onto it in the future. UPDATE: Turns out this information isn't actually useless, and is in fact actually useful for people. Who would have thought? We still don't have localized info for it, but at least this will help people when they're looking at phase indexes in stats data, or when they want to know what phases have been completed on a weekly achievement.

type DestinyDefinitionsDestinyActivityLoadoutRequirement ¶

type DestinyDefinitionsDestinyActivityLoadoutRequirement struct {
	EquipmentSlotHash         int32   `json:"equipmentSlotHash,omitempty"`
	AllowedEquippedItemHashes []int32 `json:"allowedEquippedItemHashes,omitempty"`
	AllowedWeaponSubTypes     []int32 `json:"allowedWeaponSubTypes,omitempty"`
}

type DestinyDefinitionsDestinyActivityLoadoutRequirementSet ¶

type DestinyDefinitionsDestinyActivityLoadoutRequirementSet struct {
	// The set of requirements that will be applied on the activity if this requirement set is active.
	Requirements []DestinyDefinitionsDestinyActivityLoadoutRequirement `json:"requirements,omitempty"`
}

type DestinyDefinitionsDestinyActivityMatchmakingBlockDefinition ¶

type DestinyDefinitionsDestinyActivityMatchmakingBlockDefinition struct {
	// If TRUE, the activity is matchmade. Otherwise, it requires explicit forming of a party.
	IsMatchmade bool `json:"isMatchmade,omitempty"`
	// The minimum # of people in the fireteam for the activity to launch.
	MinParty int32 `json:"minParty,omitempty"`
	// The maximum # of people allowed in a Fireteam.
	MaxParty int32 `json:"maxParty,omitempty"`
	// The maximum # of people allowed across all teams in the activity.
	MaxPlayers int32 `json:"maxPlayers,omitempty"`
	// If true, you have to Solemnly Swear to be up to Nothing But Good(tm) to play.
	RequiresGuardianOath bool `json:"requiresGuardianOath,omitempty"`
}

Information about matchmaking and party size for the activity.

type DestinyDefinitionsDestinyActivityModeDefinition ¶

type DestinyDefinitionsDestinyActivityModeDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// If this activity mode has a related PGCR image, this will be the path to said image.
	PgcrImage string `json:"pgcrImage,omitempty"`
	// The Enumeration value for this Activity Mode. Pass this identifier into Stats endpoints to get aggregate stats for this mode.
	ModeType int32 `json:"modeType,omitempty"`
	// The type of play being performed in broad terms (PVP, PVE)
	ActivityModeCategory int32 `json:"activityModeCategory,omitempty"`
	// If True, this mode has oppositional teams fighting against each other rather than \"Free-For-All\" or Co-operative modes of play.  Note that Aggregate modes are never marked as team based, even if they happen to be team based at the moment. At any time, an aggregate whose subordinates are only team based could be changed so that one or more aren't team based, and then this boolean won't make much sense (the aggregation would become \"sometimes team based\"). Let's not deal with that right now.
	IsTeamBased bool `json:"isTeamBased,omitempty"`
	// If true, this mode is an aggregation of other, more specific modes rather than being a mode in itself. This includes modes that group Features/Events rather than Gameplay, such as Trials of The Nine: Trials of the Nine being an Event that is interesting to see aggregate data for, but when you play the activities within Trials of the Nine they are more specific activity modes such as Clash.
	IsAggregateMode bool `json:"isAggregateMode,omitempty"`
	// The hash identifiers of the DestinyActivityModeDefinitions that represent all of the \"parent\" modes for this mode. For instance, the Nightfall Mode is also a member of AllStrikes and AllPvE.
	ParentHashes []int32 `json:"parentHashes,omitempty"`
	// A Friendly identifier you can use for referring to this Activity Mode. We really only used this in our URLs, so... you know, take that for whatever it's worth.
	FriendlyName string `json:"friendlyName,omitempty"`
	// If this exists, the mode has specific Activities (referred to by the Key) that should instead map to other Activity Modes when they are played. This was useful in D1 for Private Matches, where we wanted to have Private Matches as an activity mode while still referring to the specific mode being played.
	ActivityModeMappings map[string]int32 `json:"activityModeMappings,omitempty"`
	// If FALSE, we want to ignore this type when we're showing activity modes in BNet UI. It will still be returned in case 3rd parties want to use it for any purpose.
	Display bool `json:"display,omitempty"`
	// The relative ordering of activity modes.
	Order int32 `json:"order,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

This definition represents an \"Activity Mode\" as it exists in the Historical Stats endpoints. An individual Activity Mode represents a collection of activities that are played in a certain way. For example, Nightfall Strikes are part of a \"Nightfall\" activity mode, and any activities played as the PVP mode \"Clash\" are part of the \"Clash activity mode. Activity modes are nested under each other in a hierarchy, so that if you ask for - for example - \"AllPvP\", you will get any PVP activities that the user has played, regardless of what specific PVP mode was being played.

type DestinyDefinitionsDestinyActivityModifierReferenceDefinition ¶

type DestinyDefinitionsDestinyActivityModifierReferenceDefinition struct {
	// The hash identifier for the DestinyActivityModifierDefinition referenced by this activity.
	ActivityModifierHash int32 `json:"activityModifierHash,omitempty"`
}

A reference to an Activity Modifier from another entity, such as an Activity (for now, just Activities). This defines some

type DestinyDefinitionsDestinyActivityPlaylistItemDefinition ¶

type DestinyDefinitionsDestinyActivityPlaylistItemDefinition struct {
	// The hash identifier of the Activity that can be played. Use it to look up the DestinyActivityDefinition.
	ActivityHash int32 `json:"activityHash,omitempty"`
	// If this playlist entry had an activity mode directly defined on it, this will be the hash of that mode.
	DirectActivityModeHash int32 `json:"directActivityModeHash,omitempty"`
	// If the playlist entry had an activity mode directly defined on it, this will be the enum value of that mode.
	DirectActivityModeType int32 `json:"directActivityModeType,omitempty"`
	// The hash identifiers for Activity Modes relevant to this entry.
	ActivityModeHashes []int32 `json:"activityModeHashes,omitempty"`
	// The activity modes - if any - in enum form. Because we can't seem to escape the enums.
	ActivityModeTypes []int32 `json:"activityModeTypes,omitempty"`
}

If the activity is a playlist, this is the definition for a specific entry in the playlist: a single possible combination of Activity and Activity Mode that can be chosen.

type DestinyDefinitionsDestinyActivityRewardDefinition ¶

type DestinyDefinitionsDestinyActivityRewardDefinition struct {
	// The header for the reward set, if any.
	RewardText string `json:"rewardText,omitempty"`
	// The \"Items provided\" in the reward. This is almost always a pointer to a DestinyInventoryItemDefintion for an item that you can't actually earn in-game, but that has name/description/icon information for the vague concept of the rewards you will receive. This is because the actual reward generation is non-deterministic and extremely complicated, so the best the game can do is tell you what you'll get in vague terms. And so too shall we.  Interesting trivia: you actually *do* earn these items when you complete the activity. They go into a single-slot bucket on your profile, which is how you see the pop-ups of these rewards when you complete an activity that match these \"dummy\" items. You can even see them if you look at the last one you earned in your profile-level inventory through the BNet API! Who said reading documentation is a waste of time?
	RewardItems []DestinyDestinyItemQuantity `json:"rewardItems,omitempty"`
}

Activities can refer to one or more sets of tooltip-friendly reward data. These are the definitions for those tooltip friendly rewards.

type DestinyDefinitionsDestinyActivityTypeDefinition ¶

type DestinyDefinitionsDestinyActivityTypeDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

The definition for an Activity Type. In Destiny 2, an Activity Type represents a conceptual categorization of Activities. These are most commonly used in the game for the subtitle under Activities, but BNet uses them extensively to identify and group activities by their common properties. Unfortunately, there has been a movement away from providing the richer data in Destiny 2 that we used to get in Destiny 1 for Activity Types. For instance, Nightfalls are grouped under the same Activity Type as regular Strikes. For this reason, BNet will eventually migrate toward Activity Modes as a better indicator of activity category. But for the time being, it is still referred to in many places across our codebase.

type DestinyDefinitionsDestinyActivityUnlockStringDefinition ¶

type DestinyDefinitionsDestinyActivityUnlockStringDefinition struct {
	// The string to be displayed if the conditions are met.
	DisplayString string `json:"displayString,omitempty"`
}

Represents a status string that could be conditionally displayed about an activity. Note that externally, you can only see the strings themselves. Internally we combine this information with server state to determine which strings should be shown.

type DestinyDefinitionsDestinyArrangementRegionFilterDefinition ¶

type DestinyDefinitionsDestinyArrangementRegionFilterDefinition struct {
	ArtArrangementRegionHash    int32            `json:"artArrangementRegionHash,omitempty"`
	ArtArrangementRegionIndex   int32            `json:"artArrangementRegionIndex,omitempty"`
	StatHash                    int32            `json:"statHash,omitempty"`
	ArrangementIndexByStatValue map[string]int32 `json:"arrangementIndexByStatValue,omitempty"`
}

type DestinyDefinitionsDestinyArtDyeReference ¶

type DestinyDefinitionsDestinyArtDyeReference struct {
	ArtDyeChannelHash int32 `json:"artDyeChannelHash,omitempty"`
}

type DestinyDefinitionsDestinyBubbleDefinition ¶

type DestinyDefinitionsDestinyBubbleDefinition struct {
	// The identifier for the bubble: only guaranteed to be unique within the Destination.
	Hash int32 `json:"hash,omitempty"`
	// The display properties of this bubble, so you don't have to look them up in a separate list anymore.
	DisplayProperties *AllOfDestinyDefinitionsDestinyBubbleDefinitionDisplayProperties `json:"displayProperties,omitempty"`
}

Basic identifying data about the bubble. Combine with DestinyDestinationBubbleSettingDefinition - see DestinyDestinationDefinition.bubbleSettings for more information.

type DestinyDefinitionsDestinyClassDefinition ¶

type DestinyDefinitionsDestinyClassDefinition struct {
	// In Destiny 1, we added a convenience Enumeration for referring to classes. We've kept it, though mostly for posterity. This is the enum value for this definition's class.
	ClassType         int32                                                       `json:"classType,omitempty"`
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// A localized string referring to the singular form of the Class's name when referred to in gendered form. Keyed by the DestinyGender.
	GenderedClassNames             map[string]string `json:"genderedClassNames,omitempty"`
	GenderedClassNamesByGenderHash map[string]string `json:"genderedClassNamesByGenderHash,omitempty"`
	// Mentors don't really mean anything anymore. Don't expect this to be populated.
	MentorVendorHash int32 `json:"mentorVendorHash,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

Defines a Character Class in Destiny 2. These are types of characters you can play, like Titan, Warlock, and Hunter.

type DestinyDefinitionsDestinyDamageTypeDefinition ¶

type DestinyDefinitionsDestinyDamageTypeDefinition struct {
	// The description of the damage type, icon etc...
	DisplayProperties *AllOfDestinyDefinitionsDestinyDamageTypeDefinitionDisplayProperties `json:"displayProperties,omitempty"`
	// A variant of the icon that is transparent and colorless.
	TransparentIconPath string `json:"transparentIconPath,omitempty"`
	// If TRUE, the game shows this damage type's icon. Otherwise, it doesn't. Whether you show it or not is up to you.
	ShowIcon bool `json:"showIcon,omitempty"`
	// We have an enumeration for damage types for quick reference. This is the current definition's damage type enum value.
	EnumValue int32 `json:"enumValue,omitempty"`
	// A color associated with the damage type. The displayProperties icon is tinted with a color close to this.
	Color *AllOfDestinyDefinitionsDestinyDamageTypeDefinitionColor `json:"color,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

All damage types that are possible in the game are defined here, along with localized info and icons as needed.

type DestinyDefinitionsDestinyDefinition ¶

type DestinyDefinitionsDestinyDefinition struct {
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

Provides common properties for destiny definitions.

type DestinyDefinitionsDestinyDestinationBubbleSettingDefinition ¶

type DestinyDefinitionsDestinyDestinationBubbleSettingDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
}

Human readable data about the bubble. Combine with DestinyBubbleDefinition - see DestinyDestinationDefinition.bubbleSettings for more information. DEPRECATED - Just use bubbles.

type DestinyDefinitionsDestinyDestinationDefinition ¶

type DestinyDefinitionsDestinyDestinationDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// The place that \"owns\" this Destination. Use this hash to look up the DestinyPlaceDefinition.
	PlaceHash int32 `json:"placeHash,omitempty"`
	// If this Destination has a default Free-Roam activity, this is the hash for that Activity. Use it to look up the DestinyActivityDefintion.
	DefaultFreeroamActivityHash int32 `json:"defaultFreeroamActivityHash,omitempty"`
	// If the Destination has default Activity Graphs (i.e. \"Map\") that should be shown in the director, this is the list of those Graphs. At most, only one should be active at any given time for a Destination: these would represent, for example, different variants on a Map if the Destination is changing on a macro level based on game state.
	ActivityGraphEntries []DestinyDefinitionsDestinyActivityGraphListEntryDefinition `json:"activityGraphEntries,omitempty"`
	// A Destination may have many \"Bubbles\" zones with human readable properties.  We don't get as much info as I'd like about them - I'd love to return info like where on the map they are located - but at least this gives you the name of those bubbles. bubbleSettings and bubbles both have the identical number of entries, and you should match up their indexes to provide matching bubble and bubbleSettings data.  DEPRECATED - Just use bubbles, it now has this data.
	BubbleSettings []DestinyDefinitionsDestinyDestinationBubbleSettingDefinition `json:"bubbleSettings,omitempty"`
	// This provides the unique identifiers for every bubble in the destination (only guaranteed unique within the destination), and any intrinsic properties of the bubble.  bubbleSettings and bubbles both have the identical number of entries, and you should match up their indexes to provide matching bubble and bubbleSettings data.
	Bubbles []DestinyDefinitionsDestinyBubbleDefinition `json:"bubbles,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

On to one of the more confusing subjects of the API. What is a Destination, and what is the relationship between it, Activities, Locations, and Places? A \"Destination\" is a specific region/city/area of a larger \"Place\". For instance, a Place might be Earth where a Destination might be Bellevue, Washington. (Please, pick a more interesting destination if you come to visit Earth).

type DestinyDefinitionsDestinyDisplayCategoryDefinition ¶

type DestinyDefinitionsDestinyDisplayCategoryDefinition struct {
	Index int32 `json:"index,omitempty"`
	// A string identifier for the display category.
	Identifier          string                                                      `json:"identifier,omitempty"`
	DisplayCategoryHash int32                                                       `json:"displayCategoryHash,omitempty"`
	DisplayProperties   *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// If true, this category should be displayed in the \"Banner\" section of the vendor's UI.
	DisplayInBanner bool `json:"displayInBanner,omitempty"`
	// If it exists, this is the hash identifier of a DestinyProgressionDefinition that represents the progression to show on this display category.  Specific categories can now have thier own distinct progression, apparently. So that's cool.
	ProgressionHash int32 `json:"progressionHash,omitempty"`
	// If this category sorts items in a nonstandard way, this will be the way we sort.
	SortOrder int32 `json:"sortOrder,omitempty"`
	// An indicator of how the category will be displayed in the UI. It's up to you to do something cool or interesting in response to this, or just to treat it as a normal category.
	DisplayStyleHash int32 `json:"displayStyleHash,omitempty"`
	// An indicator of how the category will be displayed in the UI. It's up to you to do something cool or interesting in response to this, or just to treat it as a normal category.
	DisplayStyleIdentifier string `json:"displayStyleIdentifier,omitempty"`
}

Display Categories are different from \"categories\" in that these are specifically for visual grouping and display of categories in Vendor UI. The \"categories\" structure is for validation of the contained items, and can be categorized entirely separately from \"Display Categories\", there need be and often will be no meaningful relationship between the two.

type DestinyDefinitionsDestinyEntitySearchResult ¶

type DestinyDefinitionsDestinyEntitySearchResult struct {
	// A list of suggested words that might make for better search results, based on the text searched for.
	SuggestedWords []string `json:"suggestedWords,omitempty"`
	// The items found that are matches/near matches for the searched-for term, sorted by something vaguely resembling \"relevance\". Hopefully this will get better in the future.
	Results *AllOfDestinyDefinitionsDestinyEntitySearchResultResults `json:"results,omitempty"`
}

The results of a search for Destiny content. This will be improved on over time, I've been doing some experimenting to see what might be useful.

type DestinyDefinitionsDestinyEntitySearchResultItem ¶

type DestinyDefinitionsDestinyEntitySearchResultItem struct {
	// The hash identifier of the entity. You will use this to look up the DestinyDefinition relevant for the entity found.
	Hash int32 `json:"hash,omitempty"`
	// The type of entity, returned as a string matching the DestinyDefinition's contract class name. You'll have to have your own mapping from class names to actually looking up those definitions in the manifest databases.
	EntityType string `json:"entityType,omitempty"`
	// Basic display properties on the entity, so you don't have to look up the definition to show basic results for the item.
	DisplayProperties *AllOfDestinyDefinitionsDestinyEntitySearchResultItemDisplayProperties `json:"displayProperties,omitempty"`
	// The ranking value for sorting that we calculated using our relevance formula. This will hopefully get better with time and iteration.
	Weight float64 `json:"weight,omitempty"`
}

An individual Destiny Entity returned from the entity search.

type DestinyDefinitionsDestinyEquipmentSlotDefinition ¶

type DestinyDefinitionsDestinyEquipmentSlotDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// These technically point to \"Equipment Category Definitions\". But don't get excited. There's nothing of significant value in those definitions, so I didn't bother to expose them. You can use the hash here to group equipment slots by common functionality, which serves the same purpose as if we had the Equipment Category definitions exposed.
	EquipmentCategoryHash int32 `json:"equipmentCategoryHash,omitempty"`
	// The inventory bucket that owns this equipment slot.
	BucketTypeHash int32 `json:"bucketTypeHash,omitempty"`
	// If True, equipped items should have their custom art dyes applied when rendering the item. Otherwise, custom art dyes on an item should be ignored if the item is equipped in this slot.
	ApplyCustomArtDyes bool `json:"applyCustomArtDyes,omitempty"`
	// The Art Dye Channels that apply to this equipment slot.
	ArtDyeChannels []DestinyDefinitionsDestinyArtDyeReference `json:"artDyeChannels,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

Characters can not only have Inventory buckets (containers of items that are generally matched by their type or functionality), they can also have Equipment Slots. The Equipment Slot is an indicator that the related bucket can have instanced items equipped on the character. For instance, the Primary Weapon bucket has an Equipment Slot that determines whether you can equip primary weapons, and holds the association between its slot and the inventory bucket from which it can have items equipped. An Equipment Slot must have a related Inventory Bucket, but not all inventory buckets must have Equipment Slots.

type DestinyDefinitionsDestinyEquippingBlockDefinition ¶

type DestinyDefinitionsDestinyEquippingBlockDefinition struct {
	// If the item is part of a gearset, this is a reference to that gearset item.
	GearsetItemHash int32 `json:"gearsetItemHash,omitempty"`
	// If defined, this is the label used to check if the item has other items of matching types already equipped.   For instance, when you aren't allowed to equip more than one Exotic Weapon, that's because all exotic weapons have identical uniqueLabels and the game checks the to-be-equipped item's uniqueLabel vs. all other already equipped items (other than the item in the slot that's about to be occupied).
	UniqueLabel string `json:"uniqueLabel,omitempty"`
	// The hash of that unique label. Does not point to a specific definition.
	UniqueLabelHash int32 `json:"uniqueLabelHash,omitempty"`
	// An equipped item *must* be equipped in an Equipment Slot. This is the hash identifier of the DestinyEquipmentSlotDefinition into which it must be equipped.
	EquipmentSlotTypeHash int32 `json:"equipmentSlotTypeHash,omitempty"`
	// These are custom attributes on the equippability of the item.  For now, this can only be \"equip on acquire\", which would mean that the item will be automatically equipped as soon as you pick it up.
	Attributes int32 `json:"attributes,omitempty"`
	// Ammo type used by a weapon is no longer determined by the bucket in which it is contained. If the item has an ammo type - i.e. if it is a weapon - this will be the type of ammunition expected.
	AmmoType int32 `json:"ammoType,omitempty"`
	// These are strings that represent the possible Game/Account/Character state failure conditions that can occur when trying to equip the item. They match up one-to-one with requiredUnlockExpressions.
	DisplayStrings []string `json:"displayStrings,omitempty"`
}

Items that can be equipped define this block. It contains information we need to understand how and when the item can be equipped.

type DestinyDefinitionsDestinyFactionDefinition ¶

type DestinyDefinitionsDestinyFactionDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// The hash identifier for the DestinyProgressionDefinition that indicates the character's relationship with this faction in terms of experience and levels.
	ProgressionHash int32 `json:"progressionHash,omitempty"`
	// The faction token item hashes, and their respective progression values.
	TokenValues map[string]int32 `json:"tokenValues,omitempty"`
	// The faction reward item hash, usually an engram.
	RewardItemHash int32 `json:"rewardItemHash,omitempty"`
	// The faction reward vendor hash, used for faction engram previews.
	RewardVendorHash int32 `json:"rewardVendorHash,omitempty"`
	// List of vendors that are associated with this faction. The last vendor that passes the unlock flag checks is the one that should be shown.
	Vendors []DestinyDefinitionsDestinyFactionVendorDefinition `json:"vendors,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

These definitions represent Factions in the game. Factions have ended up unilaterally being related to Vendors that represent them, but that need not necessarily be the case. A Faction is really just an entity that has a related progression for which a character can gain experience. In Destiny 1, Dead Orbit was an example of a Faction: there happens to be a Vendor that represents Dead Orbit (and indeed, DestinyVendorDefinition.factionHash defines to this relationship), but Dead Orbit could theoretically exist without the Vendor that provides rewards.

type DestinyDefinitionsDestinyFactionVendorDefinition ¶

type DestinyDefinitionsDestinyFactionVendorDefinition struct {
	// The faction vendor hash.
	VendorHash int32 `json:"vendorHash,omitempty"`
	// The hash identifier for a Destination at which this vendor may be located. Each destination where a Vendor may exist will only ever have a single entry.
	DestinationHash int32 `json:"destinationHash,omitempty"`
	// The relative path to the background image representing this Vendor at this location, for use in a banner.
	BackgroundImagePath string `json:"backgroundImagePath,omitempty"`
}

These definitions represent faction vendors at different points in the game. A single faction may contain multiple vendors, or the same vendor available at two different locations.

type DestinyDefinitionsDestinyGearArtArrangementReference ¶

type DestinyDefinitionsDestinyGearArtArrangementReference struct {
	ClassHash          int32 `json:"classHash,omitempty"`
	ArtArrangementHash int32 `json:"artArrangementHash,omitempty"`
}

type DestinyDefinitionsDestinyGenderDefinition ¶

type DestinyDefinitionsDestinyGenderDefinition struct {
	// This is a quick reference enumeration for all of the currently defined Genders. We use the enumeration for quicker lookups in related data, like DestinyClassDefinition.genderedClassNames.
	GenderType        int32                                                       `json:"genderType,omitempty"`
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

Gender is a social construct, and as such we have definitions for Genders. Right now there happens to only be two, but we'll see what the future holds.

type DestinyDefinitionsDestinyInventoryBucketDefinition ¶

type DestinyDefinitionsDestinyInventoryBucketDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// Where the bucket is found. 0 = Character, 1 = Account
	Scope int32 `json:"scope,omitempty"`
	// An enum value for what items can be found in the bucket. See the BucketCategory enum for more details.
	Category int32 `json:"category,omitempty"`
	// Use this property to provide a quick-and-dirty recommended ordering for buckets in the UI. Most UIs will likely want to forsake this for something more custom and manual.
	BucketOrder int32 `json:"bucketOrder,omitempty"`
	// The maximum # of item \"slots\" in a bucket. A slot is a given combination of item + quantity.  For instance, a Weapon will always take up a single slot, and always have a quantity of 1. But a material could take up only a single slot with hundreds of quantity.
	ItemCount int32 `json:"itemCount,omitempty"`
	// Sometimes, inventory buckets represent conceptual \"locations\" in the game that might not be expected. This value indicates the conceptual location of the bucket, regardless of where it is actually contained on the character/account.   See ItemLocation for details.   Note that location includes the Vault and the Postmaster (both of whom being just inventory buckets with additional actions that can be performed on them through a Vendor)
	Location int32 `json:"location,omitempty"`
	// If TRUE, there is at least one Vendor that can transfer items to/from this bucket. See the DestinyVendorDefinition's acceptedItems property for more information on how transferring works.
	HasTransferDestination bool `json:"hasTransferDestination,omitempty"`
	// If True, this bucket is enabled. Disabled buckets may include buckets that were included for test purposes, or that were going to be used but then were abandoned but never removed from content *cough*.
	Enabled bool `json:"enabled,omitempty"`
	// if a FIFO bucket fills up, it will delete the oldest item from said bucket when a new item tries to be added to it. If this is FALSE, the bucket will not allow new items to be placed in it until room is made by the user manually deleting items from it. You can see an example of this with the Postmaster's bucket.
	Fifo bool `json:"fifo,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

An Inventory (be it Character or Profile level) is comprised of many Buckets. An example of a bucket is \"Primary Weapons\", where all of the primary weapons on a character are gathered together into a single visual element in the UI: a subset of the inventory that has a limited number of slots, and in this case also has an associated Equipment Slot for equipping an item in the bucket. Item definitions declare what their \"default\" bucket is (DestinyInventoryItemDefinition.inventory.bucketTypeHash), and Item instances will tell you which bucket they are currently residing in (DestinyItemComponent.bucketHash). You can use this information along with the DestinyInventoryBucketDefinition to show these items grouped by bucket. You cannot transfer an item to a bucket that is not its Default without going through a Vendor's \"accepted items\" (DestinyVendorDefinition.acceptedItems). This is how transfer functionality like the Vault is implemented, as a feature of a Vendor. See the vendor's acceptedItems property for more details.

type DestinyDefinitionsDestinyInventoryItemDefinition ¶

type DestinyDefinitionsDestinyInventoryItemDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// Tooltips that only come up conditionally for the item. Check the live data DestinyItemComponent.tooltipNotificationIndexes property for which of these should be shown at runtime.
	TooltipNotifications []DestinyDefinitionsDestinyItemTooltipNotification `json:"tooltipNotifications,omitempty"`
	// If this item has a collectible related to it, this is the hash identifier of that collectible entry.
	CollectibleHash int32 `json:"collectibleHash,omitempty"`
	// If available, this is the original 'active' release watermark overlay for the icon. If the item has different versions, this can be overridden by the 'display version watermark icon' from the 'quality' block. Alternatively, if there is no watermark for the version, and the item version has a power cap below the current season power cap, this can be overridden by the iconWatermarkShelved property.
	IconWatermark string `json:"iconWatermark,omitempty"`
	// If available, this is the 'shelved' release watermark overlay for the icon. If the item version has a power cap below the current season power cap, it can be treated as 'shelved', and should be shown with this 'shelved' watermark overlay.
	IconWatermarkShelved string `json:"iconWatermarkShelved,omitempty"`
	// A secondary icon associated with the item. Currently this is used in very context specific applications, such as Emblem Nameplates.
	SecondaryIcon string `json:"secondaryIcon,omitempty"`
	// Pulled from the secondary icon, this is the \"secondary background\" of the secondary icon. Confusing? Sure, that's why I call it \"overlay\" here: because as far as it's been used thus far, it has been for an optional overlay image. We'll see if that holds up, but at least for now it explains what this image is a bit better.
	SecondaryOverlay string `json:"secondaryOverlay,omitempty"`
	// Pulled from the Secondary Icon, this is the \"special\" background for the item. For Emblems, this is the background image used on the Details view: but it need not be limited to that for other types of items.
	SecondarySpecial string `json:"secondarySpecial,omitempty"`
	// Sometimes, an item will have a background color. Most notably this occurs with Emblems, who use the Background Color for small character nameplates such as the \"friends\" view you see in-game. There are almost certainly other items that have background color as well, though I have not bothered to investigate what items have it nor what purposes they serve: use it as you will.
	BackgroundColor *AllOfDestinyDefinitionsDestinyInventoryItemDefinitionBackgroundColor `json:"backgroundColor,omitempty"`
	// If we were able to acquire an in-game screenshot for the item, the path to that screenshot will be returned here. Note that not all items have screenshots: particularly not any non-equippable items.
	Screenshot string `json:"screenshot,omitempty"`
	// The localized title/name of the item's type. This can be whatever the designers want, and has no guarantee of consistency between items.
	ItemTypeDisplayName string `json:"itemTypeDisplayName,omitempty"`
	FlavorText          string `json:"flavorText,omitempty"`
	// A string identifier that the game's UI uses to determine how the item should be rendered in inventory screens and the like. This could really be anything - at the moment, we don't have the time to really breakdown and maintain all the possible strings this could be, partly because new ones could be added ad hoc. But if you want to use it to dictate your own UI, or look for items with a certain display style, go for it!
	UiItemDisplayStyle string `json:"uiItemDisplayStyle,omitempty"`
	// It became a common enough pattern in our UI to show Item Type and Tier combined into a single localized string that I'm just going to go ahead and start pre-creating these for items.
	ItemTypeAndTierDisplayName string `json:"itemTypeAndTierDisplayName,omitempty"`
	// In theory, it is a localized string telling you about how you can find the item. I really wish this was more consistent. Many times, it has nothing. Sometimes, it's instead a more narrative-forward description of the item. Which is cool, and I wish all properties had that data, but it should really be its own property.
	DisplaySource string `json:"displaySource,omitempty"`
	// An identifier that the game UI uses to determine what type of tooltip to show for the item. These have no corresponding definitions that BNet can link to: so it'll be up to you to interpret and display your UI differently according to these styles (or ignore it).
	TooltipStyle string `json:"tooltipStyle,omitempty"`
	// If the item can be \"used\", this block will be non-null, and will have data related to the action performed when using the item. (Guess what? 99% of the time, this action is \"dismantle\". Shocker)
	Action *AllOfDestinyDefinitionsDestinyInventoryItemDefinitionAction `json:"action,omitempty"`
	// Recipe items will have relevant crafting information available here.
	Crafting *AllOfDestinyDefinitionsDestinyInventoryItemDefinitionCrafting `json:"crafting,omitempty"`
	// If this item can exist in an inventory, this block will be non-null. In practice, every item that currently exists has one of these blocks. But note that it is not necessarily guaranteed.
	Inventory *AllOfDestinyDefinitionsDestinyInventoryItemDefinitionInventory `json:"inventory,omitempty"`
	// If this item is a quest, this block will be non-null. In practice, I wish I had called this the Quest block, but at the time it wasn't clear to me whether it would end up being used for purposes other than quests. It will contain data about the steps in the quest, and mechanics we can use for displaying and tracking the quest.
	SetData *AllOfDestinyDefinitionsDestinyInventoryItemDefinitionSetData `json:"setData,omitempty"`
	// If this item can have stats (such as a weapon, armor, or vehicle), this block will be non-null and populated with the stats found on the item.
	Stats *AllOfDestinyDefinitionsDestinyInventoryItemDefinitionStats `json:"stats,omitempty"`
	// If the item is an emblem that has a special Objective attached to it - for instance, if the emblem tracks PVP Kills, or what-have-you. This is a bit different from, for example, the Vanguard Kill Tracker mod, which pipes data into the \"art channel\". When I get some time, I would like to standardize these so you can get at the values they expose without having to care about what they're being used for and how they are wired up, but for now here's the raw data.
	EmblemObjectiveHash int32 `json:"emblemObjectiveHash,omitempty"`
	// If this item can be equipped, this block will be non-null and will be populated with the conditions under which it can be equipped.
	EquippingBlock *AllOfDestinyDefinitionsDestinyInventoryItemDefinitionEquippingBlock `json:"equippingBlock,omitempty"`
	// If this item can be rendered, this block will be non-null and will be populated with rendering information.
	TranslationBlock *AllOfDestinyDefinitionsDestinyInventoryItemDefinitionTranslationBlock `json:"translationBlock,omitempty"`
	// If this item can be Used or Acquired to gain other items (for instance, how Eververse Boxes can be consumed to get items from the box), this block will be non-null and will give summary information for the items that can be acquired.
	Preview *AllOfDestinyDefinitionsDestinyInventoryItemDefinitionPreview `json:"preview,omitempty"`
	// If this item can have a level or stats, this block will be non-null and will be populated with default quality (item level, \"quality\", and infusion) data. See the block for more details, there's often less upfront information in D2 so you'll want to be aware of how you use quality and item level on the definition level now.
	Quality *AllOfDestinyDefinitionsDestinyInventoryItemDefinitionQuality `json:"quality,omitempty"`
	// The conceptual \"Value\" of an item, if any was defined. See the DestinyItemValueBlockDefinition for more details.
	Value *AllOfDestinyDefinitionsDestinyInventoryItemDefinitionValue `json:"value,omitempty"`
	// If this item has a known source, this block will be non-null and populated with source information. Unfortunately, at this time we are not generating sources: that is some aggressively manual work which we didn't have time for, and I'm hoping to get back to at some point in the future.
	SourceData *AllOfDestinyDefinitionsDestinyInventoryItemDefinitionSourceData `json:"sourceData,omitempty"`
	// If this item has Objectives (extra tasks that can be accomplished related to the item... most frequently when the item is a Quest Step and the Objectives need to be completed to move on to the next Quest Step), this block will be non-null and the objectives defined herein.
	Objectives *AllOfDestinyDefinitionsDestinyInventoryItemDefinitionObjectives `json:"objectives,omitempty"`
	// If this item has available metrics to be shown, this block will be non-null have the appropriate hashes defined.
	Metrics *AllOfDestinyDefinitionsDestinyInventoryItemDefinitionMetrics `json:"metrics,omitempty"`
	// If this item *is* a Plug, this will be non-null and the info defined herein. See DestinyItemPlugDefinition for more information.
	Plug *AllOfDestinyDefinitionsDestinyInventoryItemDefinitionPlug `json:"plug,omitempty"`
	// If this item has related items in a \"Gear Set\", this will be non-null and the relationships defined herein.
	Gearset *AllOfDestinyDefinitionsDestinyInventoryItemDefinitionGearset `json:"gearset,omitempty"`
	// If this item is a \"reward sack\" that can be opened to provide other items, this will be non-null and the properties of the sack contained herein.
	Sack *AllOfDestinyDefinitionsDestinyInventoryItemDefinitionSack `json:"sack,omitempty"`
	// If this item has any Sockets, this will be non-null and the individual sockets on the item will be defined herein.
	Sockets *AllOfDestinyDefinitionsDestinyInventoryItemDefinitionSockets `json:"sockets,omitempty"`
	// Summary data about the item.
	Summary *AllOfDestinyDefinitionsDestinyInventoryItemDefinitionSummary `json:"summary,omitempty"`
	// If the item has a Talent Grid, this will be non-null and the properties of the grid defined herein. Note that, while many items still have talent grids, the only ones with meaningful Nodes still on them will be Subclass/\"Build\" items.
	TalentGrid *AllOfDestinyDefinitionsDestinyInventoryItemDefinitionTalentGrid `json:"talentGrid,omitempty"`
	// If the item has stats, this block will be defined. It has the \"raw\" investment stats for the item. These investment stats don't take into account the ways that the items can spawn, nor do they take into account any Stat Group transformations. I have retained them for debugging purposes, but I do not know how useful people will find them.
	InvestmentStats []DestinyDefinitionsDestinyItemInvestmentStatDefinition `json:"investmentStats,omitempty"`
	// If the item has any *intrinsic* Perks (Perks that it will provide regardless of Sockets, Talent Grid, and other transitory state), they will be defined here.
	Perks []DestinyDefinitionsDestinyItemPerkEntryDefinition `json:"perks,omitempty"`
	// If the item has any related Lore (DestinyLoreDefinition), this will be the hash identifier you can use to look up the lore definition.
	LoreHash int32 `json:"loreHash,omitempty"`
	// There are times when the game will show you a \"summary/vague\" version of an item - such as a description of its type represented as a DestinyInventoryItemDefinition - rather than display the item itself.  This happens sometimes when summarizing possible rewards in a tooltip. This is the item displayed instead, if it exists.
	SummaryItemHash int32 `json:"summaryItemHash,omitempty"`
	// If any animations were extracted from game content for this item, these will be the definitions of those animations.
	Animations []DestinyDefinitionsAnimationsDestinyAnimationReference `json:"animations,omitempty"`
	// BNet may forbid the execution of actions on this item via the API. If that is occurring, allowActions will be set to false.
	AllowActions bool `json:"allowActions,omitempty"`
	// If we added any help or informational URLs about this item, these will be those links.
	Links []LinksHyperlinkReference `json:"links,omitempty"`
	// The boolean will indicate to us (and you!) whether something *could* happen when you transfer this item from the Postmaster that might be considered a \"destructive\" action.  It is not feasible currently to tell you (or ourelves!) in a consistent way whether this *will* actually cause a destructive action, so we are playing it safe: if it has the potential to do so, we will not allow it to be transferred from the Postmaster by default. You will need to check for this flag before transferring an item from the Postmaster, or else you'll end up receiving an error.
	DoesPostmasterPullHaveSideEffects bool `json:"doesPostmasterPullHaveSideEffects,omitempty"`
	// The intrinsic transferability of an item.  I hate that this boolean is negative - but there's a reason.  Just because an item is intrinsically transferrable doesn't mean that it can be transferred, and we don't want to imply that this is the only source of that transferability.
	NonTransferrable bool `json:"nonTransferrable,omitempty"`
	// BNet attempts to make a more formal definition of item \"Categories\", as defined by DestinyItemCategoryDefinition. This is a list of all Categories that we were able to algorithmically determine that this item is a member of. (for instance, that it's a \"Weapon\", that it's an \"Auto Rifle\", etc...)  The algorithm for these is, unfortunately, volatile. If you believe you see a miscategorized item, please let us know on the Bungie API forums.
	ItemCategoryHashes []int32 `json:"itemCategoryHashes,omitempty"`
	// In Destiny 1, we identified some items as having particular categories that we'd like to know about for various internal logic purposes. These are defined in SpecialItemType, and while these days the itemCategoryHashes are the preferred way of identifying types, we have retained this enum for its convenience.
	SpecialItemType int32 `json:"specialItemType,omitempty"`
	// A value indicating the \"base\" the of the item. This enum is a useful but dramatic oversimplification of what it means for an item to have a \"Type\". Still, it's handy in many situations.  itemCategoryHashes are the preferred way of identifying types, we have retained this enum for its convenience.
	ItemType int32 `json:"itemType,omitempty"`
	// A value indicating the \"sub-type\" of the item. For instance, where an item might have an itemType value \"Weapon\", this will be something more specific like \"Auto Rifle\".  itemCategoryHashes are the preferred way of identifying types, we have retained this enum for its convenience.
	ItemSubType int32 `json:"itemSubType,omitempty"`
	// We run a similarly weak-sauce algorithm to try and determine whether an item is restricted to a specific class. If we find it to be restricted in such a way, we set this classType property to match the class' enumeration value so that users can easily identify class restricted items.  If you see a mis-classed item, please inform the developers in the Bungie API forum.
	ClassType int32 `json:"classType,omitempty"`
	// Some weapons and plugs can have a \"Breaker Type\": a special ability that works sort of like damage type vulnerabilities. This is (almost?) always set on items by plugs.
	BreakerType int32 `json:"breakerType,omitempty"`
	// Since we also have a breaker type definition, this is the hash for that breaker type for your convenience. Whether you use the enum or hash and look up the definition depends on what's cleanest for your code.
	BreakerTypeHash int32 `json:"breakerTypeHash,omitempty"`
	// If true, then you will be allowed to equip the item if you pass its other requirements.  This being false means that you cannot equip the item under any circumstances.
	Equippable bool `json:"equippable,omitempty"`
	// Theoretically, an item can have many possible damage types. In *practice*, this is not true, but just in case weapons start being made that have multiple (for instance, an item where a socket has reusable plugs for every possible damage type that you can choose from freely), this field will return all of the possible damage types that are available to the weapon by default.
	DamageTypeHashes []int32 `json:"damageTypeHashes,omitempty"`
	// This is the list of all damage types that we know ahead of time the item can take on. Unfortunately, this does not preclude the possibility of something funky happening to give the item a damage type that cannot be predicted beforehand: for example, if some designer decides to create arbitrary non-reusable plugs that cause damage type to change.  This damage type prediction will only use the following to determine potential damage types:  - Intrinsic perks  - Talent Node perks  - Known, reusable plugs for sockets
	DamageTypes []int32 `json:"damageTypes,omitempty"`
	// If the item has a damage type that could be considered to be default, it will be populated here.  For various upsetting reasons, it's surprisingly cumbersome to figure this out. I hope you're happy.
	DefaultDamageType int32 `json:"defaultDamageType,omitempty"`
	// Similar to defaultDamageType, but represented as the hash identifier for a DestinyDamageTypeDefinition.  I will likely regret leaving in the enumeration versions of these properties, but for now they're very convenient.
	DefaultDamageTypeHash int32 `json:"defaultDamageTypeHash,omitempty"`
	// If this item is related directly to a Season of Destiny, this is the hash identifier for that season.
	SeasonHash int32 `json:"seasonHash,omitempty"`
	// If true, this is a dummy vendor-wrapped item template. Items purchased from Eververse will be \"wrapped\" by one of these items so that we can safely provide refund capabilities before the item is \"unwrapped\".
	IsWrapper bool `json:"isWrapper,omitempty"`
	// Traits are metadata tags applied to this item. For example: armor slot, weapon type, foundry, faction, etc. These IDs come from the game and don't map to any content, but should still be useful.
	TraitIds []string `json:"traitIds,omitempty"`
	// These are the corresponding trait definition hashes for the entries in traitIds.
	TraitHashes []int32 `json:"traitHashes,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

So much of what you see in Destiny is actually an Item used in a new and creative way. This is the definition for Items in Destiny, which started off as just entities that could exist in your Inventory but ended up being the backing data for so much more: quests, reward previews, slots, and subclasses. In practice, you will want to associate this data with \"live\" item data from a Bungie.Net Platform call: these definitions describe the item in generic, non-instanced terms: but an actual instance of an item can vary widely from these generic definitions.

type DestinyDefinitionsDestinyInventoryItemStatDefinition ¶

type DestinyDefinitionsDestinyInventoryItemStatDefinition struct {
	// The hash for the DestinyStatDefinition representing this stat.
	StatHash int32 `json:"statHash,omitempty"`
	// This value represents the stat value assuming the minimum possible roll but accounting for any mandatory bonuses that should be applied to the stat on item creation.  In Destiny 1, this was different from the \"minimum\" value because there were certain conditions where an item could be theoretically lower level/value than the initial roll.   In Destiny 2, this is not possible unless Talent Grids begin to be used again for these purposes or some other system change occurs... thus in practice, value and minimum should be the same in Destiny 2. Good riddance.
	Value int32 `json:"value,omitempty"`
	// The minimum possible value for this stat that we think the item can roll.
	Minimum int32 `json:"minimum,omitempty"`
	// The maximum possible value for this stat that we think the item can roll.  WARNING: In Destiny 1, this field was calculated using the potential stat rolls on the item's talent grid. In Destiny 2, items no longer have meaningful talent grids and instead have sockets: but the calculation of this field was never altered to adapt to this change. As such, this field should be considered deprecated until we can address this oversight.
	Maximum int32 `json:"maximum,omitempty"`
	// The maximum possible value for the stat as shown in the UI, if it is being shown somewhere that reveals maximum in the UI (such as a bar chart-style view).  This is pulled directly from the item's DestinyStatGroupDefinition, and placed here for convenience.  If not returned, there is no maximum to use (and thus the stat should not be shown in a way that assumes there is a limit to the stat)
	DisplayMaximum int32 `json:"displayMaximum,omitempty"`
}

Defines a specific stat value on an item, and the minimum/maximum range that we could compute for the item based on our heuristics for how the item might be generated. Not guaranteed to match real-world instances of the item, but should hopefully at least be close. If it's not close, let us know on the Bungie API forums.

type DestinyDefinitionsDestinyItemActionBlockDefinition ¶

type DestinyDefinitionsDestinyItemActionBlockDefinition struct {
	// Localized text for the verb of the action being performed.
	VerbName string `json:"verbName,omitempty"`
	// Localized text describing the action being performed.
	VerbDescription string `json:"verbDescription,omitempty"`
	// The content has this property, however it's not entirely clear how it is used.
	IsPositive bool `json:"isPositive,omitempty"`
	// If the action has an overlay screen associated with it, this is the name of that screen. Unfortunately, we cannot return the screen's data itself.
	OverlayScreenName string `json:"overlayScreenName,omitempty"`
	// The icon associated with the overlay screen for the action, if any.
	OverlayIcon string `json:"overlayIcon,omitempty"`
	// The number of seconds to delay before allowing this action to be performed again.
	RequiredCooldownSeconds int32 `json:"requiredCooldownSeconds,omitempty"`
	// If the action requires other items to exist or be destroyed, this is the list of those items and requirements.
	RequiredItems []DestinyDefinitionsDestinyItemActionRequiredItemDefinition `json:"requiredItems,omitempty"`
	// If performing this action earns you Progression, this is the list of progressions and values granted for those progressions by performing this action.
	ProgressionRewards []DestinyDefinitionsDestinyProgressionRewardDefinition `json:"progressionRewards,omitempty"`
	// The internal identifier for the action.
	ActionTypeLabel string `json:"actionTypeLabel,omitempty"`
	// Theoretically, an item could have a localized string for a hint about the location in which the action should be performed. In practice, no items yet have this property.
	RequiredLocation string `json:"requiredLocation,omitempty"`
	// The identifier hash for the Cooldown associated with this action. We have not pulled this data yet for you to have more data to use for cooldowns.
	RequiredCooldownHash int32 `json:"requiredCooldownHash,omitempty"`
	// If true, the item is deleted when the action completes.
	DeleteOnAction bool `json:"deleteOnAction,omitempty"`
	// If true, the entire stack is deleted when the action completes.
	ConsumeEntireStack bool `json:"consumeEntireStack,omitempty"`
	// If true, this action will be performed as soon as you earn this item. Some rewards work this way, providing you a single item to pick up from a reward-granting vendor in-game and then immediately consuming itself to provide you multiple items.
	UseOnAcquire bool `json:"useOnAcquire,omitempty"`
}

If an item can have an action performed on it (like \"Dismantle\"), it will be defined here if you care.

type DestinyDefinitionsDestinyItemActionRequiredItemDefinition ¶

type DestinyDefinitionsDestinyItemActionRequiredItemDefinition struct {
	// The minimum quantity of the item you have to have.
	Count int32 `json:"count,omitempty"`
	// The hash identifier of the item you need to have. Use it to look up the DestinyInventoryItemDefinition for more info.
	ItemHash int32 `json:"itemHash,omitempty"`
	// If true, the item/quantity will be deleted from your inventory when the action is performed. Otherwise, you'll retain these required items after the action is complete.
	DeleteOnAction bool `json:"deleteOnAction,omitempty"`
}

The definition of an item and quantity required in a character's inventory in order to perform an action.

type DestinyDefinitionsDestinyItemCategoryDefinition ¶

type DestinyDefinitionsDestinyItemCategoryDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// If True, this category should be visible in UI. Sometimes we make categories that we don't think are interesting externally. It's up to you if you want to skip on showing them.
	Visible bool `json:"visible,omitempty"`
	// If True, this category has been deprecated: it may have no items left, or there may be only legacy items that remain in it which are no longer relevant to the game.
	Deprecated bool `json:"deprecated,omitempty"`
	// A shortened version of the title. The reason why we have this is because the Armory in German had titles that were too long to display in our UI, so these were localized abbreviated versions of those categories. The property still exists today, even though the Armory doesn't exist for D2... yet.
	ShortTitle string `json:"shortTitle,omitempty"`
	// The janky regular expression we used against the item type to try and discern whether the item belongs to this category.
	ItemTypeRegex string `json:"itemTypeRegex,omitempty"`
	// If the item in question has this category, it also should have this breaker type.
	GrantDestinyBreakerType int32 `json:"grantDestinyBreakerType,omitempty"`
	// If the item is a plug, this is the identifier we expect to find associated with it if it is in this category.
	PlugCategoryIdentifier string `json:"plugCategoryIdentifier,omitempty"`
	// If the item type matches this janky regex, it does *not* belong to this category.
	ItemTypeRegexNot string `json:"itemTypeRegexNot,omitempty"`
	// If the item belongs to this bucket, it does belong to this category.
	OriginBucketIdentifier string `json:"originBucketIdentifier,omitempty"`
	// If an item belongs to this category, it will also receive this item type. This is now how DestinyItemType is populated for items: it used to be an even jankier process, but that's a story that requires more alcohol.
	GrantDestinyItemType int32 `json:"grantDestinyItemType,omitempty"`
	// If an item belongs to this category, it will also receive this subtype enum value.  I know what you're thinking - what if it belongs to multiple categories that provide sub-types?  The last one processed wins, as is the case with all of these \"grant\" enums. Now you can see one reason why we moved away from these enums... but they're so convenient when they work, aren't they?
	GrantDestinySubType int32 `json:"grantDestinySubType,omitempty"`
	// If an item belongs to this category, it will also get this class restriction enum value.  See the other \"grant\"-prefixed properties on this definition for my color commentary.
	GrantDestinyClass int32 `json:"grantDestinyClass,omitempty"`
	// The traitId that can be found on items that belong to this category.
	TraitId string `json:"traitId,omitempty"`
	// If this category is a \"parent\" category of other categories, those children will have their hashes listed in rendering order here, and can be looked up using these hashes against DestinyItemCategoryDefinition.  In this way, you can build up a visual hierarchy of item categories. That's what we did, and you can do it too. I believe in you. Yes, you, Carl.  (I hope someone named Carl reads this someday)
	GroupedCategoryHashes []int32 `json:"groupedCategoryHashes,omitempty"`
	// All item category hashes of \"parent\" categories: categories that contain this as a child through the hierarchy of groupedCategoryHashes. It's a bit redundant, but having this child-centric list speeds up some calculations.
	ParentCategoryHashes []int32 `json:"parentCategoryHashes,omitempty"`
	// If true, this category is only used for grouping, and should not be evaluated with its own checks. Rather, the item only has this category if it has one of its child categories.
	GroupCategoryOnly bool `json:"groupCategoryOnly,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

In an attempt to categorize items by type, usage, and other interesting properties, we created DestinyItemCategoryDefinition: information about types that is assembled using a set of heuristics that examine the properties of an item such as what inventory bucket it's in, its item type name, and whether it has or is missing certain blocks of data. This heuristic is imperfect, however. If you find an item miscategorized, let us know on the Bungie API forums! We then populate all of the categories that we think an item belongs to in its DestinyInventoryItemDefinition.itemCategoryHashes property. You can use that to provide your own custom item filtering, sorting, aggregating... go nuts on it! And let us know if you see more categories that you wish would be added!

type DestinyDefinitionsDestinyItemCraftingBlockBonusPlugDefinition ¶

type DestinyDefinitionsDestinyItemCraftingBlockBonusPlugDefinition struct {
	SocketTypeHash int32 `json:"socketTypeHash,omitempty"`
	PlugItemHash   int32 `json:"plugItemHash,omitempty"`
}

type DestinyDefinitionsDestinyItemCraftingBlockDefinition ¶

type DestinyDefinitionsDestinyItemCraftingBlockDefinition struct {
	// A reference to the item definition that is created when crafting with this 'recipe' item.
	OutputItemHash int32 `json:"outputItemHash,omitempty"`
	// A list of socket type hashes that describes which sockets are required for crafting with this recipe.
	RequiredSocketTypeHashes []int32  `json:"requiredSocketTypeHashes,omitempty"`
	FailedRequirementStrings []string `json:"failedRequirementStrings,omitempty"`
	// A reference to the base material requirements for crafting with this recipe.
	BaseMaterialRequirements int32 `json:"baseMaterialRequirements,omitempty"`
	// A list of 'bonus' socket plugs that may be available if certain requirements are met.
	BonusPlugs []DestinyDefinitionsDestinyItemCraftingBlockBonusPlugDefinition `json:"bonusPlugs,omitempty"`
}

If an item can have an action performed on it (like \"Dismantle\"), it will be defined here if you care.

type DestinyDefinitionsDestinyItemCreationEntryLevelDefinition ¶

type DestinyDefinitionsDestinyItemCreationEntryLevelDefinition struct {
	Level int32 `json:"level,omitempty"`
}

An overly complicated wrapper for the item level at which the item should spawn.

type DestinyDefinitionsDestinyItemGearsetBlockDefinition ¶

type DestinyDefinitionsDestinyItemGearsetBlockDefinition struct {
	// The maximum possible number of items that can be collected.
	TrackingValueMax int32 `json:"trackingValueMax,omitempty"`
	// The list of hashes for items in the gearset. Use them to look up DestinyInventoryItemDefinition entries for the items in the set.
	ItemList []int32 `json:"itemList,omitempty"`
}

If an item has a related gearset, this is the list of items in that set, and an unlock expression that evaluates to a number representing the progress toward gearset completion (a very rare use for unlock expressions!)

type DestinyDefinitionsDestinyItemIntrinsicSocketEntryDefinition ¶

type DestinyDefinitionsDestinyItemIntrinsicSocketEntryDefinition struct {
	// Indicates the plug that is intrinsically inserted into this socket.
	PlugItemHash int32 `json:"plugItemHash,omitempty"`
	// Indicates the type of this intrinsic socket.
	SocketTypeHash int32 `json:"socketTypeHash,omitempty"`
	// If true, then this socket is visible in the item's \"default\" state. If you have an instance, you should always check the runtime state, as that can override this visibility setting: but if you're looking at the item on a conceptual level, this property can be useful for hiding data such as legacy sockets - which remain defined on items for infrastructure purposes, but can be confusing for users to see.
	DefaultVisible bool `json:"defaultVisible,omitempty"`
}

Represents a socket that has a plug associated with it intrinsically. This is useful for situations where the weapon needs to have a visual plug/Mod on it, but that plug/Mod should never change.

type DestinyDefinitionsDestinyItemInventoryBlockDefinition ¶

type DestinyDefinitionsDestinyItemInventoryBlockDefinition struct {
	// If this string is populated, you can't have more than one stack with this label in a given inventory. Note that this is different from the equipping block's unique label, which is used for equipping uniqueness.
	StackUniqueLabel string `json:"stackUniqueLabel,omitempty"`
	// The maximum quantity of this item that can exist in a stack.
	MaxStackSize int32 `json:"maxStackSize,omitempty"`
	// The hash identifier for the DestinyInventoryBucketDefinition to which this item belongs. I should have named this \"bucketHash\", but too many things refer to it now. Sigh.
	BucketTypeHash int32 `json:"bucketTypeHash,omitempty"`
	// If the item is picked up by the lost loot queue, this is the hash identifier for the DestinyInventoryBucketDefinition into which it will be placed. Again, I should have named this recoveryBucketHash instead.
	RecoveryBucketTypeHash int32 `json:"recoveryBucketTypeHash,omitempty"`
	// The hash identifier for the Tier Type of the item, use to look up its DestinyItemTierTypeDefinition if you need to show localized data for the item's tier.
	TierTypeHash int32 `json:"tierTypeHash,omitempty"`
	// If TRUE, this item is instanced. Otherwise, it is a generic item that merely has a quantity in a stack (like Glimmer).
	IsInstanceItem bool `json:"isInstanceItem,omitempty"`
	// The localized name of the tier type, which is a useful shortcut so you don't have to look up the definition every time. However, it's mostly a holdover from days before we had a DestinyItemTierTypeDefinition to refer to.
	TierTypeName string `json:"tierTypeName,omitempty"`
	// The enumeration matching the tier type of the item to known values, again for convenience sake.
	TierType int32 `json:"tierType,omitempty"`
	// The tooltip message to show, if any, when the item expires.
	ExpirationTooltip string `json:"expirationTooltip,omitempty"`
	// If the item expires while playing in an activity, we show a different message.
	ExpiredInActivityMessage string `json:"expiredInActivityMessage,omitempty"`
	// If the item expires in orbit, we show a... more different message. (\"Consummate V's, consummate!\")
	ExpiredInOrbitMessage                    string `json:"expiredInOrbitMessage,omitempty"`
	SuppressExpirationWhenObjectivesComplete bool   `json:"suppressExpirationWhenObjectivesComplete,omitempty"`
	// A reference to the associated crafting 'recipe' item definition, if this item can be crafted.
	RecipeItemHash int32 `json:"recipeItemHash,omitempty"`
}

If the item can exist in an inventory - the overwhelming majority of them can and do - then this is the basic properties regarding the item's relationship with the inventory.

type DestinyDefinitionsDestinyItemInvestmentStatDefinition ¶

type DestinyDefinitionsDestinyItemInvestmentStatDefinition struct {
	// The hash identifier for the DestinyStatDefinition defining this stat.
	StatTypeHash int32 `json:"statTypeHash,omitempty"`
	// The raw \"Investment\" value for the stat, before transformations are performed to turn this raw stat into stats that are displayed in the game UI.
	Value int32 `json:"value,omitempty"`
	// If this is true, the stat will only be applied on the item in certain game state conditions, and we can't know statically whether or not this stat will be applied. Check the \"live\" API data instead for whether this value is being applied on a specific instance of the item in question, and you can use this to decide whether you want to show the stat on the generic view of the item, or whether you want to show some kind of caveat or warning about the stat value being conditional on game state.
	IsConditionallyActive bool `json:"isConditionallyActive,omitempty"`
}

Represents a \"raw\" investment stat, before calculated stats are calculated and before any DestinyStatGroupDefinition is applied to transform the stat into something closer to what you see in-game. Because these won't match what you see in-game, consider carefully whether you really want to use these stats. I have left them in case someone can do something useful or interesting with the pre-processed statistics.

type DestinyDefinitionsDestinyItemMetricBlockDefinition ¶

type DestinyDefinitionsDestinyItemMetricBlockDefinition struct {
	// Hash identifiers for any DestinyPresentationNodeDefinition entry that can be used to list available metrics. Any metric listed directly below these nodes, or in any of these nodes' children will be made available for selection.
	AvailableMetricCategoryNodeHashes []int32 `json:"availableMetricCategoryNodeHashes,omitempty"`
}

The metrics available for display and selection on an item.

type DestinyDefinitionsDestinyItemObjectiveBlockDefinition ¶

type DestinyDefinitionsDestinyItemObjectiveBlockDefinition struct {
	// The hashes to Objectives (DestinyObjectiveDefinition) that are part of this Quest Step, in the order that they should be rendered.
	ObjectiveHashes []int32 `json:"objectiveHashes,omitempty"`
	// For every entry in objectiveHashes, there is a corresponding entry in this array at the same index. If the objective is meant to be associated with a specific DestinyActivityDefinition, there will be a valid hash at that index. Otherwise, it will be invalid (0).  Rendered somewhat obsolete by perObjectiveDisplayProperties, which currently has much the same information but may end up with more info in the future.
	DisplayActivityHashes []int32 `json:"displayActivityHashes,omitempty"`
	// If True, all objectives must be completed for the step to be completed. If False, any one objective can be completed for the step to be completed.
	RequireFullObjectiveCompletion bool `json:"requireFullObjectiveCompletion,omitempty"`
	// The hash for the DestinyInventoryItemDefinition representing the Quest to which this Quest Step belongs.
	QuestlineItemHash int32 `json:"questlineItemHash,omitempty"`
	// The localized string for narrative text related to this quest step, if any.
	Narrative string `json:"narrative,omitempty"`
	// The localized string describing an action to be performed associated with the objectives, if any.
	ObjectiveVerbName string `json:"objectiveVerbName,omitempty"`
	// The identifier for the type of quest being performed, if any. Not associated with any fixed definition, yet.
	QuestTypeIdentifier string `json:"questTypeIdentifier,omitempty"`
	// A hashed value for the questTypeIdentifier, because apparently I like to be redundant.
	QuestTypeHash int32 `json:"questTypeHash,omitempty"`
	// One entry per Objective on the item, it will have related display information.
	PerObjectiveDisplayProperties []DestinyDefinitionsDestinyObjectiveDisplayProperties `json:"perObjectiveDisplayProperties,omitempty"`
	DisplayAsStatTracker          bool                                                  `json:"displayAsStatTracker,omitempty"`
}

An item can have objectives on it. In practice, these are the exclusive purview of \"Quest Step\" items: DestinyInventoryItemDefinitions that represent a specific step in a Quest. Quest steps have 1:M objectives that we end up processing and returning in live data as DestinyQuestStatus data, and other useful information.

type DestinyDefinitionsDestinyItemPerkEntryDefinition ¶

type DestinyDefinitionsDestinyItemPerkEntryDefinition struct {
	// If this perk is not active, this is the string to show for why it's not providing its benefits.
	RequirementDisplayString string `json:"requirementDisplayString,omitempty"`
	// A hash identifier for the DestinySandboxPerkDefinition being provided on the item.
	PerkHash int32 `json:"perkHash,omitempty"`
	// Indicates whether this perk should be shown, or if it should be shown disabled.
	PerkVisibility int32 `json:"perkVisibility,omitempty"`
}

An intrinsic perk on an item, and the requirements for it to be activated.

type DestinyDefinitionsDestinyItemPreviewBlockDefinition ¶

type DestinyDefinitionsDestinyItemPreviewBlockDefinition struct {
	// A string that the game UI uses as a hint for which detail screen to show for the item. You, too, can leverage this for your own custom screen detail views. Note, however, that these are arbitrarily defined by designers: there's no guarantees of a fixed, known number of these - so fall back to something reasonable if you don't recognize it.
	ScreenStyle string `json:"screenStyle,omitempty"`
	// If the preview data is derived from a fake \"Preview\" Vendor, this will be the hash identifier for the DestinyVendorDefinition of that fake vendor.
	PreviewVendorHash int32 `json:"previewVendorHash,omitempty"`
	// If this item should show you Artifact information when you preview it, this is the hash identifier of the DestinyArtifactDefinition for the artifact whose data should be shown.
	ArtifactHash int32 `json:"artifactHash,omitempty"`
	// If the preview has an associated action (like \"Open\"), this will be the localized string for that action.
	PreviewActionString string `json:"previewActionString,omitempty"`
	// This is a list of the items being previewed, categorized in the same way as they are in the preview UI.
	DerivedItemCategories []DestinyDefinitionsItemsDestinyDerivedItemCategoryDefinition `json:"derivedItemCategories,omitempty"`
}

Items like Sacks or Boxes can have items that it shows in-game when you view details that represent the items you can obtain if you use or acquire the item. This defines those categories, and gives some insights into that data's source.

type DestinyDefinitionsDestinyItemQualityBlockDefinition ¶

type DestinyDefinitionsDestinyItemQualityBlockDefinition struct {
	// The \"base\" defined level of an item. This is a list because, in theory, each Expansion could define its own base level for an item.  In practice, not only was that never done in Destiny 1, but now this isn't even populated at all. When it's not populated, the level at which it spawns has to be inferred by Reward information, of which BNet receives an imperfect view and will only be reliable on instanced data as a result.
	ItemLevels []int32 `json:"itemLevels,omitempty"`
	// qualityLevel is used in combination with the item's level to calculate stats like Attack and Defense. It plays a role in that calculation, but not nearly as large as itemLevel does.
	QualityLevel int32 `json:"qualityLevel,omitempty"`
	// The string identifier for this item's \"infusability\", if any.   Items that match the same infusionCategoryName are allowed to infuse with each other.  DEPRECATED: Items can now have multiple infusion categories. Please use infusionCategoryHashes instead.
	InfusionCategoryName string `json:"infusionCategoryName,omitempty"`
	// The hash identifier for the infusion. It does not map to a Definition entity.  DEPRECATED: Items can now have multiple infusion categories. Please use infusionCategoryHashes instead.
	InfusionCategoryHash int32 `json:"infusionCategoryHash,omitempty"`
	// If any one of these hashes matches any value in another item's infusionCategoryHashes, the two can infuse with each other.
	InfusionCategoryHashes []int32 `json:"infusionCategoryHashes,omitempty"`
	// An item can refer to pre-set level requirements. They are defined in DestinyProgressionLevelRequirementDefinition, and you can use this hash to find the appropriate definition.
	ProgressionLevelRequirementHash int32 `json:"progressionLevelRequirementHash,omitempty"`
	// The latest version available for this item.
	CurrentVersion int32 `json:"currentVersion,omitempty"`
	// The list of versions available for this item.
	Versions []DestinyDefinitionsDestinyItemVersionDefinition `json:"versions,omitempty"`
	// Icon overlays to denote the item version and power cap status.
	DisplayVersionWatermarkIcons []string `json:"displayVersionWatermarkIcons,omitempty"`
}

An item's \"Quality\" determines its calculated stats. The Level at which the item spawns is combined with its \"qualityLevel\" along with some additional calculations to determine the value of those stats. In Destiny 2, most items don't have default item levels and quality, making this property less useful: these apparently are almost always determined by the complex mechanisms of the Reward system rather than statically. They are still provided here in case they are still useful for people. This also contains some information about Infusion.

type DestinyDefinitionsDestinyItemSackBlockDefinition ¶

type DestinyDefinitionsDestinyItemSackBlockDefinition struct {
	// A description of what will happen when you open the sack. As far as I can tell, this is blank currently. Unknown whether it will eventually be populated with useful info.
	DetailAction string `json:"detailAction,omitempty"`
	// The localized name of the action being performed when you open the sack.
	OpenAction      string `json:"openAction,omitempty"`
	SelectItemCount int32  `json:"selectItemCount,omitempty"`
	VendorSackType  string `json:"vendorSackType,omitempty"`
	OpenOnAcquire   bool   `json:"openOnAcquire,omitempty"`
}

Some items are \"sacks\" - they can be \"opened\" to produce other items. This is information related to its sack status, mostly UI strings. Engrams are an example of items that are considered to be \"Sacks\".

type DestinyDefinitionsDestinyItemSetBlockDefinition ¶

type DestinyDefinitionsDestinyItemSetBlockDefinition struct {
	// A collection of hashes of set items, for items such as Quest Metadata items that possess this data.
	ItemList []DestinyDefinitionsDestinyItemSetBlockEntryDefinition `json:"itemList,omitempty"`
	// If true, items in the set can only be added in increasing order, and adding an item will remove any previous item. For Quests, this is by necessity true. Only one quest step is present at a time, and previous steps are removed as you advance in the quest.
	RequireOrderedSetItemAdd bool `json:"requireOrderedSetItemAdd,omitempty"`
	// If true, the UI should treat this quest as \"featured\"
	SetIsFeatured bool `json:"setIsFeatured,omitempty"`
	// A string identifier we can use to attempt to identify the category of the Quest.
	SetType string `json:"setType,omitempty"`
	// The name of the quest line that this quest step is a part of.
	QuestLineName string `json:"questLineName,omitempty"`
	// The description of the quest line that this quest step is a part of.
	QuestLineDescription string `json:"questLineDescription,omitempty"`
	// An additional summary of this step in the quest line.
	QuestStepSummary string `json:"questStepSummary,omitempty"`
}

Primarily for Quests, this is the definition of properties related to the item if it is a quest and its various quest steps.

type DestinyDefinitionsDestinyItemSetBlockEntryDefinition ¶

type DestinyDefinitionsDestinyItemSetBlockEntryDefinition struct {
	// Used for tracking which step a user reached. These values will be populated in the user's internal state, which we expose externally as a more usable DestinyQuestStatus object. If this item has been obtained, this value will be set in trackingUnlockValueHash.
	TrackingValue int32 `json:"trackingValue,omitempty"`
	// This is the hash identifier for a DestinyInventoryItemDefinition representing this quest step.
	ItemHash int32 `json:"itemHash,omitempty"`
}

Defines a particular entry in an ItemSet (AKA a particular Quest Step in a Quest)

type DestinyDefinitionsDestinyItemSocketBlockDefinition ¶

type DestinyDefinitionsDestinyItemSocketBlockDefinition struct {
	// This was supposed to be a string that would give per-item details about sockets. In practice, it turns out that all this ever has is the localized word \"details\". ... that's lame, but perhaps it will become something cool in the future.
	Detail string `json:"detail,omitempty"`
	// Each non-intrinsic (or mutable) socket on an item is defined here. Check inside for more info.
	SocketEntries []DestinyDefinitionsDestinyItemSocketEntryDefinition `json:"socketEntries,omitempty"`
	// Each intrinsic (or immutable/permanent) socket on an item is defined here, along with the plug that is permanently affixed to the socket.
	IntrinsicSockets []DestinyDefinitionsDestinyItemIntrinsicSocketEntryDefinition `json:"intrinsicSockets,omitempty"`
	// A convenience property, that refers to the sockets in the \"sockets\" property, pre-grouped by category and ordered in the manner that they should be grouped in the UI. You could form this yourself with the existing data, but why would you want to? Enjoy life man.
	SocketCategories []DestinyDefinitionsDestinyItemSocketCategoryDefinition `json:"socketCategories,omitempty"`
}

If defined, the item has at least one socket.

type DestinyDefinitionsDestinyItemSocketCategoryDefinition ¶

type DestinyDefinitionsDestinyItemSocketCategoryDefinition struct {
	// The hash for the Socket Category: a quick way to go get the header display information for the category. Use it to look up DestinySocketCategoryDefinition info.
	SocketCategoryHash int32 `json:"socketCategoryHash,omitempty"`
	// Use these indexes to look up the sockets in the \"sockets.socketEntries\" property on the item definition. These are the indexes under the category, in game-rendered order.
	SocketIndexes []int32 `json:"socketIndexes,omitempty"`
}

Sockets are grouped into categories in the UI. These define which category and which sockets are under that category.

type DestinyDefinitionsDestinyItemSocketEntryDefinition ¶

type DestinyDefinitionsDestinyItemSocketEntryDefinition struct {
	// All sockets have a type, and this is the hash identifier for this particular type. Use it to look up the DestinySocketTypeDefinition: read there for more information on how socket types affect the behavior of the socket.
	SocketTypeHash int32 `json:"socketTypeHash,omitempty"`
	// If a valid hash, this is the hash identifier for the DestinyInventoryItemDefinition representing the Plug that will be initially inserted into the item on item creation. Otherwise, this Socket will either start without a plug inserted, or will have one randomly inserted.
	SingleInitialItemHash int32 `json:"singleInitialItemHash,omitempty"`
	// This is a list of pre-determined plugs that can *always* be plugged into this socket, without the character having the plug in their inventory.  If this list is populated, you will not be allowed to plug an arbitrary item in the socket: you will only be able to choose from one of these reusable plugs.
	ReusablePlugItems []DestinyDefinitionsDestinyItemSocketEntryPlugItemDefinition `json:"reusablePlugItems,omitempty"`
	// If this is true, then the socket will not be initialized with a plug if the item is purchased from a Vendor.  Remember that Vendors are much more than conceptual vendors: they include \"Collection Kiosks\" and other entities. See DestinyVendorDefinition for more information.
	PreventInitializationOnVendorPurchase bool `json:"preventInitializationOnVendorPurchase,omitempty"`
	// If this is true, the perks provided by this socket shouldn't be shown in the item's tooltip. This might be useful if it's providing a hidden bonus, or if the bonus is less important than other benefits on the item.
	HidePerksInItemTooltip bool `json:"hidePerksInItemTooltip,omitempty"`
	// Indicates where you should go to get plugs for this socket. This will affect how you populate your UI, as well as what plugs are valid for this socket. It's an alternative to having to check for the existence of certain properties (reusablePlugItems for example) to infer where plugs should come from.
	PlugSources int32 `json:"plugSources,omitempty"`
	// If this socket's plugs come from a reusable DestinyPlugSetDefinition, this is the identifier for that set. We added this concept to reduce some major duplication that's going to come from sockets as replacements for what was once implemented as large sets of items and kiosks (like Emotes).   As of Shadowkeep, these will come up much more frequently and be driven by game content rather than custom curation.
	ReusablePlugSetHash int32 `json:"reusablePlugSetHash,omitempty"`
	// This field replaces \"randomizedPlugItems\" as of Shadowkeep launch. If a socket has randomized plugs, this is a pointer to the set of plugs that could be used, as defined in DestinyPlugSetDefinition.   If null, the item has no randomized plugs.
	RandomizedPlugSetHash int32 `json:"randomizedPlugSetHash,omitempty"`
	// If true, then this socket is visible in the item's \"default\" state. If you have an instance, you should always check the runtime state, as that can override this visibility setting: but if you're looking at the item on a conceptual level, this property can be useful for hiding data such as legacy sockets - which remain defined on items for infrastructure purposes, but can be confusing for users to see.
	DefaultVisible bool `json:"defaultVisible,omitempty"`
}

The definition information for a specific socket on an item. This will determine how the socket behaves in-game.

type DestinyDefinitionsDestinyItemSocketEntryPlugItemDefinition ¶

type DestinyDefinitionsDestinyItemSocketEntryPlugItemDefinition struct {
	// The hash identifier of a DestinyInventoryItemDefinition representing the plug that can be inserted.
	PlugItemHash int32 `json:"plugItemHash,omitempty"`
}

The definition of a known, reusable plug that can be applied to a socket.

type DestinyDefinitionsDestinyItemSocketEntryPlugItemRandomizedDefinition ¶

type DestinyDefinitionsDestinyItemSocketEntryPlugItemRandomizedDefinition struct {
	CraftingRequirements *DestinyDefinitionsDestinyPlugItemCraftingRequirements `json:"craftingRequirements,omitempty"`
	// Indicates if the plug can be rolled on the current version of the item. For example, older versions of weapons may have plug rolls that are no longer possible on the current versions.
	CurrentlyCanRoll bool `json:"currentlyCanRoll,omitempty"`
	// The hash identifier of a DestinyInventoryItemDefinition representing the plug that can be inserted.
	PlugItemHash int32 `json:"plugItemHash,omitempty"`
}

type DestinyDefinitionsDestinyItemSourceBlockDefinition ¶

type DestinyDefinitionsDestinyItemSourceBlockDefinition struct {
	// The list of hash identifiers for Reward Sources that hint where the item can be found (DestinyRewardSourceDefinition).
	SourceHashes []int32 `json:"sourceHashes,omitempty"`
	// A collection of details about the stats that were computed for the ways we found that the item could be spawned.
	Sources []DestinyDefinitionsSourcesDestinyItemSourceDefinition `json:"sources,omitempty"`
	// If we found that this item is exclusive to a specific platform, this will be set to the BungieMembershipType enumeration that matches that platform.
	Exclusive int32 `json:"exclusive,omitempty"`
	// A denormalized reference back to vendors that potentially sell this item.
	VendorSources []DestinyDefinitionsDestinyItemVendorSourceReference `json:"vendorSources,omitempty"`
}

Data about an item's \"sources\": ways that the item can be obtained.

type DestinyDefinitionsDestinyItemStatBlockDefinition ¶

type DestinyDefinitionsDestinyItemStatBlockDefinition struct {
	// If true, the game won't show the \"primary\" stat on this item when you inspect it.  NOTE: This is being manually mapped, because I happen to want it in a block that isn't going to directly create this derivative block.
	DisablePrimaryStatDisplay bool `json:"disablePrimaryStatDisplay,omitempty"`
	// If the item's stats are meant to be modified by a DestinyStatGroupDefinition, this will be the identifier for that definition.  If you are using live data or precomputed stats data on the DestinyInventoryItemDefinition.stats.stats property, you don't have to worry about statGroupHash and how it alters stats: the already altered stats are provided to you. But if you want to see how the sausage gets made, or perform computations yourself, this is valuable information.
	StatGroupHash int32 `json:"statGroupHash,omitempty"`
	// If you are looking for precomputed values for the stats on a weapon, this is where they are stored. Technically these are the \"Display\" stat values. Please see DestinyStatsDefinition for what Display Stat Values means, it's a very long story... but essentially these are the closest values BNet can get to the item stats that you see in-game.  These stats are keyed by the DestinyStatDefinition's hash identifier for the stat that's found on the item.
	Stats map[string]DestinyDefinitionsDestinyInventoryItemStatDefinition `json:"stats,omitempty"`
	// A quick and lazy way to determine whether any stat other than the \"primary\" stat is actually visible on the item. Items often have stats that we return in case people find them useful, but they're not part of the \"Stat Group\" and thus we wouldn't display them in our UI. If this is False, then we're not going to display any of these stats other than the primary one.
	HasDisplayableStats bool `json:"hasDisplayableStats,omitempty"`
	// This stat is determined to be the \"primary\" stat, and can be looked up in the stats or any other stat collection related to the item.  Use this hash to look up the stat's value using DestinyInventoryItemDefinition.stats.stats, and the renderable data for the primary stat in the related DestinyStatDefinition.
	PrimaryBaseStatHash int32 `json:"primaryBaseStatHash,omitempty"`
}

Information about the item's calculated stats, with as much data as we can find for the stats without having an actual instance of the item. Note that this means the entire concept of providing these stats is fundamentally insufficient: we cannot predict with 100% accuracy the conditions under which an item can spawn, so we use various heuristics to attempt to simulate the conditions as accurately as possible. Actual stats for items in-game can and will vary, but these should at least be useful base points for comparison and display. It is also worth noting that some stats, like Magazine size, have further calculations performed on them by scripts in-game and on the game servers that BNet does not have access to. We cannot know how those stats are further transformed, and thus some stats will be inaccurate even on instances of items in BNet vs. how they appear in-game. This is a known limitation of our item statistics, without any planned fix.

type DestinyDefinitionsDestinyItemSummaryBlockDefinition ¶

type DestinyDefinitionsDestinyItemSummaryBlockDefinition struct {
	// Apparently when rendering an item in a reward, this should be used as a sort priority. We're not doing it presently.
	SortPriority int32 `json:"sortPriority,omitempty"`
}

This appears to be information used when rendering rewards. We don't currently use it on BNet.

type DestinyDefinitionsDestinyItemTalentGridBlockDefinition ¶

type DestinyDefinitionsDestinyItemTalentGridBlockDefinition struct {
	// The hash identifier of the DestinyTalentGridDefinition attached to this item.
	TalentGridHash int32 `json:"talentGridHash,omitempty"`
	// This is meant to be a subtitle for looking at the talent grid. In practice, somewhat frustratingly, this always merely says the localized word for \"Details\". Great. Maybe it'll have more if talent grids ever get used for more than builds and subclasses again.
	ItemDetailString string `json:"itemDetailString,omitempty"`
	// A shortcut string identifier for the \"build\" in question, if this talent grid has an associated build. Doesn't map to anything we can expose at the moment.
	BuildName string `json:"buildName,omitempty"`
	// If the talent grid implies a damage type, this is the enum value for that damage type.
	HudDamageType int32 `json:"hudDamageType,omitempty"`
	// If the talent grid has a special icon that's shown in the game UI (like builds, funny that), this is the identifier for that icon. Sadly, we don't actually get that icon right now. I'll be looking to replace this with a path to the actual icon itself.
	HudIcon string `json:"hudIcon,omitempty"`
}

This defines information that can only come from a talent grid on an item. Items mostly have negligible talent grid data these days, but instanced items still retain grids as a source for some of this common information. Builds/Subclasses are the only items left that still have talent grids with meaningful Nodes.

type DestinyDefinitionsDestinyItemTooltipNotification ¶

type DestinyDefinitionsDestinyItemTooltipNotification struct {
	DisplayString string `json:"displayString,omitempty"`
	DisplayStyle  string `json:"displayStyle,omitempty"`
}

type DestinyDefinitionsDestinyItemTranslationBlockDefinition ¶

type DestinyDefinitionsDestinyItemTranslationBlockDefinition struct {
	WeaponPatternIdentifier string                                                 `json:"weaponPatternIdentifier,omitempty"`
	WeaponPatternHash       int32                                                  `json:"weaponPatternHash,omitempty"`
	DefaultDyes             []DestinyDyeReference                                  `json:"defaultDyes,omitempty"`
	LockedDyes              []DestinyDyeReference                                  `json:"lockedDyes,omitempty"`
	CustomDyes              []DestinyDyeReference                                  `json:"customDyes,omitempty"`
	Arrangements            []DestinyDefinitionsDestinyGearArtArrangementReference `json:"arrangements,omitempty"`
	HasGeometry             bool                                                   `json:"hasGeometry,omitempty"`
}

This Block defines the rendering data associated with the item, if any.

type DestinyDefinitionsDestinyItemValueBlockDefinition ¶

type DestinyDefinitionsDestinyItemValueBlockDefinition struct {
	// References to the items that make up this item's \"value\", and the quantity.
	ItemValue []DestinyDestinyItemQuantity `json:"itemValue,omitempty"`
	// If there's a localized text description of the value provided, this will be said description.
	ValueDescription string `json:"valueDescription,omitempty"`
}

This defines an item's \"Value\". Unfortunately, this appears to be used in different ways depending on the way that the item itself is used. For items being sold at a Vendor, this is the default \"sale price\" of the item. These days, the vendor itself almost always sets the price, but it still possible for the price to fall back to this value. For quests, it is a preview of rewards you can gain by completing the quest. For dummy items, if the itemValue refers to an Emblem, it is the emblem that should be shown as the reward. (jeez louise) It will likely be used in a number of other ways in the future, it appears to be a bucket where they put arbitrary items and quantities into the item.

type DestinyDefinitionsDestinyItemVendorSourceReference ¶

type DestinyDefinitionsDestinyItemVendorSourceReference struct {
	// The identifier for the vendor that may sell this item.
	VendorHash int32 `json:"vendorHash,omitempty"`
	// The Vendor sale item indexes that represent the sale information for this item. The same vendor may sell an item in multiple \"ways\", hence why this is a list. (for instance, a weapon may be \"sold\" as a reward in a quest, for Glimmer, and for Masterwork Cores: each of those ways would be represented by a different vendor sale item with a different index)
	VendorItemIndexes []int32 `json:"vendorItemIndexes,omitempty"`
}

Represents that a vendor could sell this item, and provides a quick link to that vendor and sale item. Note that we do not and cannot make a guarantee that the vendor will ever *actually* sell this item, only that the Vendor has a definition that indicates it *could* be sold. Note also that a vendor may sell the same item in multiple \"ways\", which means there may be multiple vendorItemIndexes for a single Vendor hash.

type DestinyDefinitionsDestinyItemVersionDefinition ¶

type DestinyDefinitionsDestinyItemVersionDefinition struct {
	// A reference to the power cap for this item version.
	PowerCapHash int32 `json:"powerCapHash,omitempty"`
}

The version definition currently just holds a reference to the power cap.

type DestinyDefinitionsDestinyLocationDefinition ¶

type DestinyDefinitionsDestinyLocationDefinition struct {
	// If the location has a Vendor on it, this is the hash identifier for that Vendor. Look them up with DestinyVendorDefinition.
	VendorHash int32 `json:"vendorHash,omitempty"`
	// A Location may refer to different specific spots in the world based on the world's current state. This is a list of those potential spots, and the data we can use at runtime to determine which one of the spots is the currently valid one.
	LocationReleases []DestinyDefinitionsDestinyLocationReleaseDefinition `json:"locationReleases,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

A \"Location\" is a sort of shortcut for referring to a specific combination of Activity, Destination, Place, and even Bubble or NavPoint within a space. Most of this data isn't intrinsically useful to us, but Objectives refer to locations, and through that we can at least infer the Activity, Destination, and Place being referred to by the Objective.

type DestinyDefinitionsDestinyLocationReleaseDefinition ¶

type DestinyDefinitionsDestinyLocationReleaseDefinition struct {
	// Sadly, these don't appear to be populated anymore (ever?)
	DisplayProperties    *AllOfDestinyDefinitionsDestinyLocationReleaseDefinitionDisplayProperties `json:"displayProperties,omitempty"`
	SmallTransparentIcon string                                                                    `json:"smallTransparentIcon,omitempty"`
	MapIcon              string                                                                    `json:"mapIcon,omitempty"`
	LargeTransparentIcon string                                                                    `json:"largeTransparentIcon,omitempty"`
	// If we had map information, this spawnPoint would be interesting. But sadly, we don't have that info.
	SpawnPoint int32 `json:"spawnPoint,omitempty"`
	// The Destination being pointed to by this location.
	DestinationHash int32 `json:"destinationHash,omitempty"`
	// The Activity being pointed to by this location.
	ActivityHash int32 `json:"activityHash,omitempty"`
	// The Activity Graph being pointed to by this location.
	ActivityGraphHash int32 `json:"activityGraphHash,omitempty"`
	// The Activity Graph Node being pointed to by this location. (Remember that Activity Graph Node hashes are only unique within an Activity Graph: so use the combination to find the node being spoken of)
	ActivityGraphNodeHash int32 `json:"activityGraphNodeHash,omitempty"`
	// The Activity Bubble within the Destination. Look this up in the DestinyDestinationDefinition's bubbles and bubbleSettings properties.
	ActivityBubbleName int32 `json:"activityBubbleName,omitempty"`
	// If we had map information, this would tell us something cool about the path this location wants you to take. I wish we had map information.
	ActivityPathBundle int32 `json:"activityPathBundle,omitempty"`
	// If we had map information, this would tell us about path information related to destination on the map. Sad. Maybe you can do something cool with it. Go to town man.
	ActivityPathDestination int32 `json:"activityPathDestination,omitempty"`
	// The type of Nav Point that this represents. See the enumeration for more info.
	NavPointType int32 `json:"navPointType,omitempty"`
	// Looks like it should be the position on the map, but sadly it does not look populated... yet?
	WorldPosition []int32 `json:"worldPosition,omitempty"`
}

A specific \"spot\" referred to by a location. Only one of these can be active at a time for a given Location.

type DestinyDefinitionsDestinyMaterialRequirement ¶

type DestinyDefinitionsDestinyMaterialRequirement struct {
	// The hash identifier of the material required. Use it to look up the material's DestinyInventoryItemDefinition.
	ItemHash int32 `json:"itemHash,omitempty"`
	// If True, the material will be removed from the character's inventory when the action is performed.
	DeleteOnAction bool `json:"deleteOnAction,omitempty"`
	// The amount of the material required.
	Count int32 `json:"count,omitempty"`
	// If true, the material requirement count value is constant. Since The Witch Queen expansion, some material requirement counts can be dynamic and will need to be returned with an API call.
	CountIsConstant bool `json:"countIsConstant,omitempty"`
	// If True, this requirement is \"silent\": don't bother showing it in a material requirements display. I mean, I'm not your mom: I'm not going to tell you you *can't* show it. But we won't show it in our UI.
	OmitFromRequirements bool `json:"omitFromRequirements,omitempty"`
}

Many actions relating to items require you to expend materials: - Activating a talent node - Inserting a plug into a socket The items will refer to material requirements by a materialRequirementsHash in these cases, and this is the definition for those requirements in terms of the item required, how much of it is required and other interesting info. This is one of the rare/strange times where a single contract class is used both in definitions *and* in live data response contracts. I'm not sure yet whether I regret that.

type DestinyDefinitionsDestinyMaterialRequirementSetDefinition ¶

type DestinyDefinitionsDestinyMaterialRequirementSetDefinition struct {
	// The list of all materials that are required.
	Materials []DestinyDefinitionsDestinyMaterialRequirement `json:"materials,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

Represent a set of material requirements: Items that either need to be owned or need to be consumed in order to perform an action. A variety of other entities refer to these as gatekeepers and payments for actions that can be performed in game.

type DestinyDefinitionsDestinyMedalTierDefinition ¶

type DestinyDefinitionsDestinyMedalTierDefinition struct {
	// The name of the tier.
	TierName string `json:"tierName,omitempty"`
	// If you're rendering medals by tier, render them in this order (ascending)
	Order int32 `json:"order,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

An artificial construct of our own creation, to try and put some order on top of Medals and keep them from being one giant, unmanageable and unsorted blob of stats. Unfortunately, we haven't had time to do this evaluation yet in Destiny 2, so we're short on Medal Tiers. This will hopefully be updated over time, if Medals continue to exist.

type DestinyDefinitionsDestinyNodeActivationRequirement ¶

type DestinyDefinitionsDestinyNodeActivationRequirement struct {
	// The Progression level on the Talent Grid required to activate this node.  See DestinyTalentGridDefinition.progressionHash for the related Progression, and read DestinyProgressionDefinition's documentation to learn more about Progressions.
	GridLevel int32 `json:"gridLevel,omitempty"`
	// The list of hash identifiers for material requirement sets: materials that are required for the node to be activated. See DestinyMaterialRequirementSetDefinition for more information about material requirements.  In this case, only a single DestinyMaterialRequirementSetDefinition will be chosen from this list, and we won't know which one will be chosen until an instance of the item is created.
	MaterialRequirementHashes []int32 `json:"materialRequirementHashes,omitempty"`
}

Talent nodes have requirements that must be met before they can be activated. This describes the material costs, the Level of the Talent Grid's progression required, and other conditional information that limits whether a talent node can be activated.

type DestinyDefinitionsDestinyNodeSocketReplaceResponse ¶

type DestinyDefinitionsDestinyNodeSocketReplaceResponse struct {
	// The hash identifier of the socket type to find amidst the item's sockets (the item to which this talent grid is attached). See DestinyInventoryItemDefinition.sockets.socketEntries to find the socket type of sockets on the item in question.
	SocketTypeHash int32 `json:"socketTypeHash,omitempty"`
	// The hash identifier of the plug item that will be inserted into the socket found.
	PlugItemHash int32 `json:"plugItemHash,omitempty"`
}

This is a bit of an odd duck. Apparently, if talent nodes steps have this data, the game will go through on step activation and alter the first Socket it finds on the item that has a type matching the given socket type, inserting the indicated plug item.

type DestinyDefinitionsDestinyNodeStepDefinition ¶

type DestinyDefinitionsDestinyNodeStepDefinition struct {
	// These are the display properties actually used to render the Talent Node. The currently active step's displayProperties are shown.
	DisplayProperties *AllOfDestinyDefinitionsDestinyNodeStepDefinitionDisplayProperties `json:"displayProperties,omitempty"`
	// The index of this step in the list of Steps on the Talent Node.  Unfortunately, this is the closest thing we have to an identifier for the Step: steps are not provided a content version agnostic identifier. This means that, when you are dealing with talent nodes, you will need to first ensure that you have the latest version of content.
	StepIndex int32 `json:"stepIndex,omitempty"`
	// The hash of this node step. Unfortunately, while it can be used to uniquely identify the step within a node, it is also content version dependent and should not be relied on without ensuring you have the latest vesion of content.
	NodeStepHash int32 `json:"nodeStepHash,omitempty"`
	// If you can interact with this node in some way, this is the localized description of that interaction.
	InteractionDescription string `json:"interactionDescription,omitempty"`
	// An enum representing a damage type granted by activating this step, if any.
	DamageType int32 `json:"damageType,omitempty"`
	// If the step provides a damage type, this will be the hash identifier used to look up the damage type's DestinyDamageTypeDefinition.
	DamageTypeHash int32 `json:"damageTypeHash,omitempty"`
	// If the step has requirements for activation (they almost always do, if nothing else than for the Talent Grid's Progression to have reached a certain level), they will be defined here.
	ActivationRequirement *AllOfDestinyDefinitionsDestinyNodeStepDefinitionActivationRequirement `json:"activationRequirement,omitempty"`
	// There was a time when talent nodes could be activated multiple times, and the effects of subsequent Steps would be compounded on each other, essentially \"upgrading\" the node. We have moved away from this, but theoretically the capability still exists.  I continue to return this in case it is used in the future: if true and this step is the current step in the node, you are allowed to activate the node a second time to receive the benefits of the next step in the node, which will then become the active step.
	CanActivateNextStep bool `json:"canActivateNextStep,omitempty"`
	// The stepIndex of the next step in the talent node, or -1 if this is the last step or if the next step to be chosen is random.  This doesn't really matter anymore unless canActivateNextStep begins to be used again.
	NextStepIndex int32 `json:"nextStepIndex,omitempty"`
	// If true, the next step to be chosen is random, and if you're allowed to activate the next step. (if canActivateNextStep = true)
	IsNextStepRandom bool `json:"isNextStepRandom,omitempty"`
	// The list of hash identifiers for Perks (DestinySandboxPerkDefinition) that are applied when this step is active. Perks provide a variety of benefits and modifications - examine DestinySandboxPerkDefinition to learn more.
	PerkHashes []int32 `json:"perkHashes,omitempty"`
	// When the Talent Grid's progression reaches this value, the circular \"progress bar\" that surrounds the talent node should be shown.  This also indicates the lower bound of said progress bar, with the upper bound being the progress required to reach activationRequirement.gridLevel. (at some point I should precalculate the upper bound and put it in the definition to save people time)
	StartProgressionBarAtProgress int32 `json:"startProgressionBarAtProgress,omitempty"`
	// When the step provides stat benefits on the item or character, this is the list of hash identifiers for stats (DestinyStatDefinition) that are provided.
	StatHashes []int32 `json:"statHashes,omitempty"`
	// If this is true, the step affects the item's Quality in some way. See DestinyInventoryItemDefinition for more information about the meaning of Quality. I already made a joke about Zen and the Art of Motorcycle Maintenance elsewhere in the documentation, so I will avoid doing it again. Oops too late
	AffectsQuality bool `json:"affectsQuality,omitempty"`
	// In Destiny 1, the Armory's Perk Filtering was driven by a concept of TalentNodeStepGroups: categorizations of talent nodes based on their functionality. While the Armory isn't a BNet-facing thing for now, and the new Armory will need to account for Sockets rather than Talent Nodes, this categorization capability feels useful enough to still keep around.
	StepGroups *AllOfDestinyDefinitionsDestinyNodeStepDefinitionStepGroups `json:"stepGroups,omitempty"`
	// If true, this step can affect the level of the item. See DestinyInventoryItemDefintion for more information about item levels and their effect on stats.
	AffectsLevel bool `json:"affectsLevel,omitempty"`
	// If this step is activated, this will be a list of information used to replace socket items with new Plugs. See DestinyInventoryItemDefinition for more information about sockets and plugs.
	SocketReplacements []DestinyDefinitionsDestinyNodeSocketReplaceResponse `json:"socketReplacements,omitempty"`
}

This defines the properties of a \"Talent Node Step\". When you see a talent node in game, the actual visible properties that you see (its icon, description, the perks and stats it provides) are not provided by the Node itself, but rather by the currently active Step on the node. When a Talent Node is activated, the currently active step's benefits are conferred upon the item and character. The currently active step on talent nodes are determined when an item is first instantiated. Sometimes it is random, sometimes it is more deterministic (particularly when a node has only a single step). Note that, when dealing with Talent Node Steps, you must ensure that you have the latest version of content. stepIndex and nodeStepHash - two ways of identifying the step within a node - are both content version dependent, and thus are subject to change between content updates.

type DestinyDefinitionsDestinyObjectiveDefinition ¶

type DestinyDefinitionsDestinyObjectiveDefinition struct {
	// Ideally, this should tell you what your task is. I'm not going to lie to you though. Sometimes this doesn't have useful information at all. Which sucks, but there's nothing either of us can do about it.
	DisplayProperties *AllOfDestinyDefinitionsDestinyObjectiveDefinitionDisplayProperties `json:"displayProperties,omitempty"`
	// The value that the unlock value defined in unlockValueHash must reach in order for the objective to be considered Completed. Used in calculating progress and completion status.
	CompletionValue int32 `json:"completionValue,omitempty"`
	// A shortcut for determining the most restrictive gating that this Objective is set to use. This includes both the dynamic determination of progress and of completion values. See the DestinyGatingScope enum's documentation for more details.
	Scope int32 `json:"scope,omitempty"`
	// OPTIONAL: a hash identifier for the location at which this objective must be accomplished, if there is a location defined. Look up the DestinyLocationDefinition for this hash for that additional location info.
	LocationHash int32 `json:"locationHash,omitempty"`
	// If true, the value is allowed to go negative.
	AllowNegativeValue bool `json:"allowNegativeValue,omitempty"`
	// If true, you can effectively \"un-complete\" this objective if you lose progress after crossing the completion threshold.   If False, once you complete the task it will remain completed forever by locking the value.
	AllowValueChangeWhenCompleted bool `json:"allowValueChangeWhenCompleted,omitempty"`
	// If true, completion means having an unlock value less than or equal to the completionValue.  If False, completion means having an unlock value greater than or equal to the completionValue.
	IsCountingDownward bool `json:"isCountingDownward,omitempty"`
	// The UI style applied to the objective. It's an enum, take a look at DestinyUnlockValueUIStyle for details of the possible styles. Use this info as you wish to customize your UI.  DEPRECATED: This is no longer populated by Destiny 2 game content. Please use inProgressValueStyle and completedValueStyle instead.
	ValueStyle int32 `json:"valueStyle,omitempty"`
	// Text to describe the progress bar.
	ProgressDescription string `json:"progressDescription,omitempty"`
	// If this objective enables Perks intrinsically, the conditions for that enabling are defined here.
	Perks *AllOfDestinyDefinitionsDestinyObjectiveDefinitionPerks `json:"perks,omitempty"`
	// If this objective enables modifications on a player's stats intrinsically, the conditions are defined here.
	Stats *AllOfDestinyDefinitionsDestinyObjectiveDefinitionStats `json:"stats,omitempty"`
	// If nonzero, this is the minimum value at which the objective's progression should be shown. Otherwise, don't show it yet.
	MinimumVisibilityThreshold int32 `json:"minimumVisibilityThreshold,omitempty"`
	// If True, the progress will continue even beyond the point where the objective met its minimum completion requirements. Your UI will have to accommodate it.
	AllowOvercompletion bool `json:"allowOvercompletion,omitempty"`
	// If True, you should continue showing the progression value in the UI after it's complete. I mean, we already do that in BNet anyways, but if you want to be better behaved than us you could honor this flag.
	ShowValueOnComplete bool `json:"showValueOnComplete,omitempty"`
	// The style to use when the objective is completed.
	CompletedValueStyle int32 `json:"completedValueStyle,omitempty"`
	// The style to use when the objective is still in progress.
	InProgressValueStyle int32 `json:"inProgressValueStyle,omitempty"`
	// Objectives can have arbitrary UI-defined identifiers that define the style applied to objectives. For convenience, known UI labels will be defined in the uiStyle enum value.
	UiLabel string `json:"uiLabel,omitempty"`
	// If the objective has a known UI label value, this property will represent it.
	UiStyle int32 `json:"uiStyle,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

Defines an \"Objective\". An objective is a specific task you should accomplish in the game. These are referred to by: - Quest Steps (which are DestinyInventoryItemDefinition entities with Objectives) - Challenges (which are Objectives defined on an DestinyActivityDefintion) - Milestones (which refer to Objectives that are defined on both Quest Steps and Activities) - Anything else that the designers decide to do later. Objectives have progress, a notion of having been Completed, human readable data describing the task to be accomplished, and a lot of optional tack-on data that can enhance the information provided about the task.

type DestinyDefinitionsDestinyObjectiveDisplayProperties ¶

type DestinyDefinitionsDestinyObjectiveDisplayProperties struct {
	// The activity associated with this objective in the context of this item, if any.
	ActivityHash int32 `json:"activityHash,omitempty"`
	// If true, the game shows this objective on item preview screens.
	DisplayOnItemPreviewScreen bool `json:"displayOnItemPreviewScreen,omitempty"`
}

type DestinyDefinitionsDestinyObjectivePerkEntryDefinition ¶

type DestinyDefinitionsDestinyObjectivePerkEntryDefinition struct {
	// The hash identifier of the DestinySandboxPerkDefinition that will be applied to the character.
	PerkHash int32 `json:"perkHash,omitempty"`
	// An enumeration indicating whether it will be applied as long as the Objective is active, when it's completed, or until it's completed.
	Style int32 `json:"style,omitempty"`
}

Defines the conditions under which an intrinsic perk is applied while participating in an Objective. These perks will generally not be benefit-granting perks, but rather a perk that modifies gameplay in some interesting way.

type DestinyDefinitionsDestinyObjectiveStatEntryDefinition ¶

type DestinyDefinitionsDestinyObjectiveStatEntryDefinition struct {
	// The stat being modified, and the value used.
	Stat *AllOfDestinyDefinitionsDestinyObjectiveStatEntryDefinitionStat `json:"stat,omitempty"`
	// Whether it will be applied as long as the objective is active, when it's completed, or until it's completed.
	Style int32 `json:"style,omitempty"`
}

Defines the conditions under which stat modifications will be applied to a Character while participating in an objective.

type DestinyDefinitionsDestinyPlaceDefinition ¶

type DestinyDefinitionsDestinyPlaceDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

Okay, so Activities (DestinyActivityDefinition) take place in Destinations (DestinyDestinationDefinition). Destinations are part of larger locations known as Places (you're reading its documentation right now). Places are more on the planetary scale, like \"Earth\" and \"Your Mom.\"

type DestinyDefinitionsDestinyPlugItemCraftingRequirements ¶

type DestinyDefinitionsDestinyPlugItemCraftingRequirements struct {
	UnlockRequirements []DestinyDefinitionsDestinyPlugItemCraftingUnlockRequirement `json:"unlockRequirements,omitempty"`
	// If the plug has a known level requirement, it'll be available here.
	RequiredLevel             int32   `json:"requiredLevel,omitempty"`
	MaterialRequirementHashes []int32 `json:"materialRequirementHashes,omitempty"`
}

type DestinyDefinitionsDestinyPlugItemCraftingUnlockRequirement ¶

type DestinyDefinitionsDestinyPlugItemCraftingUnlockRequirement struct {
	FailureDescription string `json:"failureDescription,omitempty"`
}

type DestinyDefinitionsDestinyProgressionDefinition ¶

type DestinyDefinitionsDestinyProgressionDefinition struct {
	DisplayProperties *DestinyDefinitionsDestinyProgressionDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// The \"Scope\" of the progression indicates the source of the progression's live data.  See the DestinyProgressionScope enum for more info: but essentially, a Progression can either be backed by a stored value, or it can be a calculated derivative of other values.
	Scope int32 `json:"scope,omitempty"`
	// If this is True, then the progression doesn't have a maximum level.
	RepeatLastStep bool `json:"repeatLastStep,omitempty"`
	// If there's a description of how to earn this progression in the local config, this will be that localized description.
	Source string `json:"source,omitempty"`
	// Progressions are divided into Steps, which roughly equate to \"Levels\" in the traditional sense of a Progression. Notably, the last step can be repeated indefinitely if repeatLastStep is true, meaning that the calculation for your level is not as simple as comparing your current progress to the max progress of the steps.   These and more calculations are done for you if you grab live character progression data, such as in the DestinyCharacterProgressionComponent.
	Steps []DestinyDefinitionsDestinyProgressionStepDefinition `json:"steps,omitempty"`
	// If true, the Progression is something worth showing to users.  If false, BNet isn't going to show it. But that doesn't mean you can't. We're all friends here.
	Visible bool `json:"visible,omitempty"`
	// If the value exists, this is the hash identifier for the Faction that owns this Progression.  This is purely for convenience, if you're looking at a progression and want to know if and who it's related to in terms of Faction Reputation.
	FactionHash int32 `json:"factionHash,omitempty"`
	// The #RGB string value for the color related to this progression, if there is one.
	Color *AllOfDestinyDefinitionsDestinyProgressionDefinitionColor `json:"color,omitempty"`
	// For progressions that have it, this is the rank icon we use in the Companion, displayed above the progressions' rank value.
	RankIcon    string                                                   `json:"rankIcon,omitempty"`
	RewardItems []DestinyDefinitionsDestinyProgressionRewardItemQuantity `json:"rewardItems,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

A \"Progression\" in Destiny is best explained by an example. A Character's \"Level\" is a progression: it has Experience that can be earned, levels that can be gained, and is evaluated and displayed at various points in the game. A Character's \"Faction Reputation\" is also a progression for much the same reason. Progression is used by a variety of systems, and the definition of a Progression will generally only be useful if combining with live data (such as a character's DestinyCharacterProgressionComponent.progressions property, which holds that character's live Progression states). Fundamentally, a Progression measures your \"Level\" by evaluating the thresholds in its Steps (one step per level, except for the last step which can be repeated indefinitely for \"Levels\" that have no ceiling) against the total earned \"progression points\"/experience. (for simplicity purposes, we will henceforth refer to earned progression points as experience, though it need not be a mechanic that in any way resembles Experience in a traditional sense). Earned experience is calculated in a variety of ways, determined by the Progression's scope. These go from looking up a stored value to performing exceedingly obtuse calculations. This is why we provide live data in DestinyCharacterProgressionComponent.progressions, so you don't have to worry about those.

type DestinyDefinitionsDestinyProgressionDisplayPropertiesDefinition ¶

type DestinyDefinitionsDestinyProgressionDisplayPropertiesDefinition struct {
	// When progressions show your \"experience\" gained, that bar has units (i.e. \"Experience\", \"Bad Dudes Snuffed Out\", whatever). This is the localized string for that unit of measurement.
	DisplayUnitsName string `json:"displayUnitsName,omitempty"`
	Description      string `json:"description,omitempty"`
	Name             string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

type DestinyDefinitionsDestinyProgressionMappingDefinition ¶

type DestinyDefinitionsDestinyProgressionMappingDefinition struct {
	// Infrequently defined in practice. Defer to the individual progressions' display properties.
	DisplayProperties *AllOfDestinyDefinitionsDestinyProgressionMappingDefinitionDisplayProperties `json:"displayProperties,omitempty"`
	// The localized unit of measurement for progression across the progressions defined in this mapping. Unfortunately, this is very infrequently defined. Defer to the individual progressions' display units.
	DisplayUnits string `json:"displayUnits,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

Aggregations of multiple progressions. These are used to apply rewards to multiple progressions at once. They can sometimes have human readable data as well, but only extremely sporadically.

type DestinyDefinitionsDestinyProgressionRewardDefinition ¶

type DestinyDefinitionsDestinyProgressionRewardDefinition struct {
	// The hash identifier of the DestinyProgressionMappingDefinition that contains the progressions for which experience should be applied.
	ProgressionMappingHash int32 `json:"progressionMappingHash,omitempty"`
	// The amount of experience to give to each of the mapped progressions.
	Amount int32 `json:"amount,omitempty"`
	// If true, the game's internal mechanisms to throttle progression should be applied.
	ApplyThrottles bool `json:"applyThrottles,omitempty"`
}

Inventory Items can reward progression when actions are performed on them. A common example of this in Destiny 1 was Bounties, which would reward Experience on your Character and the like when you completed the bounty. Note that this maps to a DestinyProgressionMappingDefinition, and *not* a DestinyProgressionDefinition directly. This is apparently so that multiple progressions can be granted progression points/experience at the same time.

type DestinyDefinitionsDestinyProgressionRewardItemQuantity ¶

type DestinyDefinitionsDestinyProgressionRewardItemQuantity struct {
	RewardedAtProgressionLevel int32    `json:"rewardedAtProgressionLevel,omitempty"`
	AcquisitionBehavior        int32    `json:"acquisitionBehavior,omitempty"`
	UiDisplayStyle             string   `json:"uiDisplayStyle,omitempty"`
	ClaimUnlockDisplayStrings  []string `json:"claimUnlockDisplayStrings,omitempty"`
	// The hash identifier for the item in question. Use it to look up the item's DestinyInventoryItemDefinition.
	ItemHash int32 `json:"itemHash,omitempty"`
	// If this quantity is referring to a specific instance of an item, this will have the item's instance ID. Normally, this will be null.
	ItemInstanceId int64 `json:"itemInstanceId,omitempty"`
	// The amount of the item needed/available depending on the context of where DestinyItemQuantity is being used.
	Quantity int32 `json:"quantity,omitempty"`
	// Indicates that this item quantity may be conditionally shown or hidden, based on various sources of state. For example: server flags, account state, or character progress.
	HasConditionalVisibility bool `json:"hasConditionalVisibility,omitempty"`
}

type DestinyDefinitionsDestinyProgressionStepDefinition ¶

type DestinyDefinitionsDestinyProgressionStepDefinition struct {
	// Very rarely, Progressions will have localized text describing the Level of the progression. This will be that localized text, if it exists. Otherwise, the standard appears to be to simply show the level numerically.
	StepName string `json:"stepName,omitempty"`
	// This appears to be, when you \"level up\", whether a visual effect will display and on what entity. See DestinyProgressionStepDisplayEffect for slightly more info.
	DisplayEffectType int32 `json:"displayEffectType,omitempty"`
	// The total amount of progression points/\"experience\" you will need to initially reach this step. If this is the last step and the progression is repeating indefinitely (DestinyProgressionDefinition.repeatLastStep), this will also be the progress needed to level it up further by repeating this step again.
	ProgressTotal int32 `json:"progressTotal,omitempty"`
	// A listing of items rewarded as a result of reaching this level.
	RewardItems []DestinyDestinyItemQuantity `json:"rewardItems,omitempty"`
	// If this progression step has a specific icon related to it, this is the icon to show.
	Icon string `json:"icon,omitempty"`
}

This defines a single Step in a progression (which roughly equates to a level. See DestinyProgressionDefinition for caveats).

type DestinyDefinitionsDestinyRaceDefinition ¶

type DestinyDefinitionsDestinyRaceDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// An enumeration defining the existing, known Races/Species for player characters. This value will be the enum value matching this definition.
	RaceType int32 `json:"raceType,omitempty"`
	// A localized string referring to the singular form of the Race's name when referred to in gendered form. Keyed by the DestinyGender.
	GenderedRaceNames             map[string]string `json:"genderedRaceNames,omitempty"`
	GenderedRaceNamesByGenderHash map[string]string `json:"genderedRaceNamesByGenderHash,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

In Destiny, \"Races\" are really more like \"Species\". Sort of. I mean, are the Awoken a separate species from humans? I'm not sure. But either way, they're defined here. You'll see Exo, Awoken, and Human as examples of these Species. Players will choose one for their character.

type DestinyDefinitionsDestinyRewardSourceCategory ¶

type DestinyDefinitionsDestinyRewardSourceCategory int32

DestinyDefinitionsDestinyRewardSourceCategory : BNet's custom categorization of reward sources. We took a look at the existing ways that items could be spawned, and tried to make high-level categorizations of them. This needs to be re-evaluated for Destiny 2.

type DestinyDefinitionsDestinyRewardSourceDefinition ¶

type DestinyDefinitionsDestinyRewardSourceDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// Sources are grouped into categories: common ways that items are provided. I hope to see this expand in Destiny 2 once we have time to generate accurate reward source data.
	Category int32 `json:"category,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

Represents a heuristically-determined \"item source\" according to Bungie.net. These item sources are non-canonical: we apply a combination of special configuration and often-fragile heuristics to attempt to discern whether an item should be part of a given \"source,\" but we have known cases of false positives and negatives due to our imperfect heuristics. Still, they provide a decent approximation for people trying to figure out how an item can be obtained. DestinyInventoryItemDefinition refers to sources in the sourceDatas.sourceHashes property for all sources we determined the item could spawn from. An example in Destiny 1 of a Source would be \"Nightfall\". If an item has the \"Nightfall\" source associated with it, it's extremely likely that you can earn that item while playing Nightfall, either during play or as an after-completion reward.

type DestinyDefinitionsDestinySandboxPatternDefinition ¶

type DestinyDefinitionsDestinySandboxPatternDefinition struct {
	PatternHash                int32                                                        `json:"patternHash,omitempty"`
	PatternGlobalTagIdHash     int32                                                        `json:"patternGlobalTagIdHash,omitempty"`
	WeaponContentGroupHash     int32                                                        `json:"weaponContentGroupHash,omitempty"`
	WeaponTranslationGroupHash int32                                                        `json:"weaponTranslationGroupHash,omitempty"`
	WeaponTypeHash             int32                                                        `json:"weaponTypeHash,omitempty"`
	WeaponType                 int32                                                        `json:"weaponType,omitempty"`
	Filters                    []DestinyDefinitionsDestinyArrangementRegionFilterDefinition `json:"filters,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

type DestinyDefinitionsDestinySandboxPerkDefinition ¶

type DestinyDefinitionsDestinySandboxPerkDefinition struct {
	// These display properties are by no means guaranteed to be populated. Usually when it is, it's only because we back-filled them with the displayProperties of some Talent Node or Plug item that happened to be uniquely providing that perk.
	DisplayProperties *AllOfDestinyDefinitionsDestinySandboxPerkDefinitionDisplayProperties `json:"displayProperties,omitempty"`
	// The string identifier for the perk.
	PerkIdentifier string `json:"perkIdentifier,omitempty"`
	// If true, you can actually show the perk in the UI. Otherwise, it doesn't have useful player-facing information.
	IsDisplayable bool `json:"isDisplayable,omitempty"`
	// If this perk grants a damage type to a weapon, the damage type will be defined here.  Unless you have a compelling reason to use this enum value, use the damageTypeHash instead to look up the actual DestinyDamageTypeDefinition.
	DamageType int32 `json:"damageType,omitempty"`
	// The hash identifier for looking up the DestinyDamageTypeDefinition, if this perk has a damage type.  This is preferred over using the damageType enumeration value, which has been left purely because it is occasionally convenient.
	DamageTypeHash int32 `json:"damageTypeHash,omitempty"`
	// An old holdover from the original Armory, this was an attempt to group perks by functionality.  It is as yet unpopulated, and there will be quite a bit of work needed to restore it to its former working order.
	PerkGroups *AllOfDestinyDefinitionsDestinySandboxPerkDefinitionPerkGroups `json:"perkGroups,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

Perks are modifiers to a character or item that can be applied situationally. - Perks determine a weapons' damage type. - Perks put the Mods in Modifiers (they are literally the entity that bestows the Sandbox benefit for whatever fluff text about the modifier in the Socket, Plug or Talent Node) - Perks are applied for unique alterations of state in Objectives Anyways, I'm sure you can see why perks are so interesting. What Perks often don't have is human readable information, so we attempt to reverse engineer that by pulling that data from places that uniquely refer to these perks: namely, Talent Nodes and Plugs. That only gives us a subset of perks that are human readable, but those perks are the ones people generally care about anyways. The others are left as a mystery, their true purpose mostly unknown and undocumented.

type DestinyDefinitionsDestinyStatDefinition ¶

type DestinyDefinitionsDestinyStatDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// Stats can exist on a character or an item, and they may potentially be aggregated in different ways. The DestinyStatAggregationType enum value indicates the way that this stat is being aggregated.
	AggregationType int32 `json:"aggregationType,omitempty"`
	// True if the stat is computed rather than being delivered as a raw value on items.  For instance, the Light stat in Destiny 1 was a computed stat.
	HasComputedBlock bool `json:"hasComputedBlock,omitempty"`
	// The category of the stat, according to the game.
	StatCategory int32 `json:"statCategory,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

This represents a stat that's applied to a character or an item (such as a weapon, piece of armor, or a vehicle). An example of a stat might be Attack Power on a weapon. Stats go through a complex set of transformations before they end up being shown to the user as a number or a progress bar, and those transformations are fundamentally intertwined with the concept of a \"Stat Group\" (DestinyStatGroupDefinition). Items have both Stats and a reference to a Stat Group, and it is the Stat Group that takes the raw stat information and gives it both rendering metadata (such as whether to show it as a number or a progress bar) and the final transformation data (interpolation tables to turn the raw investment stat into a display stat). Please see DestinyStatGroupDefinition for more information on that transformational process. Stats are segregated from Stat Groups because different items and types of items can refer to the same stat, but have different \"scales\" for the stat while still having the same underlying value. For example, both a Shotgun and an Auto Rifle may have a \"raw\" impact stat of 50, but the Auto Rifle's Stat Group will scale that 50 down so that, when it is displayed, it is a smaller value relative to the shotgun. (this is a totally made up example, don't assume shotguns have naturally higher impact than auto rifles because of this) A final caveat is that some stats, even after this \"final\" transformation, go through yet another set of transformations directly in the game as a result of dynamic, stateful scripts that get run. BNet has no access to these scripts, nor any way to know which scripts get executed. As a result, the stats for an item that you see in-game - particularly for stats that are often impacted by Perks, like Magazine Size - can change dramatically from what we return on Bungie.Net. This is a known issue with no fix coming down the pipeline. Take these stats with a grain of salt. Stats actually go through four transformations, for those interested: 1) \"Sandbox\" stat, the \"most raw\" form. These are pretty much useless without transformations applied, and thus are not currently returned in the API. If you really want these, we can provide them. Maybe someone could do something cool with it? 2) \"Investment\" stat (the stat's value after DestinyStatDefinition's interpolation tables and aggregation logic is applied to the \"Sandbox\" stat value) 3) \"Display\" stat (the stat's base UI-visible value after DestinyStatGroupDefinition's interpolation tables are applied to the Investment Stat value. For most stats, this is what is displayed.) 4) Underlying in-game stat (the stat's actual value according to the game, after the game runs dynamic scripts based on the game and character's state. This is the final transformation that BNet does not have access to. For most stats, this is not actually displayed to the user, with the exception of Magazine Size which is then piped back to the UI for display in-game, but not to BNet.)

type DestinyDefinitionsDestinyStatDisplayDefinition ¶

type DestinyDefinitionsDestinyStatDisplayDefinition struct {
	// The hash identifier for the stat being transformed into a Display stat.  Use it to look up the DestinyStatDefinition, or key into a DestinyInventoryItemDefinition's stats property.
	StatHash int32 `json:"statHash,omitempty"`
	// Regardless of the output of interpolation, this is the maximum possible value that the stat can be. It should also be used as the upper bound for displaying the stat as a progress bar (the minimum always being 0)
	MaximumValue int32 `json:"maximumValue,omitempty"`
	// If this is true, the stat should be displayed as a number. Otherwise, display it as a progress bar. Or, you know, do whatever you want. There's no displayAsNumeric police.
	DisplayAsNumeric bool `json:"displayAsNumeric,omitempty"`
	// The interpolation table representing how the Investment Stat is transformed into a Display Stat.   See DestinyStatDefinition for a description of the stages of stat transformation.
	DisplayInterpolation []InterpolationInterpolationPoint `json:"displayInterpolation,omitempty"`
}

Describes the way that an Item Stat (see DestinyStatDefinition) is transformed using the DestinyStatGroupDefinition related to that item. See both of the aforementioned definitions for more information about the stages of stat transformation. This represents the transformation of a stat into a \"Display\" stat (the closest value that BNet can get to the in-game display value of the stat)

type DestinyDefinitionsDestinyStatGroupDefinition ¶

type DestinyDefinitionsDestinyStatGroupDefinition struct {
	// The maximum possible value that any stat in this group can be transformed into.  This is used by stats that *don't* have scaledStats entries below, but that still need to be displayed as a progress bar, in which case this is used as the upper bound for said progress bar. (the lower bound is always 0)
	MaximumValue int32 `json:"maximumValue,omitempty"`
	// This apparently indicates the position of the stats in the UI? I've returned it in case anyone can use it, but it's not of any use to us on BNet. Something's being lost in translation with this value.
	UiPosition int32 `json:"uiPosition,omitempty"`
	// Any stat that requires scaling to be transformed from an \"Investment\" stat to a \"Display\" stat will have an entry in this list. For more information on what those types of stats mean and the transformation process, see DestinyStatDefinition.  In retrospect, I wouldn't mind if this was a dictionary keyed by the stat hash instead. But I'm going to leave it be because [[After Apple Picking]].
	ScaledStats []DestinyDefinitionsDestinyStatDisplayDefinition `json:"scaledStats,omitempty"`
	// The game has the ability to override, based on the stat group, what the localized text is that is displayed for Stats being shown on the item.  Mercifully, no Stat Groups use this feature currently. If they start using them, we'll all need to start using them (and those of you who are more prudent than I am can go ahead and start pre-checking for this.)
	Overrides map[string]DestinyDefinitionsDestinyStatOverrideDefinition `json:"overrides,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

When an inventory item (DestinyInventoryItemDefinition) has Stats (such as Attack Power), the item will refer to a Stat Group. This definition enumerates the properties used to transform the item's \"Investment\" stats into \"Display\" stats. See DestinyStatDefinition's documentation for information about the transformation of Stats, and the meaning of an Investment vs. a Display stat. If you don't want to do these calculations on your own, fear not: pulling live data from the BNet endpoints will return display stat values pre-computed and ready for you to use. I highly recommend this approach, saves a lot of time and also accounts for certain stat modifiers that can't easily be accounted for without live data (such as stat modifiers on Talent Grids and Socket Plugs)

type DestinyDefinitionsDestinyStatOverrideDefinition ¶

type DestinyDefinitionsDestinyStatOverrideDefinition struct {
	// The hash identifier of the stat whose display properties are being overridden.
	StatHash int32 `json:"statHash,omitempty"`
	// The display properties to show instead of the base DestinyStatDefinition display properties.
	DisplayProperties *AllOfDestinyDefinitionsDestinyStatOverrideDefinitionDisplayProperties `json:"displayProperties,omitempty"`
}

Stat Groups (DestinyStatGroupDefinition) has the ability to override the localized text associated with stats that are to be shown on the items with which they are associated. This defines a specific overridden stat. You could theoretically check these before rendering your stat UI, and for each stat that has an override show these displayProperties instead of those on the DestinyStatDefinition. Or you could be like us, and skip that for now because the game has yet to actually use this feature. But know that it's here, waiting for a resilliant young designer to take up the mantle and make us all look foolish by showing the wrong name for stats. Note that, if this gets used, the override will apply only to items using the overriding Stat Group. Other items will still show the default stat's name/description.

type DestinyDefinitionsDestinyTalentExclusiveGroup ¶

type DestinyDefinitionsDestinyTalentExclusiveGroup struct {
	// The identifier for this exclusive group. Only guaranteed unique within the talent grid, not globally.
	GroupHash int32 `json:"groupHash,omitempty"`
	// If this group has an associated piece of lore to show next to it, this will be the identifier for that DestinyLoreDefinition.
	LoreHash int32 `json:"loreHash,omitempty"`
	// A quick reference of the talent nodes that are part of this group, by their Talent Node hashes. (See DestinyTalentNodeDefinition.nodeHash)
	NodeHashes []int32 `json:"nodeHashes,omitempty"`
	// A quick reference of Groups whose nodes will be deactivated if any node in this group is activated.
	OpposingGroupHashes []int32 `json:"opposingGroupHashes,omitempty"`
	// A quick reference of Nodes that will be deactivated if any node in this group is activated, by their Talent Node hashes. (See DestinyTalentNodeDefinition.nodeHash)
	OpposingNodeHashes []int32 `json:"opposingNodeHashes,omitempty"`
}

As of Destiny 2, nodes can exist as part of \"Exclusive Groups\". These differ from exclusive sets in that, within the group, many nodes can be activated. But the act of activating any node in the group will cause \"opposing\" nodes (nodes in groups that are not allowed to be activated at the same time as this group) to deactivate.

type DestinyDefinitionsDestinyTalentGridDefinition ¶

type DestinyDefinitionsDestinyTalentGridDefinition struct {
	// The maximum possible level of the Talent Grid: at this level, any nodes are allowed to be activated.
	MaxGridLevel int32 `json:"maxGridLevel,omitempty"`
	// The meaning of this has been lost in the sands of time: it still exists as a property, but appears to be unused in the modern UI of talent grids. It used to imply that each visual \"column\" of talent nodes required identical progression levels in order to be activated. Returning this value in case it is still useful to someone? Perhaps it's just a bit of interesting history.
	GridLevelPerColumn int32 `json:"gridLevelPerColumn,omitempty"`
	// The hash identifier of the Progression (DestinyProgressionDefinition) that drives whether and when Talent Nodes can be activated on the Grid. Items will have instances of this Progression, and will gain experience that will eventually cause the grid to increase in level. As the grid's level increases, it will cross the threshold where nodes can be activated. See DestinyTalentGridStepDefinition's activation requirements for more information.
	ProgressionHash int32 `json:"progressionHash,omitempty"`
	// The list of Talent Nodes on the Grid (recall that Nodes themselves are really just locations in the UI to show whatever their current Step is. You will only know the current step for a node by retrieving instanced data through platform calls to the API that return DestinyItemTalentGridComponent).
	Nodes []DestinyDefinitionsDestinyTalentNodeDefinition `json:"nodes,omitempty"`
	// Talent Nodes can exist in \"exclusive sets\": these are sets of nodes in which only a single node in the set can be activated at any given time. Activating a node in this set will automatically deactivate the other nodes in the set (referred to as a \"Swap\").  If a node in the exclusive set has already been activated, the game will not charge you materials to activate another node in the set, even if you have never activated it before, because you already paid the cost to activate one node in the set.  Not to be confused with Exclusive Groups. (how the heck do we NOT get confused by that? Jeez) See the groups property for information about that only-tangentially-related concept.
	ExclusiveSets []DestinyDefinitionsDestinyTalentNodeExclusiveSetDefinition `json:"exclusiveSets,omitempty"`
	// This is a quick reference to the indexes of nodes that are not part of exclusive sets. Handy for knowing which talent nodes can only be activated directly, rather than via swapping.
	IndependentNodeIndexes []int32 `json:"independentNodeIndexes,omitempty"`
	// Talent Nodes can have \"Exclusive Groups\". These are not to be confused with Exclusive Sets (see exclusiveSets property).  Look at the definition of DestinyTalentExclusiveGroup for more information and how they work. These groups are keyed by the \"groupHash\" from DestinyTalentExclusiveGroup.
	Groups map[string]DestinyDefinitionsDestinyTalentExclusiveGroup `json:"groups,omitempty"`
	// BNet wants to show talent nodes grouped by similar purpose with localized titles. This is the ordered list of those categories: if you want to show nodes by category, you can iterate over this list, render the displayProperties for the category as the title, and then iterate over the talent nodes referenced by the category to show the related nodes.  Note that this is different from Exclusive Groups or Sets, because these categories also incorporate \"Independent\" nodes that belong to neither sets nor groups. These are purely for visual grouping of nodes rather than functional grouping.
	NodeCategories []DestinyDefinitionsDestinyTalentNodeCategory `json:"nodeCategories,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

The time has unfortunately come to talk about Talent Grids. Talent Grids are the most complex and unintuitive part of the Destiny Definition data. Grab a cup of coffee before we begin, I can wait. Talent Grids were the primary way that items could be customized in Destiny 1. In Destiny 2, for now, talent grids have become exclusively used by Subclass/Build items: but the system is still in place for it to be used by items should the direction change back toward talent grids. Talent Grids have Nodes: the visual circles on the talent grid detail screen that have icons and can be activated if you meet certain requirements and pay costs. The actual visual data and effects, however, are driven by the \"Steps\" on Talent Nodes. Any given node will have 1:M of these steps, and the specific step that will be considered the \"current\" step (and thus the dictator of all benefits, visual state, and activation requirements on the Node) will almost always not be determined until an instance of the item is created. This is how, in Destiny 1, items were able to have such a wide variety of what users saw as \"Perks\": they were actually Talent Grids with nodes that had a wide variety of Steps, randomly chosen at the time of item creation. Now that Talent Grids are used exclusively by subclasses and builds, all of the properties within still apply: but there are additional visual elements on the Subclass/Build screens that are superimposed on top of the talent nodes. Unfortunately, BNet doesn't have this data: if you want to build a subclass screen, you will have to provide your own \"decorative\" assets, such as the visual connectors between nodes and the fancy colored-fire-bathed character standing behind the nodes. DestinyInventoryItem.talentGrid.talentGridHash defines an item's linked Talent Grid, which brings you to this definition that contains enough satic data about talent grids to make your head spin. These *must* be combined with instanced data - found when live data returns DestinyItemTalentGridComponent - in order to derive meaning. The instanced data will reference nodes and steps within these definitions, which you will then have to look up in the definition and combine with the instanced data to give the user the visual representation of their item's talent grid.

type DestinyDefinitionsDestinyTalentNodeCategory ¶

type DestinyDefinitionsDestinyTalentNodeCategory struct {
	// Mostly just for debug purposes, but if you find it useful you can have it. This is BNet's manually created identifier for this category.
	Identifier string `json:"identifier,omitempty"`
	// If true, we found the localized content in a related DestinyLoreDefinition instead of local BNet localization files. This is mostly for ease of my own future investigations.
	IsLoreDriven bool `json:"isLoreDriven,omitempty"`
	// Will contain at least the \"name\", which will be the title of the category. We will likely not have description and an icon yet, but I'm going to keep my options open.
	DisplayProperties *AllOfDestinyDefinitionsDestinyTalentNodeCategoryDisplayProperties `json:"displayProperties,omitempty"`
	// The set of all hash identifiers for Talent Nodes (DestinyTalentNodeDefinition) in this Talent Grid that are part of this Category.
	NodeHashes []int32 `json:"nodeHashes,omitempty"`
}

An artificial construct provided by Bungie.Net, where we attempt to group talent nodes by functionality. This is a single set of references to Talent Nodes that share a common trait or purpose.

type DestinyDefinitionsDestinyTalentNodeDefinition ¶

type DestinyDefinitionsDestinyTalentNodeDefinition struct {
	// The index into the DestinyTalentGridDefinition's \"nodes\" property where this node is located. Used to uniquely identify the node within the Talent Grid. Note that this is content version dependent: make sure you have the latest version of content before trying to use these properties.
	NodeIndex int32 `json:"nodeIndex,omitempty"`
	// The hash identifier for the node, which unfortunately is also content version dependent but can be (and ideally, should be) used instead of the nodeIndex to uniquely identify the node.  The two exist side-by-side for backcompat reasons due to the Great Talent Node Restructuring of Destiny 1, and I ran out of time to remove one of them and standardize on the other. Sorry!
	NodeHash int32 `json:"nodeHash,omitempty"`
	// The visual \"row\" where the node should be shown in the UI. If negative, then the node is hidden.
	Row int32 `json:"row,omitempty"`
	// The visual \"column\" where the node should be shown in the UI. If negative, the node is hidden.
	Column int32 `json:"column,omitempty"`
	// Indexes into the DestinyTalentGridDefinition.nodes property for any nodes that must be activated before this one is allowed to be activated.  I would have liked to change this to hashes for Destiny 2, but we have run out of time.
	PrerequisiteNodeIndexes []int32 `json:"prerequisiteNodeIndexes,omitempty"`
	// At one point, Talent Nodes supported the idea of \"Binary Pairs\": nodes that overlapped each other visually, and where activating one deactivated the other. They ended up not being used, mostly because Exclusive Sets are *almost* a superset of this concept, but the potential for it to be used still exists in theory.  If this is ever used, this will be the index into the DestinyTalentGridDefinition.nodes property for the node that is the binary pair match to this node. Activating one deactivates the other.
	BinaryPairNodeIndex int32 `json:"binaryPairNodeIndex,omitempty"`
	// If true, this node will automatically unlock when the Talent Grid's level reaches the required level of the current step of this node.
	AutoUnlocks bool `json:"autoUnlocks,omitempty"`
	// At one point, Nodes were going to be able to be activated multiple times, changing the current step and potentially piling on multiple effects from the previously activated steps. This property would indicate if the last step could be activated multiple times.   This is not currently used, but it isn't out of the question that this could end up being used again in a theoretical future.
	LastStepRepeats bool `json:"lastStepRepeats,omitempty"`
	// If this is true, the node's step is determined randomly rather than the first step being chosen.
	IsRandom bool `json:"isRandom,omitempty"`
	// At one point, you were going to be able to repurchase talent nodes that had random steps, to \"re-roll\" the current step of the node (and thus change the properties of your item). This was to be the activation requirement for performing that re-roll.  The system still exists to do this, as far as I know, so it may yet come back around!
	RandomActivationRequirement *AllOfDestinyDefinitionsDestinyTalentNodeDefinitionRandomActivationRequirement `json:"randomActivationRequirement,omitempty"`
	// If this is true, the node can be \"re-rolled\" to acquire a different random current step. This is not used, but still exists for a theoretical future of talent grids.
	IsRandomRepurchasable bool `json:"isRandomRepurchasable,omitempty"`
	// At this point, \"steps\" have been obfuscated into conceptual entities, aggregating the underlying notions of \"properties\" and \"true steps\".  If you need to know a step as it truly exists - such as when recreating Node logic when processing Vendor data - you'll have to use the \"realSteps\" property below.
	Steps []DestinyDefinitionsDestinyNodeStepDefinition `json:"steps,omitempty"`
	// The nodeHash values for nodes that are in an Exclusive Set with this node.  See DestinyTalentGridDefinition.exclusiveSets for more info about exclusive sets.  Again, note that these are nodeHashes and *not* nodeIndexes.
	ExclusiveWithNodeHashes []int32 `json:"exclusiveWithNodeHashes,omitempty"`
	// If the node's step is randomly selected, this is the amount of the Talent Grid's progression experience at which the progression bar for the node should be shown.
	RandomStartProgressionBarAtProgression int32 `json:"randomStartProgressionBarAtProgression,omitempty"`
	// A string identifier for a custom visual layout to apply to this talent node. Unfortunately, we do not have any data for rendering these custom layouts. It will be up to you to interpret these strings and change your UI if you want to have custom UI matching these layouts.
	LayoutIdentifier string `json:"layoutIdentifier,omitempty"`
	// As of Destiny 2, nodes can exist as part of \"Exclusive Groups\". These differ from exclusive sets in that, within the group, many nodes can be activated. But the act of activating any node in the group will cause \"opposing\" nodes (nodes in groups that are not allowed to be activated at the same time as this group) to deactivate.  See DestinyTalentExclusiveGroup for more information on the details. This is an identifier for this node's group, if it is part of one.
	GroupHash int32 `json:"groupHash,omitempty"`
	// Talent nodes can be associated with a piece of Lore, generally rendered in a tooltip. This is the hash identifier of the lore element to show, if there is one to be show.
	LoreHash int32 `json:"loreHash,omitempty"`
	// Comes from the talent grid node style: this identifier should be used to determine how to render the node in the UI.
	NodeStyleIdentifier string `json:"nodeStyleIdentifier,omitempty"`
	// Comes from the talent grid node style: if true, then this node should be ignored for determining whether the grid is complete.
	IgnoreForCompletion bool `json:"ignoreForCompletion,omitempty"`
}

Talent Grids on items have Nodes. These nodes have positions in the talent grid's UI, and contain \"Steps\" (DestinyTalentNodeStepDefinition), one of whom will be the \"Current\" step. The Current Step determines the visual properties of the node, as well as what the node grants when it is activated. See DestinyTalentGridDefinition for a more complete overview of how Talent Grids work, and how they are used in Destiny 2 (and how they were used in Destiny 1).

type DestinyDefinitionsDestinyTalentNodeExclusiveSetDefinition ¶

type DestinyDefinitionsDestinyTalentNodeExclusiveSetDefinition struct {
	// The list of node indexes for the exclusive set. Historically, these were indexes. I would have liked to replace this with nodeHashes for consistency, but it's way too late for that. (9:09 PM, he's right!)
	NodeIndexes []int32 `json:"nodeIndexes,omitempty"`
}

The list of indexes into the Talent Grid's \"nodes\" property for nodes in this exclusive set. (See DestinyTalentNodeDefinition.nodeIndex)

type DestinyDefinitionsDestinyTalentNodeStepDamageTypes ¶

type DestinyDefinitionsDestinyTalentNodeStepDamageTypes int32

type DestinyDefinitionsDestinyTalentNodeStepGroups ¶

type DestinyDefinitionsDestinyTalentNodeStepGroups struct {
	WeaponPerformance  int32 `json:"weaponPerformance,omitempty"`
	ImpactEffects      int32 `json:"impactEffects,omitempty"`
	GuardianAttributes int32 `json:"guardianAttributes,omitempty"`
	LightAbilities     int32 `json:"lightAbilities,omitempty"`
	DamageTypes        int32 `json:"damageTypes,omitempty"`
}

These properties are an attempt to categorize talent node steps by certain common properties. See the related enumerations for the type of properties being categorized.

type DestinyDefinitionsDestinyTalentNodeStepGuardianAttributes ¶

type DestinyDefinitionsDestinyTalentNodeStepGuardianAttributes int32

type DestinyDefinitionsDestinyTalentNodeStepImpactEffects ¶

type DestinyDefinitionsDestinyTalentNodeStepImpactEffects int32

type DestinyDefinitionsDestinyTalentNodeStepLightAbilities ¶

type DestinyDefinitionsDestinyTalentNodeStepLightAbilities int32

type DestinyDefinitionsDestinyTalentNodeStepWeaponPerformances ¶

type DestinyDefinitionsDestinyTalentNodeStepWeaponPerformances int32

type DestinyDefinitionsDestinyUnlockDefinition ¶

type DestinyDefinitionsDestinyUnlockDefinition struct {
	// Sometimes, but not frequently, these unlock flags also have human readable information: usually when they are being directly tested for some requirement, in which case the string is a localized description of why the requirement check failed.
	DisplayProperties *AllOfDestinyDefinitionsDestinyUnlockDefinitionDisplayProperties `json:"displayProperties,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

Unlock Flags are small bits (literally, a bit, as in a boolean value) that the game server uses for an extremely wide range of state checks, progress storage, and other interesting tidbits of information.

type DestinyDefinitionsDestinyUnlockExpressionDefinition ¶

type DestinyDefinitionsDestinyUnlockExpressionDefinition struct {
	// A shortcut for determining the most restrictive gating that this expression performs. See the DestinyGatingScope enum's documentation for more details.
	Scope int32 `json:"scope,omitempty"`
}

Where the sausage gets made. Unlock Expressions are the foundation of the game's gating mechanics and investment-related restrictions. They can test Unlock Flags and Unlock Values for certain states, using a sufficient amount of logical operators such that unlock expressions are effectively Turing complete. Use UnlockExpressionParser to evaluate expressions using an IUnlockContext parsed from Babel.

type DestinyDefinitionsDestinyUnlockValueDefinition ¶

type DestinyDefinitionsDestinyUnlockValueDefinition struct {
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

An Unlock Value is an internal integer value, stored on the server and used in a variety of ways, most frequently for the gating/requirement checks that the game performs across all of its main features. They can also be used as the storage data for mapped Progressions, Objectives, and other features that require storage of variable numeric values.

type DestinyDefinitionsDestinyVendorAcceptedItemDefinition ¶

type DestinyDefinitionsDestinyVendorAcceptedItemDefinition struct {
	// The \"source\" bucket for a transfer. When a user wants to transfer an item, the appropriate DestinyVendorDefinition's acceptedItems property is evaluated, looking for an entry where acceptedInventoryBucketHash matches the bucket that the item being transferred is currently located. If it exists, the item will be transferred into whatever bucket is defined by destinationInventoryBucketHash.
	AcceptedInventoryBucketHash int32 `json:"acceptedInventoryBucketHash,omitempty"`
	// This is the bucket where the item being transferred will be put, given that it was being transferred *from* the bucket defined in acceptedInventoryBucketHash.
	DestinationInventoryBucketHash int32 `json:"destinationInventoryBucketHash,omitempty"`
}

If you ever wondered how the Vault works, here it is. The Vault is merely a set of inventory buckets that exist on your Profile/Account level. When you transfer items in the Vault, the game is using the Vault Vendor's DestinyVendorAcceptedItemDefinitions to see where the appropriate destination bucket is for the source bucket from whence your item is moving. If it finds such an entry, it transfers the item to the other bucket. The mechanics for Postmaster works similarly, which is also a vendor. All driven by Accepted Items.

type DestinyDefinitionsDestinyVendorActionDefinition ¶

type DestinyDefinitionsDestinyVendorActionDefinition struct {
	Description       string `json:"description,omitempty"`
	ExecuteSeconds    int32  `json:"executeSeconds,omitempty"`
	Icon              string `json:"icon,omitempty"`
	Name              string `json:"name,omitempty"`
	Verb              string `json:"verb,omitempty"`
	IsPositive        bool   `json:"isPositive,omitempty"`
	ActionId          string `json:"actionId,omitempty"`
	ActionHash        int32  `json:"actionHash,omitempty"`
	AutoPerformAction bool   `json:"autoPerformAction,omitempty"`
}

If a vendor can ever end up performing actions, these are the properties that will be related to those actions. I'm not going to bother documenting this yet, as it is unused and unclear if it will ever be used... but in case it is ever populated and someone finds it useful, it is defined here.

type DestinyDefinitionsDestinyVendorCategoryEntryDefinition ¶

type DestinyDefinitionsDestinyVendorCategoryEntryDefinition struct {
	// The index of the category in the original category definitions for the vendor.
	CategoryIndex int32 `json:"categoryIndex,omitempty"`
	// Used in sorting items in vendors... but there's a lot more to it. Just go with the order provided in the itemIndexes property on the DestinyVendorCategoryComponent instead, it should be more reliable than trying to recalculate it yourself.
	SortValue int32 `json:"sortValue,omitempty"`
	// The hashed identifier for the category.
	CategoryHash int32 `json:"categoryHash,omitempty"`
	// The amount of items that will be available when this category is shown.
	QuantityAvailable int32 `json:"quantityAvailable,omitempty"`
	// If items aren't up for sale in this category, should we still show them (greyed out)?
	ShowUnavailableItems bool `json:"showUnavailableItems,omitempty"`
	// If you don't have the currency required to buy items from this category, should the items be hidden?
	HideIfNoCurrency bool `json:"hideIfNoCurrency,omitempty"`
	// True if this category doesn't allow purchases.
	HideFromRegularPurchase bool `json:"hideFromRegularPurchase,omitempty"`
	// The localized string for making purchases from this category, if it is different from the vendor's string for purchasing.
	BuyStringOverride string `json:"buyStringOverride,omitempty"`
	// If the category is disabled, this is the localized description to show.
	DisabledDescription string `json:"disabledDescription,omitempty"`
	// The localized title of the category.
	DisplayTitle string `json:"displayTitle,omitempty"`
	// If this category has an overlay prompt that should appear, this contains the details of that prompt.
	Overlay *AllOfDestinyDefinitionsDestinyVendorCategoryEntryDefinitionOverlay `json:"overlay,omitempty"`
	// A shortcut for the vendor item indexes sold under this category. Saves us from some expensive reorganization at runtime.
	VendorItemIndexes []int32 `json:"vendorItemIndexes,omitempty"`
	// Sometimes a category isn't actually used to sell items, but rather to preview them. This implies different UI (and manual placement of the category in the UI) in the game, and special treatment.
	IsPreview bool `json:"isPreview,omitempty"`
	// If true, this category only displays items: you can't purchase anything in them.
	IsDisplayOnly                bool  `json:"isDisplayOnly,omitempty"`
	ResetIntervalMinutesOverride int32 `json:"resetIntervalMinutesOverride,omitempty"`
	ResetOffsetMinutesOverride   int32 `json:"resetOffsetMinutesOverride,omitempty"`
}

This is the definition for a single Vendor Category, into which Sale Items are grouped.

type DestinyDefinitionsDestinyVendorCategoryOverlayDefinition ¶

type DestinyDefinitionsDestinyVendorCategoryOverlayDefinition struct {
	ChoiceDescription string `json:"choiceDescription,omitempty"`
	Description       string `json:"description,omitempty"`
	Icon              string `json:"icon,omitempty"`
	Title             string `json:"title,omitempty"`
	// If this overlay has a currency item that it features, this is said featured item.
	CurrencyItemHash int32 `json:"currencyItemHash,omitempty"`
}

The details of an overlay prompt to show to a user. They are all fairly self-explanatory localized strings that can be shown.

type DestinyDefinitionsDestinyVendorDefinition ¶

type DestinyDefinitionsDestinyVendorDefinition struct {
	DisplayProperties *DestinyDefinitionsDestinyVendorDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// The type of reward progression that this vendor has. Default - The original rank progression from token redemption. Ritual - Progression from ranks in ritual content. For example: Crucible (Shaxx), Gambit (Drifter), and Battlegrounds (War Table).
	VendorProgressionType int32 `json:"vendorProgressionType,omitempty"`
	// If the vendor has a custom localized string describing the \"buy\" action, that is returned here.
	BuyString string `json:"buyString,omitempty"`
	// Ditto for selling. Not that you can sell items to a vendor anymore. Will it come back? Who knows. The string's still there.
	SellString string `json:"sellString,omitempty"`
	// If the vendor has an item that should be displayed as the \"featured\" item, this is the hash identifier for that DestinyVendorItemDefinition.  Apparently this is usually a related currency, like a reputation token. But it need not be restricted to that.
	DisplayItemHash int32 `json:"displayItemHash,omitempty"`
	// If this is true, you aren't allowed to buy whatever the vendor is selling.
	InhibitBuying bool `json:"inhibitBuying,omitempty"`
	// If this is true, you're not allowed to sell whatever the vendor is buying.
	InhibitSelling bool `json:"inhibitSelling,omitempty"`
	// If the Vendor has a faction, this hash will be valid and point to a DestinyFactionDefinition.  The game UI and BNet often mine the faction definition for additional elements and details to place on the screen, such as the faction's Progression status (aka \"Reputation\").
	FactionHash int32 `json:"factionHash,omitempty"`
	// A number used for calculating the frequency of a vendor's inventory resetting/refreshing.  Don't worry about calculating this - we do it on the server side and send you the next refresh date with the live data.
	ResetIntervalMinutes int32 `json:"resetIntervalMinutes,omitempty"`
	// Again, used for reset/refreshing of inventory. Don't worry too much about it. Unless you want to.
	ResetOffsetMinutes int32 `json:"resetOffsetMinutes,omitempty"`
	// If an item can't be purchased from the vendor, there may be many \"custom\"/game state specific reasons why not.  This is a list of localized strings with messages for those custom failures. The live BNet data will return a failureIndexes property for items that can't be purchased: using those values to index into this array, you can show the user the appropriate failure message for the item that can't be bought.
	FailureStrings []string `json:"failureStrings,omitempty"`
	// If we were able to predict the dates when this Vendor will be visible/available, this will be the list of those date ranges. Sadly, we're not able to predict this very frequently, so this will often be useless data.
	UnlockRanges []DatesDateRange `json:"unlockRanges,omitempty"`
	// The internal identifier for the Vendor. A holdover from the old days of Vendors, but we don't have time to refactor it away.
	VendorIdentifier string `json:"vendorIdentifier,omitempty"`
	// A portrait of the Vendor's smiling mug. Or frothing tentacles.
	VendorPortrait string `json:"vendorPortrait,omitempty"`
	// If the vendor has a custom banner image, that can be found here.
	VendorBanner string `json:"vendorBanner,omitempty"`
	// If a vendor is not enabled, we won't even save the vendor's definition, and we won't return any items or info about them. It's as if they don't exist.
	Enabled bool `json:"enabled,omitempty"`
	// If a vendor is not visible, we still have and will give vendor definition info, but we won't use them for things like Advisors or UI.
	Visible bool `json:"visible,omitempty"`
	// The identifier of the VendorCategoryDefinition for this vendor's subcategory.
	VendorSubcategoryIdentifier string `json:"vendorSubcategoryIdentifier,omitempty"`
	// If TRUE, consolidate categories that only differ by trivial properties (such as having minor differences in name)
	ConsolidateCategories bool `json:"consolidateCategories,omitempty"`
	// Describes \"actions\" that can be performed on a vendor. Currently, none of these exist. But theoretically a Vendor could let you interact with it by performing actions. We'll see what these end up looking like if they ever get used.
	Actions []DestinyDefinitionsDestinyVendorActionDefinition `json:"actions,omitempty"`
	// These are the headers for sections of items that the vendor is selling. When you see items organized by category in the header, it is these categories that it is showing.  Well, technically not *exactly* these. On BNet, it doesn't make sense to have categories be \"paged\" as we do in Destiny, so we run some heuristics to attempt to aggregate pages of categories together.   These are the categories post-concatenation, if the vendor had concatenation applied. If you want the pre-aggregated category data, use originalCategories.
	Categories []DestinyDefinitionsDestinyVendorCategoryEntryDefinition `json:"categories,omitempty"`
	// See the categories property for a description of categories and why originalCategories exists.
	OriginalCategories []DestinyDefinitionsDestinyVendorCategoryEntryDefinition `json:"originalCategories,omitempty"`
	// Display Categories are different from \"categories\" in that these are specifically for visual grouping and display of categories in Vendor UI.   The \"categories\" structure is for validation of the contained items, and can be categorized entirely separately from \"Display Categories\", there need be and often will be no meaningful relationship between the two.
	DisplayCategories []DestinyDefinitionsDestinyDisplayCategoryDefinition `json:"displayCategories,omitempty"`
	// In addition to selling items, vendors can have \"interactions\": UI where you \"talk\" with the vendor and they offer you a reward, some item, or merely acknowledge via dialog that you did something cool.
	Interactions []DestinyDefinitionsDestinyVendorInteractionDefinition `json:"interactions,omitempty"`
	// If the vendor shows you items from your own inventory - such as the Vault vendor does - this data describes the UI around showing those inventory buckets and which ones get shown.
	InventoryFlyouts []DestinyDefinitionsDestinyVendorInventoryFlyoutDefinition `json:"inventoryFlyouts,omitempty"`
	// If the vendor sells items (or merely has a list of items to show like the \"Sack\" vendors do), this is the list of those items that the vendor can sell. From this list, only a subset will be available from the vendor at any given time, selected randomly and reset on the vendor's refresh interval.  Note that a vendor can sell the same item multiple ways: for instance, nothing stops a vendor from selling you some specific weapon but using two different currencies, or the same weapon at multiple \"item levels\".
	ItemList []DestinyDefinitionsDestinyVendorItemDefinition `json:"itemList,omitempty"`
	// BNet doesn't use this data yet, but it appears to be an optional list of flavor text about services that the Vendor can provide.
	Services []DestinyDefinitionsDestinyVendorServiceDefinition `json:"services,omitempty"`
	// If the Vendor is actually a vehicle for the transferring of items (like the Vault and Postmaster vendors), this defines the list of source->destination buckets for transferring.
	AcceptedItems []DestinyDefinitionsDestinyVendorAcceptedItemDefinition `json:"acceptedItems,omitempty"`
	// As many of you know, Vendor data has historically been pretty brutal on the BNet servers. In an effort to reduce this workload, only Vendors with this flag set will be returned on Vendor requests. This allows us to filter out Vendors that don't dynamic data that's particularly useful: things like \"Preview/Sack\" vendors, for example, that you can usually suss out the details for using just the definitions themselves.
	ReturnWithVendorRequest bool `json:"returnWithVendorRequest,omitempty"`
	// A vendor can be at different places in the world depending on the game/character/account state. This is the list of possible locations for the vendor, along with conditions we use to determine which one is currently active.
	Locations []DestinyDefinitionsVendorsDestinyVendorLocationDefinition `json:"locations,omitempty"`
	// A vendor can be a part of 0 or 1 \"groups\" at a time: a group being a collection of Vendors related by either location or function/purpose. It's used for our our Companion Vendor UI. Only one of these can be active for a Vendor at a time.
	Groups []DestinyDefinitionsDestinyVendorGroupReference `json:"groups,omitempty"`
	// Some items don't make sense to return in the API, for example because they represent an action to be performed rather than an item being sold. I'd rather we not do this, but at least in the short term this is a workable workaround.
	IgnoreSaleItemHashes []int32 `json:"ignoreSaleItemHashes,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

These are the definitions for Vendors. In Destiny, a Vendor can be a lot of things - some things that you wouldn't expect, and some things that you don't even see directly in the game. Vendors are the Dolly Levi of the Destiny universe. - Traditional Vendors as you see in game: people who you come up to and who give you quests, rewards, or who you can buy things from. - Kiosks/Collections, which are really just Vendors that don't charge currency (or charge some pittance of a currency) and whose gating for purchases revolves more around your character's state. - Previews for rewards or the contents of sacks. These are implemented as Vendors, where you can't actually purchase from them but the items that they have for sale and the categories of sale items reflect the rewards or contents of the sack. This is so that the game could reuse the existing Vendor display UI for rewards and save a bunch of wheel reinvention. - Item Transfer capabilities, like the Vault and Postmaster. Vendors can have \"acceptedItem\" buckets that determine the source and destination buckets for transfers. When you interact with such a vendor, these buckets are what gets shown in the UI instead of any items that the Vendor would have for sale. Yep, the Vault is a vendor. It is pretty much guaranteed that they'll be used for even more features in the future. They have come to be seen more as generic categorized containers for items than \"vendors\" in a traditional sense, for better or worse. Where possible and time allows, we'll attempt to split those out into their own more digestible derived \"Definitions\": but often time does not allow that, as you can see from the above ways that vendors are used which we never split off from Vendor Definitions externally. Since Vendors are so many things to so many parts of the game, the definition is understandably complex. You will want to combine this data with live Vendor information from the API when it is available.

type DestinyDefinitionsDestinyVendorDisplayPropertiesDefinition ¶

type DestinyDefinitionsDestinyVendorDisplayPropertiesDefinition struct {
	// I regret calling this a \"large icon\". It's more like a medium-sized image with a picture of the vendor's mug on it, trying their best to look cool. Not what one would call an icon.
	LargeIcon string `json:"largeIcon,omitempty"`
	Subtitle  string `json:"subtitle,omitempty"`
	// If we replaced the icon with something more glitzy, this is the original icon that the vendor had according to the game's content. It may be more lame and/or have less razzle-dazzle. But who am I to tell you which icon to use.
	OriginalIcon string `json:"originalIcon,omitempty"`
	// Vendors, in addition to expected display property data, may also show some \"common requirements\" as statically defined definition data. This might be when a vendor accepts a single type of currency, or when the currency is unique to the vendor and the designers wanted to show that currency when you interact with the vendor.
	RequirementsDisplay []DestinyDefinitionsDestinyVendorRequirementDisplayEntryDefinition `json:"requirementsDisplay,omitempty"`
	// This is the icon used in parts of the game UI such as the vendor's waypoint.
	SmallTransparentIcon string `json:"smallTransparentIcon,omitempty"`
	// This is the icon used in the map overview, when the vendor is located on the map.
	MapIcon string `json:"mapIcon,omitempty"`
	// This is apparently the \"Watermark\". I am not certain offhand where this is actually used in the Game UI, but some people may find it useful.
	LargeTransparentIcon string `json:"largeTransparentIcon,omitempty"`
	Description          string `json:"description,omitempty"`
	Name                 string `json:"name,omitempty"`
	// Note that \"icon\" is sometimes misleading, and should be interpreted in the context of the entity. For instance, in Destiny 1 the DestinyRecordBookDefinition's icon was a big picture of a book.  But usually, it will be a small square image that you can use as... well, an icon.  They are currently represented as 96px x 96px images.
	Icon          string                                                  `json:"icon,omitempty"`
	IconSequences []DestinyDefinitionsCommonDestinyIconSequenceDefinition `json:"iconSequences,omitempty"`
	// If this item has a high-res icon (at least for now, many things won't), then the path to that icon will be here.
	HighResIcon string `json:"highResIcon,omitempty"`
	HasIcon     bool   `json:"hasIcon,omitempty"`
}

type DestinyDefinitionsDestinyVendorGroupDefinition ¶

type DestinyDefinitionsDestinyVendorGroupDefinition struct {
	// The recommended order in which to render the groups, Ascending order.
	Order int32 `json:"order,omitempty"`
	// For now, a group just has a name.
	CategoryName string `json:"categoryName,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

BNet attempts to group vendors into similar collections. These groups aren't technically game canonical, but they are helpful for filtering vendors or showing them organized into a clean view on a webpage or app. These definitions represent the groups we've built. Unlike in Destiny 1, a Vendors' group may change dynamically as the game state changes: thus, you will want to check DestinyVendorComponent responses to find a vendor's currently active Group (if you care). Using this will let you group your vendors in your UI in a similar manner to how we will do grouping in the Companion.

type DestinyDefinitionsDestinyVendorGroupReference ¶

type DestinyDefinitionsDestinyVendorGroupReference struct {
	// The DestinyVendorGroupDefinition to which this Vendor can belong.
	VendorGroupHash int32 `json:"vendorGroupHash,omitempty"`
}

type DestinyDefinitionsDestinyVendorInteractionDefinition ¶

type DestinyDefinitionsDestinyVendorInteractionDefinition struct {
	// The position of this interaction in its parent array. Note that this is NOT content agnostic, and should not be used as such.
	InteractionIndex int32 `json:"interactionIndex,omitempty"`
	// The potential replies that the user can make to the interaction.
	Replies []DestinyDefinitionsDestinyVendorInteractionReplyDefinition `json:"replies,omitempty"`
	// If >= 0, this is the category of sale items to show along with this interaction dialog.
	VendorCategoryIndex int32 `json:"vendorCategoryIndex,omitempty"`
	// If this interaction dialog is about a quest, this is the questline related to the interaction. You can use this to show the quest overview, or even the character's status with the quest if you use it to find the character's current Quest Step by checking their inventory against this questlineItemHash's DestinyInventoryItemDefinition.setData.
	QuestlineItemHash int32 `json:"questlineItemHash,omitempty"`
	// If this interaction is meant to show you sacks, this is the list of types of sacks to be shown. If empty, the interaction is not meant to show sacks.
	SackInteractionList []DestinyDefinitionsDestinyVendorInteractionSackEntryDefinition `json:"sackInteractionList,omitempty"`
	// A UI hint for the behavior of the interaction screen. This is useful to determine what type of interaction is occurring, such as a prompt to receive a rank up reward or a prompt to choose a reward for completing a quest. The hash isn't as useful as the Enum in retrospect, well what can you do. Try using interactionType instead.
	UiInteractionType int32 `json:"uiInteractionType,omitempty"`
	// The enumerated version of the possible UI hints for vendor interactions, which is a little easier to grok than the hash found in uiInteractionType.
	InteractionType int32 `json:"interactionType,omitempty"`
	// If this interaction is displaying rewards, this is the text to use for the header of the reward-displaying section of the interaction.
	RewardBlockLabel string `json:"rewardBlockLabel,omitempty"`
	// If the vendor's reward list is sourced from one of his categories, this is the index into the category array of items to show.
	RewardVendorCategoryIndex int32 `json:"rewardVendorCategoryIndex,omitempty"`
	// If the vendor interaction has flavor text, this is some of it.
	FlavorLineOne string `json:"flavorLineOne,omitempty"`
	// If the vendor interaction has flavor text, this is the rest of it.
	FlavorLineTwo string `json:"flavorLineTwo,omitempty"`
	// The header for the interaction dialog.
	HeaderDisplayProperties *AllOfDestinyDefinitionsDestinyVendorInteractionDefinitionHeaderDisplayProperties `json:"headerDisplayProperties,omitempty"`
	// The localized text telling the player what to do when they see this dialog.
	Instructions string `json:"instructions,omitempty"`
}

A Vendor Interaction is a dialog shown by the vendor other than sale items or transfer screens. The vendor is showing you something, and asking you to reply to it by choosing an option or reward.

type DestinyDefinitionsDestinyVendorInteractionReplyDefinition ¶

type DestinyDefinitionsDestinyVendorInteractionReplyDefinition struct {
	// The rewards granted upon responding to the vendor.
	ItemRewardsSelection int32 `json:"itemRewardsSelection,omitempty"`
	// The localized text for the reply.
	Reply string `json:"reply,omitempty"`
	// An enum indicating the type of reply being made.
	ReplyType int32 `json:"replyType,omitempty"`
}

When the interaction is replied to, Reward sites will fire and items potentially selected based on whether the given unlock expression is TRUE. You can potentially choose one from multiple replies when replying to an interaction: this is how you get either/or rewards from vendors.

type DestinyDefinitionsDestinyVendorInteractionSackEntryDefinition ¶

type DestinyDefinitionsDestinyVendorInteractionSackEntryDefinition struct {
	SackType int32 `json:"sackType,omitempty"`
}

Compare this sackType to the sack identifier in the DestinyInventoryItemDefinition.vendorSackType property of items. If they match, show this sack with this interaction.

type DestinyDefinitionsDestinyVendorInventoryFlyoutBucketDefinition ¶

type DestinyDefinitionsDestinyVendorInventoryFlyoutBucketDefinition struct {
	// If true, the inventory bucket should be able to be collapsed visually.
	Collapsible bool `json:"collapsible,omitempty"`
	// The inventory bucket whose contents should be shown.
	InventoryBucketHash int32 `json:"inventoryBucketHash,omitempty"`
	// The methodology to use for sorting items from the flyout.
	SortItemsBy int32 `json:"sortItemsBy,omitempty"`
}

Information about a single inventory bucket in a vendor flyout UI and how it is shown.

type DestinyDefinitionsDestinyVendorInventoryFlyoutDefinition ¶

type DestinyDefinitionsDestinyVendorInventoryFlyoutDefinition struct {
	// If the flyout is locked, this is the reason why.
	LockedDescription string `json:"lockedDescription,omitempty"`
	// The title and other common properties of the flyout.
	DisplayProperties *AllOfDestinyDefinitionsDestinyVendorInventoryFlyoutDefinitionDisplayProperties `json:"displayProperties,omitempty"`
	// A list of inventory buckets and other metadata to show on the screen.
	Buckets []DestinyDefinitionsDestinyVendorInventoryFlyoutBucketDefinition `json:"buckets,omitempty"`
	// An identifier for the flyout, in case anything else needs to refer to them.
	FlyoutId int32 `json:"flyoutId,omitempty"`
	// If this is true, don't show any of the glistening \"this is a new item\" UI elements, like we show on the inventory items themselves in in-game UI.
	SuppressNewness bool `json:"suppressNewness,omitempty"`
	// If this flyout is meant to show you the contents of the player's equipment slot, this is the slot to show.
	EquipmentSlotHash int32 `json:"equipmentSlotHash,omitempty"`
}

The definition for an \"inventory flyout\": a UI screen where we show you part of an otherwise hidden vendor inventory: like the Vault inventory buckets.

type DestinyDefinitionsDestinyVendorItemDefinition ¶

type DestinyDefinitionsDestinyVendorItemDefinition struct {
	// The index into the DestinyVendorDefinition.saleList. This is what we use to refer to items being sold throughout live and definition data.
	VendorItemIndex int32 `json:"vendorItemIndex,omitempty"`
	// The hash identifier of the item being sold (DestinyInventoryItemDefinition).  Note that a vendor can sell the same item in multiple ways, so don't assume that itemHash is a unique identifier for this entity.
	ItemHash int32 `json:"itemHash,omitempty"`
	// The amount you will recieve of the item described in itemHash if you make the purchase.
	Quantity int32 `json:"quantity,omitempty"`
	// An list of indexes into the DestinyVendorDefinition.failureStrings array, indicating the possible failure strings that can be relevant for this item.
	FailureIndexes []int32 `json:"failureIndexes,omitempty"`
	// This is a pre-compiled aggregation of item value and priceOverrideList, so that we have one place to check for what the purchaser must pay for the item. Use this instead of trying to piece together the price separately.  The somewhat crappy part about this is that, now that item quantity overrides have dynamic modifiers, this will not necessarily be statically true. If you were using this instead of live data, switch to using live data.
	Currencies []DestinyDefinitionsDestinyVendorItemQuantity `json:"currencies,omitempty"`
	// If this item can be refunded, this is the policy for what will be refundd, how, and in what time period.
	RefundPolicy int32 `json:"refundPolicy,omitempty"`
	// The amount of time before refundability of the newly purchased item will expire.
	RefundTimeLimit int32 `json:"refundTimeLimit,omitempty"`
	// The Default level at which the item will spawn. Almost always driven by an adjusto these days. Ideally should be singular. It's a long story how this ended up as a list, but there is always either going to be 0:1 of these entities.
	CreationLevels []DestinyDefinitionsDestinyItemCreationEntryLevelDefinition `json:"creationLevels,omitempty"`
	// This is an index specifically into the display category, as opposed to the server-side Categories (which do not need to match or pair with each other in any way: server side categories are really just structures for common validation. Display Category will let us more easily categorize items visually)
	DisplayCategoryIndex int32 `json:"displayCategoryIndex,omitempty"`
	// The index into the DestinyVendorDefinition.categories array, so you can find the category associated with this item.
	CategoryIndex int32 `json:"categoryIndex,omitempty"`
	// Same as above, but for the original category indexes.
	OriginalCategoryIndex int32 `json:"originalCategoryIndex,omitempty"`
	// The minimum character level at which this item is available for sale.
	MinimumLevel int32 `json:"minimumLevel,omitempty"`
	// The maximum character level at which this item is available for sale.
	MaximumLevel int32 `json:"maximumLevel,omitempty"`
	// The action to be performed when purchasing the item, if it's not just \"buy\".
	Action *AllOfDestinyDefinitionsDestinyVendorItemDefinitionAction `json:"action,omitempty"`
	// The string identifier for the category selling this item.
	DisplayCategory string `json:"displayCategory,omitempty"`
	// The inventory bucket into which this item will be placed upon purchase.
	InventoryBucketHash int32 `json:"inventoryBucketHash,omitempty"`
	// The most restrictive scope that determines whether the item is available in the Vendor's inventory. See DestinyGatingScope's documentation for more information.  This can be determined by Unlock gating, or by whether or not the item has purchase level requirements (minimumLevel and maximumLevel properties).
	VisibilityScope int32 `json:"visibilityScope,omitempty"`
	// Similar to visibilityScope, it represents the most restrictive scope that determines whether the item can be purchased. It will at least be as restrictive as visibilityScope, but could be more restrictive if the item has additional purchase requirements beyond whether it is merely visible or not.  See DestinyGatingScope's documentation for more information.
	PurchasableScope int32 `json:"purchasableScope,omitempty"`
	// If this item can only be purchased by a given platform, this indicates the platform to which it is restricted.
	Exclusivity int32 `json:"exclusivity,omitempty"`
	// If this sale can only be performed as the result of an offer check, this is true.
	IsOffer bool `json:"isOffer,omitempty"`
	// If this sale can only be performed as the result of receiving a CRM offer, this is true.
	IsCrm bool `json:"isCrm,omitempty"`
	// *if* the category this item is in supports non-default sorting, this value should represent the sorting value to use, pre-processed and ready to go.
	SortValue int32 `json:"sortValue,omitempty"`
	// If this item can expire, this is the tooltip message to show with its expiration info.
	ExpirationTooltip string `json:"expirationTooltip,omitempty"`
	// If this is populated, the purchase of this item should redirect to purchasing these other items instead.
	RedirectToSaleIndexes []int32                                             `json:"redirectToSaleIndexes,omitempty"`
	SocketOverrides       []DestinyDefinitionsDestinyVendorItemSocketOverride `json:"socketOverrides,omitempty"`
	// If true, this item is some sort of dummy sale item that cannot actually be purchased. It may be a display only item, or some fluff left by a content designer for testing purposes, or something that got disabled because it was a terrible idea. You get the picture. We won't know *why* it can't be purchased, only that it can't be. Sorry.  This is also only whether it's unpurchasable as a static property according to game content. There are other reasons why an item may or may not be purchasable at runtime, so even if this isn't set to True you should trust the runtime value for this sale item over the static definition if this is unset.
	Unpurchasable bool `json:"unpurchasable,omitempty"`
}

This represents an item being sold by the vendor.

type DestinyDefinitionsDestinyVendorItemQuantity ¶

type DestinyDefinitionsDestinyVendorItemQuantity struct {
	// The hash identifier for the item in question. Use it to look up the item's DestinyInventoryItemDefinition.
	ItemHash int32 `json:"itemHash,omitempty"`
	// If this quantity is referring to a specific instance of an item, this will have the item's instance ID. Normally, this will be null.
	ItemInstanceId int64 `json:"itemInstanceId,omitempty"`
	// The amount of the item needed/available depending on the context of where DestinyItemQuantity is being used.
	Quantity int32 `json:"quantity,omitempty"`
	// Indicates that this item quantity may be conditionally shown or hidden, based on various sources of state. For example: server flags, account state, or character progress.
	HasConditionalVisibility bool `json:"hasConditionalVisibility,omitempty"`
}

In addition to item quantity information for vendor prices, this also has any optional information that may exist about how the item's quantity can be modified. (unfortunately not information that is able to be read outside of the BNet servers, but it's there)

type DestinyDefinitionsDestinyVendorItemSocketOverride ¶

type DestinyDefinitionsDestinyVendorItemSocketOverride struct {
	// If this is populated, the socket will be overridden with a specific plug.  If this isn't populated, it's being overridden by something more complicated that is only known by the Game Server and God, which means we can't tell you in advance what it'll be.
	SingleItemHash int32 `json:"singleItemHash,omitempty"`
	// If this is greater than -1, the number of randomized plugs on this socket will be set to this quantity instead of whatever it's set to by default.
	RandomizedOptionsCount int32 `json:"randomizedOptionsCount,omitempty"`
	// This appears to be used to select which socket ultimately gets the override defined here.
	SocketTypeHash int32 `json:"socketTypeHash,omitempty"`
}

The information for how the vendor purchase should override a given socket with custom plug data.

type DestinyDefinitionsDestinyVendorRequirementDisplayEntryDefinition ¶

type DestinyDefinitionsDestinyVendorRequirementDisplayEntryDefinition struct {
	Icon   string `json:"icon,omitempty"`
	Name   string `json:"name,omitempty"`
	Source string `json:"source,omitempty"`
	Type_  string `json:"type,omitempty"`
}

The localized properties of the requirementsDisplay, allowing information about the requirement or item being featured to be seen.

type DestinyDefinitionsDestinyVendorSaleItemActionBlockDefinition ¶

type DestinyDefinitionsDestinyVendorSaleItemActionBlockDefinition struct {
	ExecuteSeconds float32 `json:"executeSeconds,omitempty"`
	IsPositive     bool    `json:"isPositive,omitempty"`
}

Not terribly useful, some basic cooldown interaction info.

type DestinyDefinitionsDestinyVendorServiceDefinition ¶

type DestinyDefinitionsDestinyVendorServiceDefinition struct {
	// The localized name of a service provided.
	Name string `json:"name,omitempty"`
}

When a vendor provides services, this is the localized name of those services.

type DestinyDefinitionsDirectorDestinyActivityGraphArtElementDefinition ¶

type DestinyDefinitionsDirectorDestinyActivityGraphArtElementDefinition struct {
	// The position on the map of the art element.
	Position *AllOfDestinyDefinitionsDirectorDestinyActivityGraphArtElementDefinitionPosition `json:"position,omitempty"`
}

These Art Elements are meant to represent one-off visual effects overlaid on the map. Currently, we do not have a pipeline to import the assets for these overlays, so this info exists as a placeholder for when such a pipeline exists (if it ever will)

type DestinyDefinitionsDirectorDestinyActivityGraphConnectionDefinition ¶

type DestinyDefinitionsDirectorDestinyActivityGraphConnectionDefinition struct {
	SourceNodeHash int32 `json:"sourceNodeHash,omitempty"`
	DestNodeHash   int32 `json:"destNodeHash,omitempty"`
}

Nodes on a graph can be visually connected: this appears to be the information about which nodes to link. It appears to lack more detailed information, such as the path for that linking.

type DestinyDefinitionsDirectorDestinyActivityGraphDefinition ¶

type DestinyDefinitionsDirectorDestinyActivityGraphDefinition struct {
	// These represent the visual \"nodes\" on the map's view. These are the activities you can click on in the map.
	Nodes []DestinyDefinitionsDirectorDestinyActivityGraphNodeDefinition `json:"nodes,omitempty"`
	// Represents one-off/special UI elements that appear on the map.
	ArtElements []DestinyDefinitionsDirectorDestinyActivityGraphArtElementDefinition `json:"artElements,omitempty"`
	// Represents connections between graph nodes. However, it lacks context that we'd need to make good use of it.
	Connections []DestinyDefinitionsDirectorDestinyActivityGraphConnectionDefinition `json:"connections,omitempty"`
	// Objectives can display on maps, and this is supposedly metadata for that. I have not had the time to analyze the details of what is useful within however: we could be missing important data to make this work. Expect this property to be expanded on later if possible.
	DisplayObjectives []DestinyDefinitionsDirectorDestinyActivityGraphDisplayObjectiveDefinition `json:"displayObjectives,omitempty"`
	// Progressions can also display on maps, but similarly to displayObjectives we appear to lack some required information and context right now. We will have to look into it later and add more data if possible.
	DisplayProgressions []DestinyDefinitionsDirectorDestinyActivityGraphDisplayProgressionDefinition `json:"displayProgressions,omitempty"`
	// Represents links between this Activity Graph and other ones.
	LinkedGraphs []DestinyDefinitionsDirectorDestinyLinkedGraphDefinition `json:"linkedGraphs,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

Represents a Map View in the director: be them overview views, destination views, or other. They have nodes which map to activities, and other various visual elements that we (or others) may or may not be able to use. Activity graphs, most importantly, have nodes which can have activities in various states of playability. Unfortunately, activity graphs are combined at runtime with Game UI-only assets such as fragments of map images, various in-game special effects, decals etc... that we don't get in these definitions. If we end up having time, we may end up trying to manually populate those here: but the last time we tried that, before the lead-up to D1, it proved to be unmaintainable as the game's content changed. So don't bet the farm on us providing that content in this definition.

type DestinyDefinitionsDirectorDestinyActivityGraphDisplayObjectiveDefinition ¶

type DestinyDefinitionsDirectorDestinyActivityGraphDisplayObjectiveDefinition struct {
	// $NOTE $amola 2017-01-19 This field is apparently something that CUI uses to manually wire up objectives to display info. I am unsure how it works.
	Id int32 `json:"id,omitempty"`
	// The objective being shown on the map.
	ObjectiveHash int32 `json:"objectiveHash,omitempty"`
}

When a Graph needs to show active Objectives, this defines those objectives as well as an identifier.

type DestinyDefinitionsDirectorDestinyActivityGraphDisplayProgressionDefinition ¶

type DestinyDefinitionsDirectorDestinyActivityGraphDisplayProgressionDefinition struct {
	Id              int32 `json:"id,omitempty"`
	ProgressionHash int32 `json:"progressionHash,omitempty"`
}

When a Graph needs to show active Progressions, this defines those objectives as well as an identifier.

type DestinyDefinitionsDirectorDestinyActivityGraphNodeActivityDefinition ¶

type DestinyDefinitionsDirectorDestinyActivityGraphNodeActivityDefinition struct {
	// An identifier for this node activity. It is only guaranteed to be unique within the Activity Graph.
	NodeActivityId int32 `json:"nodeActivityId,omitempty"`
	// The activity that will be activated if the user clicks on this node. Controls all activity-related information displayed on the node if it is active (the text shown in the tooltip etc)
	ActivityHash int32 `json:"activityHash,omitempty"`
}

The actual activity to be redirected to when you click on the node. Note that a node can have many Activities attached to it: but only one will be active at any given time. The list of Node Activities will be traversed, and the first one found to be active will be displayed. This way, a node can layer multiple variants of an activity on top of each other. For instance, one node can control the weekly Crucible Playlist. There are multiple possible playlists, but only one is active for the week.

type DestinyDefinitionsDirectorDestinyActivityGraphNodeDefinition ¶

type DestinyDefinitionsDirectorDestinyActivityGraphNodeDefinition struct {
	// An identifier for the Activity Graph Node, only guaranteed to be unique within its parent Activity Graph.
	NodeId int32 `json:"nodeId,omitempty"`
	// The node *may* have display properties that override the active Activity's display properties.
	OverrideDisplay *AllOfDestinyDefinitionsDirectorDestinyActivityGraphNodeDefinitionOverrideDisplay `json:"overrideDisplay,omitempty"`
	// The position on the map for this node.
	Position *AllOfDestinyDefinitionsDirectorDestinyActivityGraphNodeDefinitionPosition `json:"position,omitempty"`
	// The node may have various visual accents placed on it, or styles applied. These are the list of possible styles that the Node can have. The game iterates through each, looking for the first one that passes a check of the required game/character/account state in order to show that style, and then renders the node in that style.
	FeaturingStates []DestinyDefinitionsDirectorDestinyActivityGraphNodeFeaturingStateDefinition `json:"featuringStates,omitempty"`
	// The node may have various possible activities that could be active for it, however only one may be active at a time. See the DestinyActivityGraphNodeActivityDefinition for details.
	Activities []DestinyDefinitionsDirectorDestinyActivityGraphNodeActivityDefinition `json:"activities,omitempty"`
	// Represents possible states that the graph node can be in. These are combined with some checking that happens in the game client and server to determine which state is actually active at any given time.
	States []DestinyDefinitionsDirectorDestinyActivityGraphNodeStateEntry `json:"states,omitempty"`
}

This is the position and other data related to nodes in the activity graph that you can click to launch activities. An Activity Graph node will only have one active Activity at a time, which will determine the activity to be launched (and, unless overrideDisplay information is provided, will also determine the tooltip and other UI related to the node)

type DestinyDefinitionsDirectorDestinyActivityGraphNodeFeaturingStateDefinition ¶

type DestinyDefinitionsDirectorDestinyActivityGraphNodeFeaturingStateDefinition struct {
	// The node can be highlighted in a variety of ways - the game iterates through these and finds the first FeaturingState that is valid at the present moment given the Game, Account, and Character state, and renders the node in that state. See the ActivityGraphNodeHighlightType enum for possible values.
	HighlightType int32 `json:"highlightType,omitempty"`
}

Nodes can have different visual states. This object represents a single visual state (\"highlight type\") that a node can be in, and the unlock expression condition to determine whether it should be set.

type DestinyDefinitionsDirectorDestinyActivityGraphNodeStateEntry ¶

type DestinyDefinitionsDirectorDestinyActivityGraphNodeStateEntry struct {
	State int32 `json:"state,omitempty"`
}

Represents a single state that a graph node might end up in. Depending on what's going on in the game, graph nodes could be shown in different ways or even excluded from view entirely.

type DestinyDefinitionsDirectorDestinyLinkedGraphDefinition ¶

type DestinyDefinitionsDirectorDestinyLinkedGraphDefinition struct {
	Description      string                                                        `json:"description,omitempty"`
	Name             string                                                        `json:"name,omitempty"`
	UnlockExpression *DestinyDefinitionsDestinyUnlockExpressionDefinition          `json:"unlockExpression,omitempty"`
	LinkedGraphId    int32                                                         `json:"linkedGraphId,omitempty"`
	LinkedGraphs     []DestinyDefinitionsDirectorDestinyLinkedGraphEntryDefinition `json:"linkedGraphs,omitempty"`
	Overview         string                                                        `json:"overview,omitempty"`
}

This describes links between the current graph and others, as well as when that link is relevant.

type DestinyDefinitionsDirectorDestinyLinkedGraphEntryDefinition ¶

type DestinyDefinitionsDirectorDestinyLinkedGraphEntryDefinition struct {
	ActivityGraphHash int32 `json:"activityGraphHash,omitempty"`
}

type DestinyDefinitionsEnergyTypesDestinyEnergyTypeDefinition ¶

type DestinyDefinitionsEnergyTypesDestinyEnergyTypeDefinition struct {
	// The description of the energy type, icon etc...
	DisplayProperties *AllOfDestinyDefinitionsEnergyTypesDestinyEnergyTypeDefinitionDisplayProperties `json:"displayProperties,omitempty"`
	// A variant of the icon that is transparent and colorless.
	TransparentIconPath string `json:"transparentIconPath,omitempty"`
	// If TRUE, the game shows this Energy type's icon. Otherwise, it doesn't. Whether you show it or not is up to you.
	ShowIcon bool `json:"showIcon,omitempty"`
	// We have an enumeration for Energy types for quick reference. This is the current definition's Energy type enum value.
	EnumValue int32 `json:"enumValue,omitempty"`
	// If this Energy Type can be used for determining the Type of Energy that an item can consume, this is the hash for the DestinyInvestmentStatDefinition that represents the stat which holds the Capacity for that energy type. (Note that this is optional because \"Any\" is a valid cost, but not valid for Capacity - an Armor must have a specific Energy Type for determining the energy type that the Armor is restricted to use)
	CapacityStatHash int32 `json:"capacityStatHash,omitempty"`
	// If this Energy Type can be used as a cost to pay for socketing Armor 2.0 items, this is the hash for the DestinyInvestmentStatDefinition that stores the plug's raw cost.
	CostStatHash int32 `json:"costStatHash,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

Represents types of Energy that can be used for costs and payments related to Armor 2.0 mods.

type DestinyDefinitionsGuardianRanksDestinyGuardianRankConstantsDefinition ¶

type DestinyDefinitionsGuardianRanksDestinyGuardianRankConstantsDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition                  `json:"displayProperties,omitempty"`
	RankCount         int32                                                                        `json:"rankCount,omitempty"`
	RootNodeHash      int32                                                                        `json:"rootNodeHash,omitempty"`
	IconBackgrounds   *DestinyDefinitionsGuardianRanksDestinyGuardianRankIconBackgroundsDefinition `json:"iconBackgrounds,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

type DestinyDefinitionsGuardianRanksDestinyGuardianRankDefinition ¶

type DestinyDefinitionsGuardianRanksDestinyGuardianRankDefinition struct {
	DisplayProperties    *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	RankNumber           int32                                                       `json:"rankNumber,omitempty"`
	PresentationNodeHash int32                                                       `json:"presentationNodeHash,omitempty"`
	ForegroundImagePath  string                                                      `json:"foregroundImagePath,omitempty"`
	OverlayImagePath     string                                                      `json:"overlayImagePath,omitempty"`
	OverlayMaskImagePath string                                                      `json:"overlayMaskImagePath,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

type DestinyDefinitionsGuardianRanksDestinyGuardianRankIconBackgroundsDefinition ¶

type DestinyDefinitionsGuardianRanksDestinyGuardianRankIconBackgroundsDefinition struct {
	BackgroundEmptyBorderedImagePath                 string `json:"backgroundEmptyBorderedImagePath,omitempty"`
	BackgroundEmptyBlueGradientBorderedImagePath     string `json:"backgroundEmptyBlueGradientBorderedImagePath,omitempty"`
	BackgroundFilledBlueBorderedImagePath            string `json:"backgroundFilledBlueBorderedImagePath,omitempty"`
	BackgroundFilledBlueGradientBorderedImagePath    string `json:"backgroundFilledBlueGradientBorderedImagePath,omitempty"`
	BackgroundFilledBlueLowAlphaImagePath            string `json:"backgroundFilledBlueLowAlphaImagePath,omitempty"`
	BackgroundFilledBlueMediumAlphaImagePath         string `json:"backgroundFilledBlueMediumAlphaImagePath,omitempty"`
	BackgroundFilledGrayMediumAlphaBorderedImagePath string `json:"backgroundFilledGrayMediumAlphaBorderedImagePath,omitempty"`
	BackgroundFilledGrayHeavyAlphaBorderedImagePath  string `json:"backgroundFilledGrayHeavyAlphaBorderedImagePath,omitempty"`
	BackgroundFilledWhiteMediumAlphaImagePath        string `json:"backgroundFilledWhiteMediumAlphaImagePath,omitempty"`
	BackgroundFilledWhiteImagePath                   string `json:"backgroundFilledWhiteImagePath,omitempty"`
	BackgroundPlateWhiteImagePath                    string `json:"backgroundPlateWhiteImagePath,omitempty"`
	BackgroundPlateBlackImagePath                    string `json:"backgroundPlateBlackImagePath,omitempty"`
	BackgroundPlateBlackAlphaImagePath               string `json:"backgroundPlateBlackAlphaImagePath,omitempty"`
}

type DestinyDefinitionsItemsDestinyDerivedItemCategoryDefinition ¶

type DestinyDefinitionsItemsDestinyDerivedItemCategoryDefinition struct {
	// The localized string for the category title. This will be something describing the items you can get as a group, or your likelihood/the quantity you'll get.
	CategoryDescription string `json:"categoryDescription,omitempty"`
	// This is the list of all of the items for this category and the basic properties we'll know about them.
	Items []DestinyDefinitionsItemsDestinyDerivedItemDefinition `json:"items,omitempty"`
}

A shortcut for the fact that some items have a \"Preview Vendor\" - See DestinyInventoryItemDefinition.preview.previewVendorHash - that is intended to be used to show what items you can get as a result of acquiring or using this item. A common example of this in Destiny 1 was Eververse \"Boxes,\" which could have many possible items. This \"Preview Vendor\" is not a vendor you can actually see in the game, but it defines categories and sale items for all of the possible items you could get from the Box so that the game can show them to you. We summarize that info here so that you don't have to do that Vendor lookup and aggregation manually.

type DestinyDefinitionsItemsDestinyDerivedItemDefinition ¶

type DestinyDefinitionsItemsDestinyDerivedItemDefinition struct {
	// The hash for the DestinyInventoryItemDefinition of this derived item, if there is one. Sometimes we are given this information as a manual override, in which case there won't be an actual DestinyInventoryItemDefinition for what we display, but you can still show the strings from this object itself.
	ItemHash int32 `json:"itemHash,omitempty"`
	// The name of the derived item.
	ItemName string `json:"itemName,omitempty"`
	// Additional details about the derived item, in addition to the description.
	ItemDetail string `json:"itemDetail,omitempty"`
	// A brief description of the item.
	ItemDescription string `json:"itemDescription,omitempty"`
	// An icon for the item.
	IconPath string `json:"iconPath,omitempty"`
	// If the item was derived from a \"Preview Vendor\", this will be an index into the DestinyVendorDefinition's itemList property. Otherwise, -1.
	VendorItemIndex int32 `json:"vendorItemIndex,omitempty"`
}

This is a reference to, and summary data for, a specific item that you can get as a result of Using or Acquiring some other Item (For example, this could be summary information for an Emote that you can get by opening an an Eververse Box) See DestinyDerivedItemCategoryDefinition for more information.

type DestinyDefinitionsItemsDestinyEnergyCapacityEntry ¶

type DestinyDefinitionsItemsDestinyEnergyCapacityEntry struct {
	// How much energy capacity this plug provides.
	CapacityValue int32 `json:"capacityValue,omitempty"`
	// Energy provided by a plug is always of a specific type - this is the hash identifier for the energy type for which it provides Capacity.
	EnergyTypeHash int32 `json:"energyTypeHash,omitempty"`
	// The Energy Type for this energy capacity, in enum form for easy use.
	EnergyType int32 `json:"energyType,omitempty"`
}

Items can have Energy Capacity, and plugs can provide that capacity such as on a piece of Armor in Armor 2.0. This is how much \"Energy\" can be spent on activating plugs for this item.

type DestinyDefinitionsItemsDestinyEnergyCostEntry ¶

type DestinyDefinitionsItemsDestinyEnergyCostEntry struct {
	// The Energy cost for inserting this plug.
	EnergyCost int32 `json:"energyCost,omitempty"`
	// The type of energy that this plug costs, as a reference to the DestinyEnergyTypeDefinition of the energy type.
	EnergyTypeHash int32 `json:"energyTypeHash,omitempty"`
	// The type of energy that this plug costs, in enum form.
	EnergyType int32 `json:"energyType,omitempty"`
}

Some plugs cost Energy, which is a stat on the item that can be increased by other plugs (that, at least in Armor 2.0, have a \"masterworks-like\" mechanic for upgrading). If a plug has costs, the details of that cost are defined here.

type DestinyDefinitionsItemsDestinyItemPlugDefinition ¶

type DestinyDefinitionsItemsDestinyItemPlugDefinition struct {
	// The rules around when this plug can be inserted into a socket, aside from the socket's individual restrictions.  The live data DestinyItemPlugComponent.insertFailIndexes will be an index into this array, so you can pull out the failure strings appropriate for the user.
	InsertionRules []DestinyDefinitionsItemsDestinyPlugRuleDefinition `json:"insertionRules,omitempty"`
	// The string identifier for the plug's category. Use the socket's DestinySocketTypeDefinition.plugWhitelist to determine whether this plug can be inserted into the socket.
	PlugCategoryIdentifier string `json:"plugCategoryIdentifier,omitempty"`
	// The hash for the plugCategoryIdentifier. You can use this instead if you wish: I put both in the definition for debugging purposes.
	PlugCategoryHash int32 `json:"plugCategoryHash,omitempty"`
	// If you successfully socket the item, this will determine whether or not you get \"refunded\" on the plug.
	OnActionRecreateSelf bool `json:"onActionRecreateSelf,omitempty"`
	// If inserting this plug requires materials, this is the hash identifier for looking up the DestinyMaterialRequirementSetDefinition for those requirements.
	InsertionMaterialRequirementHash int32 `json:"insertionMaterialRequirementHash,omitempty"`
	// In the game, if you're inspecting a plug item directly, this will be the item shown with the plug attached. Look up the DestinyInventoryItemDefinition for this hash for the item.
	PreviewItemOverrideHash int32 `json:"previewItemOverrideHash,omitempty"`
	// It's not enough for the plug to be inserted. It has to be enabled as well. For it to be enabled, it may require materials. This is the hash identifier for the DestinyMaterialRequirementSetDefinition for those requirements, if there is one.
	EnabledMaterialRequirementHash int32 `json:"enabledMaterialRequirementHash,omitempty"`
	// The rules around whether the plug, once inserted, is enabled and providing its benefits.  The live data DestinyItemPlugComponent.enableFailIndexes will be an index into this array, so you can pull out the failure strings appropriate for the user.
	EnabledRules []DestinyDefinitionsItemsDestinyPlugRuleDefinition `json:"enabledRules,omitempty"`
	// Plugs can have arbitrary, UI-defined identifiers that the UI designers use to determine the style applied to plugs. Unfortunately, we have neither a definitive list of these labels nor advance warning of when new labels might be applied or how that relates to how they get rendered. If you want to, you can refer to known labels to change your own styles: but know that new ones can be created arbitrarily, and we have no way of associating the labels with any specific UI style guidance... you'll have to piece that together on your end. Or do what we do, and just show plugs more generically, without specialized styles.
	UiPlugLabel string `json:"uiPlugLabel,omitempty"`
	PlugStyle   int32  `json:"plugStyle,omitempty"`
	// Indicates the rules about when this plug can be used. See the PlugAvailabilityMode enumeration for more information!
	PlugAvailability int32 `json:"plugAvailability,omitempty"`
	// If the plug meets certain state requirements, it may have an alternative label applied to it. This is the alternative label that will be applied in such a situation.
	AlternateUiPlugLabel string `json:"alternateUiPlugLabel,omitempty"`
	// The alternate plug of the plug: only applies when the item is in states that only the server can know about and control, unfortunately. See AlternateUiPlugLabel for the related label info.
	AlternatePlugStyle int32 `json:"alternatePlugStyle,omitempty"`
	// If TRUE, this plug is used for UI display purposes only, and doesn't have any interesting effects of its own.
	IsDummyPlug bool `json:"isDummyPlug,omitempty"`
	// Do you ever get the feeling that a system has become so overburdened by edge cases that it probably should have become some other system entirely? So do I!  In totally unrelated news, Plugs can now override properties of their parent items. This is some of the relevant definition data for those overrides.  If this is populated, it will have the override data to be applied when this plug is applied to an item.
	ParentItemOverride *AllOfDestinyDefinitionsItemsDestinyItemPlugDefinitionParentItemOverride `json:"parentItemOverride,omitempty"`
	// IF not null, this plug provides Energy capacity to the item in which it is socketed. In Armor 2.0 for example, is implemented in a similar way to Masterworks, where visually it's a single area of the UI being clicked on to \"Upgrade\" to higher energy levels, but it's actually socketing new plugs.
	EnergyCapacity *AllOfDestinyDefinitionsItemsDestinyItemPlugDefinitionEnergyCapacity `json:"energyCapacity,omitempty"`
	// IF not null, this plug has an energy cost. This contains the details of that cost.
	EnergyCost *AllOfDestinyDefinitionsItemsDestinyItemPlugDefinitionEnergyCost `json:"energyCost,omitempty"`
}

If an item is a Plug, its DestinyInventoryItemDefinition.plug property will be populated with an instance of one of these bad boys. This gives information about when it can be inserted, what the plug's category is (and thus whether it is compatible with a socket... see DestinySocketTypeDefinition for information about Plug Categories and socket compatibility), whether it is enabled and other Plug info.

type DestinyDefinitionsItemsDestinyItemTierTypeDefinition ¶

type DestinyDefinitionsItemsDestinyItemTierTypeDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// If this tier defines infusion properties, they will be contained here.
	InfusionProcess *AllOfDestinyDefinitionsItemsDestinyItemTierTypeDefinitionInfusionProcess `json:"infusionProcess,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

Defines the tier type of an item. Mostly this provides human readable properties for types like Common, Rare, etc... It also provides some base data for infusion that could be useful.

type DestinyDefinitionsItemsDestinyItemTierTypeInfusionBlock ¶

type DestinyDefinitionsItemsDestinyItemTierTypeInfusionBlock struct {
	// The default portion of quality that will transfer from the infuser to the infusee item. (InfuserQuality - InfuseeQuality) * baseQualityTransferRatio = base quality transferred.
	BaseQualityTransferRatio float32 `json:"baseQualityTransferRatio,omitempty"`
	// As long as InfuserQuality > InfuseeQuality, the amount of quality bestowed is guaranteed to be at least this value, even if the transferRatio would dictate that it should be less. The total amount of quality that ends up in the Infusee cannot exceed the Infuser's quality however (for instance, if you infuse a 300 item with a 301 item and the minimum quality increment is 10, the infused item will not end up with 310 quality)
	MinimumQualityIncrement int32 `json:"minimumQualityIncrement,omitempty"`
}

type DestinyDefinitionsItemsDestinyParentItemOverride ¶

type DestinyDefinitionsItemsDestinyParentItemOverride struct {
	AdditionalEquipRequirementsDisplayStrings []string `json:"additionalEquipRequirementsDisplayStrings,omitempty"`
	PipIcon                                   string   `json:"pipIcon,omitempty"`
}

type DestinyDefinitionsItemsDestinyPlugRuleDefinition ¶

type DestinyDefinitionsItemsDestinyPlugRuleDefinition struct {
	// The localized string to show if this rule fails.
	FailureMessage string `json:"failureMessage,omitempty"`
}

Dictates a rule around whether the plug is enabled or insertable. In practice, the live Destiny data will refer to these entries by index. You can then look up that index in the appropriate property (enabledRules or insertionRules) to get the localized string for the failure message if it failed.

type DestinyDefinitionsLoadoutsDestinyLoadoutColorDefinition ¶

type DestinyDefinitionsLoadoutsDestinyLoadoutColorDefinition struct {
	ColorImagePath string `json:"colorImagePath,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

type DestinyDefinitionsLoadoutsDestinyLoadoutConstantsDefinition ¶

type DestinyDefinitionsLoadoutsDestinyLoadoutConstantsDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// This is the same icon as the one in the display properties, offered here as well with a more descriptive name.
	WhiteIconImagePath string `json:"whiteIconImagePath,omitempty"`
	// This is a color-inverted version of the whiteIconImagePath.
	BlackIconImagePath string `json:"blackIconImagePath,omitempty"`
	// The maximum number of loadouts available to each character. The loadouts component API response can return fewer loadouts than this, as more loadouts are unlocked by reaching higher Guardian Ranks.
	LoadoutCountPerCharacter int32 `json:"loadoutCountPerCharacter,omitempty"`
	// A list of the socket category hashes to be filtered out of loadout item preview displays.
	LoadoutPreviewFilterOutSocketCategoryHashes []int32 `json:"loadoutPreviewFilterOutSocketCategoryHashes,omitempty"`
	// A list of the socket type hashes to be filtered out of loadout item preview displays.
	LoadoutPreviewFilterOutSocketTypeHashes []int32 `json:"loadoutPreviewFilterOutSocketTypeHashes,omitempty"`
	// A list of the loadout name hashes in index order, for convenience.
	LoadoutNameHashes []int32 `json:"loadoutNameHashes,omitempty"`
	// A list of the loadout icon hashes in index order, for convenience.
	LoadoutIconHashes []int32 `json:"loadoutIconHashes,omitempty"`
	// A list of the loadout color hashes in index order, for convenience.
	LoadoutColorHashes []int32 `json:"loadoutColorHashes,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

type DestinyDefinitionsLoadoutsDestinyLoadoutIconDefinition ¶

type DestinyDefinitionsLoadoutsDestinyLoadoutIconDefinition struct {
	IconImagePath string `json:"iconImagePath,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

type DestinyDefinitionsLoadoutsDestinyLoadoutNameDefinition ¶

type DestinyDefinitionsLoadoutsDestinyLoadoutNameDefinition struct {
	Name string `json:"name,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

type DestinyDefinitionsLoreDestinyLoreDefinition ¶

type DestinyDefinitionsLoreDestinyLoreDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	Subtitle          string                                                      `json:"subtitle,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

These are definitions for in-game \"Lore,\" meant to be narrative enhancements of the game experience. DestinyInventoryItemDefinitions for interesting items point to these definitions, but nothing's stopping you from scraping all of these and doing something cool with them. If they end up having cool data.

type DestinyDefinitionsMetricsDestinyMetricDefinition ¶

type DestinyDefinitionsMetricsDestinyMetricDefinition struct {
	DisplayProperties     *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	TrackingObjectiveHash int32                                                       `json:"trackingObjectiveHash,omitempty"`
	LowerValueIsBetter    bool                                                        `json:"lowerValueIsBetter,omitempty"`
	PresentationNodeType  int32                                                       `json:"presentationNodeType,omitempty"`
	TraitIds              []string                                                    `json:"traitIds,omitempty"`
	TraitHashes           []int32                                                     `json:"traitHashes,omitempty"`
	// A quick reference to presentation nodes that have this node as a child. Presentation nodes can be parented under multiple parents.
	ParentNodeHashes []int32 `json:"parentNodeHashes,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

type DestinyDefinitionsMilestonesDestinyMilestoneActivityDefinition ¶

type DestinyDefinitionsMilestonesDestinyMilestoneActivityDefinition struct {
	// The \"Conceptual\" activity hash. Basically, we picked the lowest level activity and are treating it as the canonical definition of the activity for rendering purposes.  If you care about the specific difficulty modes and variations, use the activities under \"Variants\".
	ConceptualActivityHash int32 `json:"conceptualActivityHash,omitempty"`
	// A milestone-referenced activity can have many variants, such as Tiers or alternative modes of play.  Even if there is only a single variant, the details for these are represented within as a variant definition.  It is assumed that, if this DestinyMilestoneActivityDefinition is active, then all variants should be active.  If a Milestone could ever split the variants' active status conditionally, they should all have their own DestinyMilestoneActivityDefinition instead! The potential duplication will be worth it for the obviousness of processing and use.
	Variants map[string]DestinyDefinitionsMilestonesDestinyMilestoneActivityVariantDefinition `json:"variants,omitempty"`
}

Milestones can have associated activities which provide additional information about the context, challenges, modifiers, state etc... related to this Milestone. Information we need to be able to return that data is defined here, along with Tier data to establish a relationship between a conceptual Activity and its difficulty levels and variants.

type DestinyDefinitionsMilestonesDestinyMilestoneActivityVariantDefinition ¶

type DestinyDefinitionsMilestonesDestinyMilestoneActivityVariantDefinition struct {
	// The hash to use for looking up the variant Activity's definition (DestinyActivityDefinition), where you can find its distinguishing characteristics such as difficulty level and recommended light level.   Frequently, that will be the only distinguishing characteristics in practice, which is somewhat of a bummer.
	ActivityHash int32 `json:"activityHash,omitempty"`
	// If you care to do so, render the variants in the order prescribed by this value.  When you combine live Milestone data with the definition, the order becomes more useful because you'll be cross-referencing between the definition and live data.
	Order int32 `json:"order,omitempty"`
}

Represents a variant on an activity for a Milestone: a specific difficulty tier, or a specific activity variant for example. These will often have more specific details, such as an associated Guided Game, progression steps, tier-specific rewards, and custom values.

type DestinyDefinitionsMilestonesDestinyMilestoneChallengeActivityDefinition ¶

type DestinyDefinitionsMilestonesDestinyMilestoneChallengeActivityDefinition struct {
	// The activity for which this challenge is active.
	ActivityHash int32                                                             `json:"activityHash,omitempty"`
	Challenges   []DestinyDefinitionsMilestonesDestinyMilestoneChallengeDefinition `json:"challenges,omitempty"`
	// If the activity and its challenge is visible on any of these nodes, it will be returned.
	ActivityGraphNodes []DestinyDefinitionsMilestonesDestinyMilestoneChallengeActivityGraphNodeEntry `json:"activityGraphNodes,omitempty"`
	// Phases related to this activity, if there are any.  These will be listed in the order in which they will appear in the actual activity.
	Phases []DestinyDefinitionsMilestonesDestinyMilestoneChallengeActivityPhase `json:"phases,omitempty"`
}

type DestinyDefinitionsMilestonesDestinyMilestoneChallengeActivityGraphNodeEntry ¶

type DestinyDefinitionsMilestonesDestinyMilestoneChallengeActivityGraphNodeEntry struct {
	ActivityGraphHash     int32 `json:"activityGraphHash,omitempty"`
	ActivityGraphNodeHash int32 `json:"activityGraphNodeHash,omitempty"`
}

type DestinyDefinitionsMilestonesDestinyMilestoneChallengeActivityPhase ¶

type DestinyDefinitionsMilestonesDestinyMilestoneChallengeActivityPhase struct {
	// The hash identifier of the activity's phase.
	PhaseHash int32 `json:"phaseHash,omitempty"`
}

type DestinyDefinitionsMilestonesDestinyMilestoneChallengeDefinition ¶

type DestinyDefinitionsMilestonesDestinyMilestoneChallengeDefinition struct {
	// The challenge related to this milestone.
	ChallengeObjectiveHash int32 `json:"challengeObjectiveHash,omitempty"`
}

type DestinyDefinitionsMilestonesDestinyMilestoneDefinition ¶

type DestinyDefinitionsMilestonesDestinyMilestoneDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// A hint to the UI to indicate what to show as the display properties for this Milestone when showing \"Live\" milestone data. Feel free to show more than this if desired: this hint is meant to simplify our own UI, but it may prove useful to you as well.
	DisplayPreference int32 `json:"displayPreference,omitempty"`
	// A custom image someone made just for the milestone. Isn't that special?
	Image string `json:"image,omitempty"`
	// An enumeration listing one of the possible types of milestones. Check out the DestinyMilestoneType enum for more info!
	MilestoneType int32 `json:"milestoneType,omitempty"`
	// If True, then the Milestone has been integrated with BNet's recruiting feature.
	Recruitable bool `json:"recruitable,omitempty"`
	// If the milestone has a friendly identifier for association with other features - such as Recruiting - that identifier can be found here. This is \"friendly\" in that it looks better in a URL than whatever the identifier for the Milestone actually is.
	FriendlyName string `json:"friendlyName,omitempty"`
	// If TRUE, this entry should be returned in the list of milestones for the \"Explore Destiny\" (i.e. new BNet homepage) features of Bungie.net (as long as the underlying event is active) Note that this is a property specifically used by BNet and the companion app for the \"Live Events\" feature of the front page/welcome view: it's not a reflection of what you see in-game.
	ShowInExplorer bool `json:"showInExplorer,omitempty"`
	// Determines whether we'll show this Milestone in the user's personal Milestones list.
	ShowInMilestones bool `json:"showInMilestones,omitempty"`
	// If TRUE, \"Explore Destiny\" (the front page of BNet and the companion app) prioritize using the activity image over any overriding Quest or Milestone image provided. This unfortunate hack is brought to you by Trials of The Nine.
	ExplorePrioritizesActivityImage bool `json:"explorePrioritizesActivityImage,omitempty"`
	// A shortcut for clients - and the server - to understand whether we can predict the start and end dates for this event. In practice, there are multiple ways that an event could have predictable date ranges, but not all events will be able to be predicted via any mechanism (for instance, events that are manually triggered on and off)
	HasPredictableDates bool `json:"hasPredictableDates,omitempty"`
	// The full set of possible Quests that give the overview of the Milestone event/activity in question. Only one of these can be active at a time for a given Conceptual Milestone, but many of them may be \"available\" for the user to choose from. (for instance, with Milestones you can choose from the three available Quests, but only one can be active at a time) Keyed by the quest item.  As of Forsaken (~September 2018), Quest-style Milestones are being removed for many types of activities. There will likely be further revisions to the Milestone concept in the future.
	Quests map[string]DestinyDefinitionsMilestonesDestinyMilestoneQuestDefinition `json:"quests,omitempty"`
	// If this milestone can provide rewards, this will define the categories into which the individual reward entries are placed.  This is keyed by the Category's hash, which is only guaranteed to be unique within a given Milestone.
	Rewards map[string]DestinyDefinitionsMilestonesDestinyMilestoneRewardCategoryDefinition `json:"rewards,omitempty"`
	// If you're going to show Vendors for the Milestone, you can use this as a localized \"header\" for the section where you show that vendor data. It'll provide a more context-relevant clue about what the vendor's role is in the Milestone.
	VendorsDisplayTitle string `json:"vendorsDisplayTitle,omitempty"`
	// Sometimes, milestones will have rewards provided by Vendors. This definition gives the information needed to understand which vendors are relevant, the order in which they should be returned if order matters, and the conditions under which the Vendor is relevant to the user.
	Vendors []DestinyDefinitionsMilestonesDestinyMilestoneVendorDefinition `json:"vendors,omitempty"`
	// Sometimes, milestones will have arbitrary values associated with them that are of interest to us or to third party developers. This is the collection of those values' definitions, keyed by the identifier of the value and providing useful definition information such as localizable names and descriptions for the value.
	Values map[string]DestinyDefinitionsMilestonesDestinyMilestoneValueDefinition `json:"values,omitempty"`
	// Some milestones are explicit objectives that you can see and interact with in the game. Some milestones are more conceptual, built by BNet to help advise you on activities and events that happen in-game but that aren't explicitly shown in game as Milestones. If this is TRUE, you can see this as a milestone in the game. If this is FALSE, it's an event or activity you can participate in, but you won't see it as a Milestone in the game's UI.
	IsInGameMilestone bool `json:"isInGameMilestone,omitempty"`
	// A Milestone can now be represented by one or more activities directly (without a backing Quest), and that activity can have many challenges, modifiers, and related to it.
	Activities   []DestinyDefinitionsMilestonesDestinyMilestoneChallengeActivityDefinition `json:"activities,omitempty"`
	DefaultOrder int32                                                                     `json:"defaultOrder,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

Milestones are an in-game concept where they're attempting to tell you what you can do next in-game. If that sounds a lot like Advisors in Destiny 1, it is! So we threw out Advisors in the Destiny 2 API and tacked all of the data we would have put on Advisors onto Milestones instead. Each Milestone represents something going on in the game right now: - A \"ritual activity\" you can perform, like nightfall - A \"special event\" that may have activities related to it, like Taco Tuesday (there's no Taco Tuesday in Destiny 2) - A checklist you can fulfill, like helping your Clan complete all of its weekly objectives - A tutorial quest you can play through, like the introduction to the Crucible. Most of these milestones appear in game as well. Some of them are BNet only, because we're so extra. You're welcome. There are some important caveats to understand about how we currently render Milestones and their deficiencies. The game currently doesn't have any content that actually tells you oughtright *what* the Milestone is: that is to say, what you'll be doing. The best we get is either a description of the overall Milestone, or of the Quest that the Milestone is having you partake in: which is usually something that assumes you already know what it's talking about, like \"Complete 5 Challenges\". 5 Challenges for what? What's a challenge? These are not questions that the Milestone data will answer for you unfortunately. This isn't great, and in the future I'd like to add some custom text to give you more contextual information to pass on to your users. But for now, you can do what we do to render what little display info we do have: Start by looking at the currently active quest (ideally, you've fetched DestinyMilestone or DestinyPublicMilestone data from the API, so you know the currently active quest for the Milestone in question). Look up the Quests property in the Milestone Definition, and check if it has display properties. If it does, show that as the description of the Milestone. If it doesn't, fall back on the Milestone's description. This approach will let you avoid, whenever possible, the even less useful (and sometimes nonexistant) milestone-level names and descriptions.

type DestinyDefinitionsMilestonesDestinyMilestoneDisplayPreference ¶

type DestinyDefinitionsMilestonesDestinyMilestoneDisplayPreference int32

DestinyDefinitionsMilestonesDestinyMilestoneDisplayPreference : A hint for the UI as to what display information ought to be shown. Defaults to showing the static MilestoneDefinition's display properties. If for some reason the indicated property is not populated, fall back to the MilestoneDefinition.displayProperties.

type DestinyDefinitionsMilestonesDestinyMilestoneQuestDefinition ¶

type DestinyDefinitionsMilestonesDestinyMilestoneQuestDefinition struct {
	// The item representing this Milestone quest. Use this hash to look up the DestinyInventoryItemDefinition for the quest to find its steps and human readable data.
	QuestItemHash int32 `json:"questItemHash,omitempty"`
	// The individual quests may have different definitions from the overall milestone: if there's a specific active quest, use these displayProperties instead of that of the overall DestinyMilestoneDefinition.
	DisplayProperties *AllOfDestinyDefinitionsMilestonesDestinyMilestoneQuestDefinitionDisplayProperties `json:"displayProperties,omitempty"`
	// If populated, this image can be shown instead of the generic milestone's image when this quest is live, or it can be used to show a background image for the quest itself that differs from that of the Activity or the Milestone.
	OverrideImage string `json:"overrideImage,omitempty"`
	// The rewards you will get for completing this quest, as best as we could extract them from our data. Sometimes, it'll be a decent amount of data. Sometimes, it's going to be sucky. Sorry.
	QuestRewards *AllOfDestinyDefinitionsMilestonesDestinyMilestoneQuestDefinitionQuestRewards `json:"questRewards,omitempty"`
	// The full set of all possible \"conceptual activities\" that are related to this Milestone. Tiers or alternative modes of play within these conceptual activities will be defined as sub-entities. Keyed by the Conceptual Activity Hash. Use the key to look up DestinyActivityDefinition.
	Activities map[string]DestinyDefinitionsMilestonesDestinyMilestoneActivityDefinition `json:"activities,omitempty"`
	// Sometimes, a Milestone's quest is related to an entire Destination rather than a specific activity. In that situation, this will be the hash of that Destination. Hotspots are currently the only Milestones that expose this data, but that does not preclude this data from being returned for other Milestones in the future.
	DestinationHash int32 `json:"destinationHash,omitempty"`
}

Any data we need to figure out whether this Quest Item is the currently active one for the conceptual Milestone. Even just typing this description, I already regret it.

type DestinyDefinitionsMilestonesDestinyMilestoneQuestRewardItem ¶

type DestinyDefinitionsMilestonesDestinyMilestoneQuestRewardItem struct {
	// The quest reward item *may* be associated with a vendor. If so, this is that vendor. Use this hash to look up the DestinyVendorDefinition.
	VendorHash int32 `json:"vendorHash,omitempty"`
	// The quest reward item *may* be associated with a vendor. If so, this is the index of the item being sold, which we can use at runtime to find instanced item information for the reward item.
	VendorItemIndex int32 `json:"vendorItemIndex,omitempty"`
	// The hash identifier for the item in question. Use it to look up the item's DestinyInventoryItemDefinition.
	ItemHash int32 `json:"itemHash,omitempty"`
	// If this quantity is referring to a specific instance of an item, this will have the item's instance ID. Normally, this will be null.
	ItemInstanceId int64 `json:"itemInstanceId,omitempty"`
	// The amount of the item needed/available depending on the context of where DestinyItemQuantity is being used.
	Quantity int32 `json:"quantity,omitempty"`
	// Indicates that this item quantity may be conditionally shown or hidden, based on various sources of state. For example: server flags, account state, or character progress.
	HasConditionalVisibility bool `json:"hasConditionalVisibility,omitempty"`
}

A subclass of DestinyItemQuantity, that provides not just the item and its quantity but also information that BNet can - at some point - use internally to provide more robust runtime information about the item's qualities. If you want it, please ask! We're just out of time to wire it up right now. Or a clever person just may do it with our existing endpoints.

type DestinyDefinitionsMilestonesDestinyMilestoneQuestRewardsDefinition ¶

type DestinyDefinitionsMilestonesDestinyMilestoneQuestRewardsDefinition struct {
	// The items that represent your reward for completing the quest.  Be warned, these could be \"dummy\" items: items that are only used to render a good-looking in-game tooltip, but aren't the actual items themselves.  For instance, when experience is given there's often a dummy item representing \"experience\", with quantity being the amount of experience you got. We don't have a programmatic association between those and whatever Progression is actually getting that experience... yet.
	Items []DestinyDefinitionsMilestonesDestinyMilestoneQuestRewardItem `json:"items,omitempty"`
}

If rewards are given in a quest - as opposed to overall in the entire Milestone - there's way less to track. We're going to simplify this contract as a result. However, this also gives us the opportunity to potentially put more than just item information into the reward data if we're able to mine it out in the future. Remember this if you come back and ask \"why are quest reward items nested inside of their own class?\"

type DestinyDefinitionsMilestonesDestinyMilestoneRewardCategoryDefinition ¶

type DestinyDefinitionsMilestonesDestinyMilestoneRewardCategoryDefinition struct {
	// Identifies the reward category. Only guaranteed unique within this specific component!
	CategoryHash int32 `json:"categoryHash,omitempty"`
	// The string identifier for the category, if you want to use it for some end. Guaranteed unique within the specific component.
	CategoryIdentifier string `json:"categoryIdentifier,omitempty"`
	// Hopefully this is obvious by now.
	DisplayProperties *AllOfDestinyDefinitionsMilestonesDestinyMilestoneRewardCategoryDefinitionDisplayProperties `json:"displayProperties,omitempty"`
	// If this milestone can provide rewards, this will define the sets of rewards that can be earned, the conditions under which they can be acquired, internal data that we'll use at runtime to determine whether you've already earned or redeemed this set of rewards, and the category that this reward should be placed under.
	RewardEntries map[string]DestinyDefinitionsMilestonesDestinyMilestoneRewardEntryDefinition `json:"rewardEntries,omitempty"`
	// If you want to use BNet's recommended order for rendering categories programmatically, use this value and compare it to other categories to determine the order in which they should be rendered. I don't feel great about putting this here, I won't lie.
	Order int32 `json:"order,omitempty"`
}

The definition of a category of rewards, that contains many individual rewards.

type DestinyDefinitionsMilestonesDestinyMilestoneRewardEntryDefinition ¶

type DestinyDefinitionsMilestonesDestinyMilestoneRewardEntryDefinition struct {
	// The identifier for this reward entry. Runtime data will refer to reward entries by this hash. Only guaranteed unique within the specific Milestone.
	RewardEntryHash int32 `json:"rewardEntryHash,omitempty"`
	// The string identifier, if you care about it. Only guaranteed unique within the specific Milestone.
	RewardEntryIdentifier string `json:"rewardEntryIdentifier,omitempty"`
	// The items you will get as rewards, and how much of it you'll get.
	Items []DestinyDestinyItemQuantity `json:"items,omitempty"`
	// If this reward is redeemed at a Vendor, this is the hash of the Vendor to go to in order to redeem the reward. Use this hash to look up the DestinyVendorDefinition.
	VendorHash int32 `json:"vendorHash,omitempty"`
	// For us to bother returning this info, we should be able to return some kind of information about why these rewards are grouped together. This is ideally that information. Look at how confident I am that this will always remain true.
	DisplayProperties *AllOfDestinyDefinitionsMilestonesDestinyMilestoneRewardEntryDefinitionDisplayProperties `json:"displayProperties,omitempty"`
	// If you want to follow BNet's ordering of these rewards, use this number within a given category to order the rewards. Yeah, I know. I feel dirty too.
	Order int32 `json:"order,omitempty"`
}

The definition of a specific reward, which may be contained in a category of rewards and that has optional information about how it is obtained.

type DestinyDefinitionsMilestonesDestinyMilestoneType ¶

type DestinyDefinitionsMilestonesDestinyMilestoneType int32

DestinyDefinitionsMilestonesDestinyMilestoneType : The type of milestone. Milestones can be Tutorials, one-time/triggered/non-repeating but not necessarily tutorials, or Repeating Milestones.

type DestinyDefinitionsMilestonesDestinyMilestoneValueDefinition ¶

type DestinyDefinitionsMilestonesDestinyMilestoneValueDefinition struct {
	Key               string                                                      `json:"key,omitempty"`
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
}

The definition for information related to a key/value pair that is relevant for a particular Milestone or component within the Milestone. This lets us more flexibly pass up information that's useful to someone, even if it's not necessarily us.

type DestinyDefinitionsMilestonesDestinyMilestoneVendorDefinition ¶

type DestinyDefinitionsMilestonesDestinyMilestoneVendorDefinition struct {
	// The hash of the vendor whose wares should be shown as associated with the Milestone.
	VendorHash int32 `json:"vendorHash,omitempty"`
}

If the Milestone or a component has vendors whose inventories could/should be displayed that are relevant to it, this will return the vendor in question. It also contains information we need to determine whether that vendor is actually relevant at the moment, given the user's current state.

type DestinyDefinitionsPowerCapsDestinyPowerCapDefinition ¶

type DestinyDefinitionsPowerCapsDestinyPowerCapDefinition struct {
	// The raw value for a power cap.
	PowerCap int32 `json:"powerCap,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

Defines a 'power cap' (limit) for gear items, based on the rarity tier and season of release.

type DestinyDefinitionsPresentationDestinyPresentationChildBlock ¶

type DestinyDefinitionsPresentationDestinyPresentationChildBlock struct {
	PresentationNodeType         int32   `json:"presentationNodeType,omitempty"`
	ParentPresentationNodeHashes []int32 `json:"parentPresentationNodeHashes,omitempty"`
	DisplayStyle                 int32   `json:"displayStyle,omitempty"`
}

type DestinyDefinitionsPresentationDestinyPresentationNodeBaseDefinition ¶

type DestinyDefinitionsPresentationDestinyPresentationNodeBaseDefinition struct {
	PresentationNodeType int32    `json:"presentationNodeType,omitempty"`
	TraitIds             []string `json:"traitIds,omitempty"`
	TraitHashes          []int32  `json:"traitHashes,omitempty"`
	// A quick reference to presentation nodes that have this node as a child. Presentation nodes can be parented under multiple parents.
	ParentNodeHashes []int32 `json:"parentNodeHashes,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

This is the base class for all presentation system children. Presentation Nodes, Records, Collectibles, and Metrics.

type DestinyDefinitionsPresentationDestinyPresentationNodeChildEntry ¶

type DestinyDefinitionsPresentationDestinyPresentationNodeChildEntry struct {
	PresentationNodeHash int32 `json:"presentationNodeHash,omitempty"`
	// Use this value to sort the presentation node children in ascending order.
	NodeDisplayPriority int32 `json:"nodeDisplayPriority,omitempty"`
}

type DestinyDefinitionsPresentationDestinyPresentationNodeChildEntryBase ¶

type DestinyDefinitionsPresentationDestinyPresentationNodeChildEntryBase struct {
	// Use this value to sort the presentation node children in ascending order.
	NodeDisplayPriority int32 `json:"nodeDisplayPriority,omitempty"`
}

type DestinyDefinitionsPresentationDestinyPresentationNodeChildrenBlock ¶

type DestinyDefinitionsPresentationDestinyPresentationNodeChildrenBlock struct {
	PresentationNodes []DestinyDefinitionsPresentationDestinyPresentationNodeChildEntry            `json:"presentationNodes,omitempty"`
	Collectibles      []DestinyDefinitionsPresentationDestinyPresentationNodeCollectibleChildEntry `json:"collectibles,omitempty"`
	Records           []DestinyDefinitionsPresentationDestinyPresentationNodeRecordChildEntry      `json:"records,omitempty"`
	Metrics           []DestinyDefinitionsPresentationDestinyPresentationNodeMetricChildEntry      `json:"metrics,omitempty"`
	Craftables        []DestinyDefinitionsPresentationDestinyPresentationNodeCraftableChildEntry   `json:"craftables,omitempty"`
}

As/if presentation nodes begin to host more entities as children, these lists will be added to. One list property exists per type of entity that can be treated as a child of this presentation node, and each holds the identifier of the entity and any associated information needed to display the UI for that entity (if anything)

type DestinyDefinitionsPresentationDestinyPresentationNodeCollectibleChildEntry ¶

type DestinyDefinitionsPresentationDestinyPresentationNodeCollectibleChildEntry struct {
	CollectibleHash int32 `json:"collectibleHash,omitempty"`
	// Use this value to sort the presentation node children in ascending order.
	NodeDisplayPriority int32 `json:"nodeDisplayPriority,omitempty"`
}

type DestinyDefinitionsPresentationDestinyPresentationNodeCraftableChildEntry ¶

type DestinyDefinitionsPresentationDestinyPresentationNodeCraftableChildEntry struct {
	CraftableItemHash int32 `json:"craftableItemHash,omitempty"`
	// Use this value to sort the presentation node children in ascending order.
	NodeDisplayPriority int32 `json:"nodeDisplayPriority,omitempty"`
}

type DestinyDefinitionsPresentationDestinyPresentationNodeDefinition ¶

type DestinyDefinitionsPresentationDestinyPresentationNodeDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// The original icon for this presentation node, before we futzed with it.
	OriginalIcon string `json:"originalIcon,omitempty"`
	// Some presentation nodes are meant to be explicitly shown on the \"root\" or \"entry\" screens for the feature to which they are related. You should use this icon when showing them on such a view, if you have a similar \"entry point\" view in your UI. If you don't have a UI, then I guess it doesn't matter either way does it?
	RootViewIcon string `json:"rootViewIcon,omitempty"`
	NodeType     int32  `json:"nodeType,omitempty"`
	// Indicates whether this presentation node's state is determined on a per-character or on an account-wide basis.
	Scope int32 `json:"scope,omitempty"`
	// If this presentation node shows a related objective (for instance, if it tracks the progress of its children), the objective being tracked is indicated here.
	ObjectiveHash int32 `json:"objectiveHash,omitempty"`
	// If this presentation node has an associated \"Record\" that you can accomplish for completing its children, this is the identifier of that Record.
	CompletionRecordHash int32 `json:"completionRecordHash,omitempty"`
	// The child entities contained by this presentation node.
	Children *AllOfDestinyDefinitionsPresentationDestinyPresentationNodeDefinitionChildren `json:"children,omitempty"`
	// A hint for how to display this presentation node when it's shown in a list.
	DisplayStyle int32 `json:"displayStyle,omitempty"`
	// A hint for how to display this presentation node when it's shown in its own detail screen.
	ScreenStyle int32 `json:"screenStyle,omitempty"`
	// The requirements for being able to interact with this presentation node and its children.
	Requirements *AllOfDestinyDefinitionsPresentationDestinyPresentationNodeDefinitionRequirements `json:"requirements,omitempty"`
	// If this presentation node has children, but the game doesn't let you inspect the details of those children, that is indicated here.
	DisableChildSubscreenNavigation bool     `json:"disableChildSubscreenNavigation,omitempty"`
	MaxCategoryRecordScore          int32    `json:"maxCategoryRecordScore,omitempty"`
	PresentationNodeType            int32    `json:"presentationNodeType,omitempty"`
	TraitIds                        []string `json:"traitIds,omitempty"`
	TraitHashes                     []int32  `json:"traitHashes,omitempty"`
	// A quick reference to presentation nodes that have this node as a child. Presentation nodes can be parented under multiple parents.
	ParentNodeHashes []int32 `json:"parentNodeHashes,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

A PresentationNode is an entity that represents a logical grouping of other entities visually/organizationally. For now, Presentation Nodes may contain the following... but it may be used for more in the future: - Collectibles - Records (Or, as the public will call them, \"Triumphs.\" Don't ask me why we're overloading the term \"Triumph\", it still hurts me to think about it) - Metrics (aka Stat Trackers) - Other Presentation Nodes, allowing a tree of Presentation Nodes to be created Part of me wants to break these into conceptual definitions per entity being collected, but the possibility of these different types being mixed in the same UI and the possibility that it could actually be more useful to return the \"bare metal\" presentation node concept has resulted in me deciding against that for the time being. We'll see if I come to regret this as well.

type DestinyDefinitionsPresentationDestinyPresentationNodeMetricChildEntry ¶

type DestinyDefinitionsPresentationDestinyPresentationNodeMetricChildEntry struct {
	MetricHash int32 `json:"metricHash,omitempty"`
	// Use this value to sort the presentation node children in ascending order.
	NodeDisplayPriority int32 `json:"nodeDisplayPriority,omitempty"`
}

type DestinyDefinitionsPresentationDestinyPresentationNodeRecordChildEntry ¶

type DestinyDefinitionsPresentationDestinyPresentationNodeRecordChildEntry struct {
	RecordHash int32 `json:"recordHash,omitempty"`
	// Use this value to sort the presentation node children in ascending order.
	NodeDisplayPriority int32 `json:"nodeDisplayPriority,omitempty"`
}

type DestinyDefinitionsPresentationDestinyPresentationNodeRequirementsBlock ¶

type DestinyDefinitionsPresentationDestinyPresentationNodeRequirementsBlock struct {
	// If this node is not accessible due to Entitlements (for instance, you don't own the required game expansion), this is the message to show.
	EntitlementUnavailableMessage string `json:"entitlementUnavailableMessage,omitempty"`
}

Presentation nodes can be restricted by various requirements. This defines the rules of those requirements, and the message(s) to be shown if these requirements aren't met.

type DestinyDefinitionsPresentationDestinyScoredPresentationNodeBaseDefinition ¶

type DestinyDefinitionsPresentationDestinyScoredPresentationNodeBaseDefinition struct {
	MaxCategoryRecordScore int32    `json:"maxCategoryRecordScore,omitempty"`
	PresentationNodeType   int32    `json:"presentationNodeType,omitempty"`
	TraitIds               []string `json:"traitIds,omitempty"`
	TraitHashes            []int32  `json:"traitHashes,omitempty"`
	// A quick reference to presentation nodes that have this node as a child. Presentation nodes can be parented under multiple parents.
	ParentNodeHashes []int32 `json:"parentNodeHashes,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

type DestinyDefinitionsProgressionDestinyProgressionLevelRequirementDefinition ¶

type DestinyDefinitionsProgressionDestinyProgressionLevelRequirementDefinition struct {
	// A curve of level requirements, weighted by the related progressions' level.  Interpolate against this curve with the character's progression level to determine what the level requirement of the generated item that is using this data will be.
	RequirementCurve []InterpolationInterpolationPointFloat `json:"requirementCurve,omitempty"`
	// The progression whose level should be used to determine the level requirement.  Look up the DestinyProgressionDefinition with this hash for more information about the progression in question.
	ProgressionHash int32 `json:"progressionHash,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

These are pre-constructed collections of data that can be used to determine the Level Requirement for an item given a Progression to be tested (such as the Character's level). For instance, say a character receives a new Auto Rifle, and that Auto Rifle's DestinyInventoryItemDefinition.quality.progressionLevelRequirementHash property is pointing at one of these DestinyProgressionLevelRequirementDefinitions. Let's pretend also that the progressionHash it is pointing at is the Character Level progression. In that situation, the character's level will be used to interpolate a value in the requirementCurve property. The value picked up from that interpolation will be the required level for the item.

type DestinyDefinitionsRecordsDestinyRecordCompletionBlock ¶

type DestinyDefinitionsRecordsDestinyRecordCompletionBlock struct {
	// The number of objectives that must be completed before the objective is considered \"complete\"
	PartialCompletionObjectiveCountThreshold int32 `json:"partialCompletionObjectiveCountThreshold,omitempty"`
	ScoreValue                               int32 `json:"ScoreValue,omitempty"`
	ShouldFireToast                          bool  `json:"shouldFireToast,omitempty"`
	ToastStyle                               int32 `json:"toastStyle,omitempty"`
}

type DestinyDefinitionsRecordsDestinyRecordDefinition ¶

type DestinyDefinitionsRecordsDestinyRecordDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// Indicates whether this Record's state is determined on a per-character or on an account-wide basis.
	Scope            int32                                                        `json:"scope,omitempty"`
	PresentationInfo *DestinyDefinitionsPresentationDestinyPresentationChildBlock `json:"presentationInfo,omitempty"`
	LoreHash         int32                                                        `json:"loreHash,omitempty"`
	ObjectiveHashes  []int32                                                      `json:"objectiveHashes,omitempty"`
	RecordValueStyle int32                                                        `json:"recordValueStyle,omitempty"`
	ForTitleGilding  bool                                                         `json:"forTitleGilding,omitempty"`
	// A hint to show a large icon for a reward
	ShouldShowLargeIcons bool                                                                    `json:"shouldShowLargeIcons,omitempty"`
	TitleInfo            *DestinyDefinitionsRecordsDestinyRecordTitleBlock                       `json:"titleInfo,omitempty"`
	CompletionInfo       *DestinyDefinitionsRecordsDestinyRecordCompletionBlock                  `json:"completionInfo,omitempty"`
	StateInfo            *DestinyDefinitionsRecordsSchemaRecordStateBlock                        `json:"stateInfo,omitempty"`
	Requirements         *DestinyDefinitionsPresentationDestinyPresentationNodeRequirementsBlock `json:"requirements,omitempty"`
	ExpirationInfo       *DestinyDefinitionsRecordsDestinyRecordExpirationBlock                  `json:"expirationInfo,omitempty"`
	// Some records have multiple 'interval' objectives, and the record may be claimed at each completed interval
	IntervalInfo *AllOfDestinyDefinitionsRecordsDestinyRecordDefinitionIntervalInfo `json:"intervalInfo,omitempty"`
	// If there is any publicly available information about rewards earned for achieving this record, this is the list of those items.   However, note that some records intentionally have \"hidden\" rewards. These will not be returned in this list.
	RewardItems          []DestinyDestinyItemQuantity `json:"rewardItems,omitempty"`
	PresentationNodeType int32                        `json:"presentationNodeType,omitempty"`
	TraitIds             []string                     `json:"traitIds,omitempty"`
	TraitHashes          []int32                      `json:"traitHashes,omitempty"`
	// A quick reference to presentation nodes that have this node as a child. Presentation nodes can be parented under multiple parents.
	ParentNodeHashes []int32 `json:"parentNodeHashes,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

type DestinyDefinitionsRecordsDestinyRecordExpirationBlock ¶

type DestinyDefinitionsRecordsDestinyRecordExpirationBlock struct {
	HasExpiration bool   `json:"hasExpiration,omitempty"`
	Description   string `json:"description,omitempty"`
	Icon          string `json:"icon,omitempty"`
}

If this record has an expiration after which it cannot be earned, this is some information about that expiration.

type DestinyDefinitionsRecordsDestinyRecordIntervalBlock ¶

type DestinyDefinitionsRecordsDestinyRecordIntervalBlock struct {
	IntervalObjectives                   []DestinyDefinitionsRecordsDestinyRecordIntervalObjective `json:"intervalObjectives,omitempty"`
	IntervalRewards                      []DestinyDefinitionsRecordsDestinyRecordIntervalRewards   `json:"intervalRewards,omitempty"`
	OriginalObjectiveArrayInsertionIndex int32                                                     `json:"originalObjectiveArrayInsertionIndex,omitempty"`
}

type DestinyDefinitionsRecordsDestinyRecordIntervalObjective ¶

type DestinyDefinitionsRecordsDestinyRecordIntervalObjective struct {
	IntervalObjectiveHash int32 `json:"intervalObjectiveHash,omitempty"`
	IntervalScoreValue    int32 `json:"intervalScoreValue,omitempty"`
}

type DestinyDefinitionsRecordsDestinyRecordIntervalRewards ¶

type DestinyDefinitionsRecordsDestinyRecordIntervalRewards struct {
	IntervalRewardItems []DestinyDestinyItemQuantity `json:"intervalRewardItems,omitempty"`
}

type DestinyDefinitionsRecordsDestinyRecordTitleBlock ¶

type DestinyDefinitionsRecordsDestinyRecordTitleBlock struct {
	HasTitle       bool              `json:"hasTitle,omitempty"`
	TitlesByGender map[string]string `json:"titlesByGender,omitempty"`
	// For those who prefer to use the definitions.
	TitlesByGenderHash        map[string]string `json:"titlesByGenderHash,omitempty"`
	GildingTrackingRecordHash int32             `json:"gildingTrackingRecordHash,omitempty"`
}

type DestinyDefinitionsRecordsSchemaRecordStateBlock ¶

type DestinyDefinitionsRecordsSchemaRecordStateBlock struct {
	FeaturedPriority int32  `json:"featuredPriority,omitempty"`
	ObscuredString   string `json:"obscuredString,omitempty"`
}

type DestinyDefinitionsReportingDestinyReportReasonCategoryDefinition ¶

type DestinyDefinitionsReportingDestinyReportReasonCategoryDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// The specific reasons for the report under this category.
	Reasons map[string]DestinyDefinitionsReportingDestinyReportReasonDefinition `json:"reasons,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

If you're going to report someone for a Terms of Service violation, you need to choose a category and reason for the report. This definition holds both the categories and the reasons within those categories, for simplicity and my own laziness' sake. Note tha this means that, to refer to a Reason by reasonHash, you need a combination of the reasonHash *and* the associated ReasonCategory's hash: there are some reasons defined under multiple categories.

type DestinyDefinitionsReportingDestinyReportReasonDefinition ¶

type DestinyDefinitionsReportingDestinyReportReasonDefinition struct {
	// The identifier for the reason: they are only guaranteed unique under the Category in which they are found.
	ReasonHash        int32                                                       `json:"reasonHash,omitempty"`
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
}

A specific reason for being banned. Only accessible under the related category (DestinyReportReasonCategoryDefinition) under which it is shown. Note that this means that report reasons' reasonHash are not globally unique: and indeed, entries like \"Other\" are defined under most categories for example.

type DestinyDefinitionsSeasonsDestinyEventCardDefinition ¶

type DestinyDefinitionsSeasonsDestinyEventCardDefinition struct {
	DisplayProperties            *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	LinkRedirectPath             string                                                      `json:"linkRedirectPath,omitempty"`
	Color                        *DestinyMiscDestinyColor                                    `json:"color,omitempty"`
	Images                       *DestinyDefinitionsSeasonsDestinyEventCardImages            `json:"images,omitempty"`
	TriumphsPresentationNodeHash int32                                                       `json:"triumphsPresentationNodeHash,omitempty"`
	SealPresentationNodeHash     int32                                                       `json:"sealPresentationNodeHash,omitempty"`
	TicketCurrencyItemHash       int32                                                       `json:"ticketCurrencyItemHash,omitempty"`
	TicketVendorHash             int32                                                       `json:"ticketVendorHash,omitempty"`
	TicketVendorCategoryHash     int32                                                       `json:"ticketVendorCategoryHash,omitempty"`
	EndTime                      int64                                                       `json:"endTime,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

Defines the properties of an 'Event Card' in Destiny 2, to coincide with a seasonal event for additional challenges, premium rewards, a new seal, and a special title. For example: Solstice of Heroes 2022.

type DestinyDefinitionsSeasonsDestinyEventCardImages ¶

type DestinyDefinitionsSeasonsDestinyEventCardImages struct {
	UnownedCardSleeveImagePath     string `json:"unownedCardSleeveImagePath,omitempty"`
	UnownedCardSleeveWrapImagePath string `json:"unownedCardSleeveWrapImagePath,omitempty"`
	CardIncompleteImagePath        string `json:"cardIncompleteImagePath,omitempty"`
	CardCompleteImagePath          string `json:"cardCompleteImagePath,omitempty"`
	CardCompleteWrapImagePath      string `json:"cardCompleteWrapImagePath,omitempty"`
	ProgressIconImagePath          string `json:"progressIconImagePath,omitempty"`
	ThemeBackgroundImagePath       string `json:"themeBackgroundImagePath,omitempty"`
}

type DestinyDefinitionsSeasonsDestinySeasonDefinition ¶

type DestinyDefinitionsSeasonsDestinySeasonDefinition struct {
	DisplayProperties                      *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	BackgroundImagePath                    string                                                      `json:"backgroundImagePath,omitempty"`
	SeasonNumber                           int32                                                       `json:"seasonNumber,omitempty"`
	StartDate                              time.Time                                                   `json:"startDate,omitempty"`
	EndDate                                time.Time                                                   `json:"endDate,omitempty"`
	SeasonPassHash                         int32                                                       `json:"seasonPassHash,omitempty"`
	SeasonPassProgressionHash              int32                                                       `json:"seasonPassProgressionHash,omitempty"`
	ArtifactItemHash                       int32                                                       `json:"artifactItemHash,omitempty"`
	SealPresentationNodeHash               int32                                                       `json:"sealPresentationNodeHash,omitempty"`
	SeasonalChallengesPresentationNodeHash int32                                                       `json:"seasonalChallengesPresentationNodeHash,omitempty"`
	// Optional - Defines the promotional text, images, and links to preview this season.
	Preview *AllOfDestinyDefinitionsSeasonsDestinySeasonDefinitionPreview `json:"preview,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

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.

type DestinyDefinitionsSeasonsDestinySeasonPassDefinition ¶

type DestinyDefinitionsSeasonsDestinySeasonPassDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// 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.
	RewardProgressionHash int32 `json:"rewardProgressionHash,omitempty"`
	// 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.
	PrestigeProgressionHash int32 `json:"prestigeProgressionHash,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

type DestinyDefinitionsSeasonsDestinySeasonPreviewDefinition ¶

type DestinyDefinitionsSeasonsDestinySeasonPreviewDefinition struct {
	// A localized description of the season.
	Description string `json:"description,omitempty"`
	// 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.
	LinkPath string `json:"linkPath,omitempty"`
	// An optional link to a localized video, probably YouTube.
	VideoLink string `json:"videoLink,omitempty"`
	// A list of images to preview the seasonal content. Should have at least three to show.
	Images []DestinyDefinitionsSeasonsDestinySeasonPreviewImageDefinition `json:"images,omitempty"`
}

Defines the promotional text, images, and links to preview this season.

type DestinyDefinitionsSeasonsDestinySeasonPreviewImageDefinition ¶

type DestinyDefinitionsSeasonsDestinySeasonPreviewImageDefinition struct {
	// A thumbnail icon path to preview seasonal content, probably 480x270.
	ThumbnailImage string `json:"thumbnailImage,omitempty"`
	// An optional path to a high-resolution image, probably 1920x1080.
	HighResImage string `json:"highResImage,omitempty"`
}

Defines the thumbnail icon, high-res image, and video link for promotional images

type DestinyDefinitionsSocialDestinySocialCommendationDefinition ¶

type DestinyDefinitionsSocialDestinySocialCommendationDefinition struct {
	DisplayProperties          *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	CardImagePath              string                                                      `json:"cardImagePath,omitempty"`
	Color                      *DestinyMiscDestinyColor                                    `json:"color,omitempty"`
	DisplayPriority            int32                                                       `json:"displayPriority,omitempty"`
	ActivityGivingLimit        int32                                                       `json:"activityGivingLimit,omitempty"`
	ParentCommendationNodeHash int32                                                       `json:"parentCommendationNodeHash,omitempty"`
	// The display properties for the the activities that this commendation is available in.
	DisplayActivities []DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayActivities,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

type DestinyDefinitionsSocialDestinySocialCommendationNodeDefinition ¶

type DestinyDefinitionsSocialDestinySocialCommendationNodeDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// The color associated with this group of commendations.
	Color                      *AllOfDestinyDefinitionsSocialDestinySocialCommendationNodeDefinitionColor `json:"color,omitempty"`
	ParentCommendationNodeHash int32                                                                      `json:"parentCommendationNodeHash,omitempty"`
	// A list of hashes that map to child commendation nodes. Only the root commendations node is expected to have child nodes.
	ChildCommendationNodeHashes []int32 `json:"childCommendationNodeHashes,omitempty"`
	// A list of hashes that map to child commendations.
	ChildCommendationHashes []int32 `json:"childCommendationHashes,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

type DestinyDefinitionsSocketsDestinyInsertPlugActionDefinition ¶

type DestinyDefinitionsSocketsDestinyInsertPlugActionDefinition struct {
	// How long it takes for the Plugging of the item to be completed once it is initiated, if you care.
	ActionExecuteSeconds int32 `json:"actionExecuteSeconds,omitempty"`
	// The type of action being performed when you act on this Socket Type. The most common value is \"insert plug\", but there are others as well (for instance, a \"Masterwork\" socket may allow for Re-initialization, and an Infusion socket allows for items to be consumed to upgrade the item)
	ActionType int32 `json:"actionType,omitempty"`
}

Data related to what happens while a plug is being inserted, mostly for UI purposes.

type DestinyDefinitionsSocketsDestinyPlugSetDefinition ¶

type DestinyDefinitionsSocketsDestinyPlugSetDefinition struct {
	// If you want to show these plugs in isolation, these are the display properties for them.
	DisplayProperties *AllOfDestinyDefinitionsSocketsDestinyPlugSetDefinitionDisplayProperties `json:"displayProperties,omitempty"`
	// This is a list of pre-determined plugs that can be plugged into this socket, without the character having the plug in their inventory.  If this list is populated, you will not be allowed to plug an arbitrary item in the socket: you will only be able to choose from one of these reusable plugs.
	ReusablePlugItems []DestinyDefinitionsDestinyItemSocketEntryPlugItemRandomizedDefinition `json:"reusablePlugItems,omitempty"`
	// Mostly for our debugging or reporting bugs, BNet is making \"fake\" plug sets in a desperate effort to reduce socket sizes.   If this is true, the plug set was generated by BNet: if it looks wrong, that's a good indicator that it's bungie.net that fucked this up.
	IsFakePlugSet bool `json:"isFakePlugSet,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

Sometimes, we have large sets of reusable plugs that are defined identically and thus can (and in some cases, are so large that they *must*) be shared across the places where they are used. These are the definitions for those reusable sets of plugs. See DestinyItemSocketEntryDefinition.plugSource and reusablePlugSetHash for the relationship between these reusable plug sets and the sockets that leverage them (for starters, Emotes). As of the release of Shadowkeep (Late 2019), these will begin to be sourced from game content directly - which means there will be many more of them, but it also means we may not get all data that we used to get for them. DisplayProperties, in particular, will no longer be guaranteed to contain valid information. We will make a best effort to guess what ought to be populated there where possible, but it will be invalid for many/most plug sets.

type DestinyDefinitionsSocketsDestinyPlugWhitelistEntryDefinition ¶

type DestinyDefinitionsSocketsDestinyPlugWhitelistEntryDefinition struct {
	// The hash identifier of the Plug Category to compare against the plug item's plug.plugCategoryHash.  Note that this does NOT relate to any Definition in itself, it is only used for comparison purposes.
	CategoryHash int32 `json:"categoryHash,omitempty"`
	// The string identifier for the category, which is here mostly for debug purposes.
	CategoryIdentifier string `json:"categoryIdentifier,omitempty"`
	// The list of all plug items (DestinyInventoryItemDefinition) that the socket may randomly be populated with when reinitialized.  Which ones you should actually show are determined by the plug being inserted into the socket, and the socket’s type.  When you inspect the plug that could go into a Masterwork Socket, look up the socket type of the socket being inspected and find the DestinySocketTypeDefinition.  Then, look at the Plugs that can fit in that socket. Find the Whitelist in the DestinySocketTypeDefinition that matches the plug item’s categoryhash.  That whitelist entry will potentially have a new “reinitializationPossiblePlugHashes” property.If it does, that means we know what it will roll if you try to insert this plug into this socket.
	ReinitializationPossiblePlugHashes []int32 `json:"reinitializationPossiblePlugHashes,omitempty"`
}

Defines a plug \"Category\" that is allowed to be plugged into a socket of this type. This should be compared against a given plug item's DestinyInventoryItemDefinition.plug.plugCategoryHash, which indicates the plug item's category.

type DestinyDefinitionsSocketsDestinySocketCategoryDefinition ¶

type DestinyDefinitionsSocketsDestinySocketCategoryDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// A string hinting to the game's UI system about how the sockets in this category should be displayed.  BNet doesn't use it: it's up to you to find valid values and make your own special UI if you want to honor this category style.
	UiCategoryStyle int32 `json:"uiCategoryStyle,omitempty"`
	// Same as uiCategoryStyle, but in a more usable enumeration form.
	CategoryStyle int32 `json:"categoryStyle,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

Sockets on an item are organized into Categories visually. You can find references to the socket category defined on an item's DestinyInventoryItemDefinition.sockets.socketCategories property. This has the display information for rendering the categories' header, and a hint for how the UI should handle showing this category. The shitty thing about this, however, is that the socket categories' UI style can be overridden by the item's UI style. For instance, the Socket Category used by Emote Sockets says it's \"consumable,\" but that's a lie: they're all reusable, and overridden by the detail UI pages in ways that we can't easily account for in the API. As a result, I will try to compile these rules into the individual sockets on items, and provide the best hint possible there through the plugSources property. In the future, I may attempt to use this information in conjunction with the item to provide a more usable UI hint on the socket layer, but for now improving the consistency of plugSources is the best I have time to provide. (See https://github.com/Bungie-net/api/issues/522 for more info)

type DestinyDefinitionsSocketsDestinySocketTypeDefinition ¶

type DestinyDefinitionsSocketsDestinySocketTypeDefinition struct {
	// There are fields for this display data, but they appear to be unpopulated as of now. I am not sure where in the UI these would show if they even were populated, but I will continue to return this data in case it becomes useful.
	DisplayProperties *AllOfDestinyDefinitionsSocketsDestinySocketTypeDefinitionDisplayProperties `json:"displayProperties,omitempty"`
	// Defines what happens when a plug is inserted into sockets of this type.
	InsertAction *AllOfDestinyDefinitionsSocketsDestinySocketTypeDefinitionInsertAction `json:"insertAction,omitempty"`
	// A list of Plug \"Categories\" that are allowed to be plugged into sockets of this type.  These should be compared against a given plug item's DestinyInventoryItemDefinition.plug.plugCategoryHash, which indicates the plug item's category.  If the plug's category matches any whitelisted plug, or if the whitelist is empty, it is allowed to be inserted.
	PlugWhitelist      []DestinyDefinitionsSocketsDestinyPlugWhitelistEntryDefinition `json:"plugWhitelist,omitempty"`
	SocketCategoryHash int32                                                          `json:"socketCategoryHash,omitempty"`
	// Sometimes a socket isn't visible. These are some of the conditions under which sockets of this type are not visible. Unfortunately, the truth of visibility is much, much more complex. Best to rely on the live data for whether the socket is visible and enabled.
	Visibility                 int32 `json:"visibility,omitempty"`
	AlwaysRandomizeSockets     bool  `json:"alwaysRandomizeSockets,omitempty"`
	IsPreviewEnabled           bool  `json:"isPreviewEnabled,omitempty"`
	HideDuplicateReusablePlugs bool  `json:"hideDuplicateReusablePlugs,omitempty"`
	// This property indicates if the socket type determines whether Emblem icons and nameplates should be overridden by the inserted plug item's icon and nameplate.
	OverridesUiAppearance           bool                                                                       `json:"overridesUiAppearance,omitempty"`
	AvoidDuplicatesOnInitialization bool                                                                       `json:"avoidDuplicatesOnInitialization,omitempty"`
	CurrencyScalars                 []DestinyDefinitionsSocketsDestinySocketTypeScalarMaterialRequirementEntry `json:"currencyScalars,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

All Sockets have a \"Type\": a set of common properties that determine when the socket allows Plugs to be inserted, what Categories of Plugs can be inserted, and whether the socket is even visible at all given the current game/character/account state. See DestinyInventoryItemDefinition for more information about Socketed items and Plugs.

type DestinyDefinitionsSocketsDestinySocketTypeScalarMaterialRequirementEntry ¶

type DestinyDefinitionsSocketsDestinySocketTypeScalarMaterialRequirementEntry struct {
	CurrencyItemHash int32 `json:"currencyItemHash,omitempty"`
	ScalarValue      int32 `json:"scalarValue,omitempty"`
}

type DestinyDefinitionsSourcesDestinyItemSourceDefinition ¶

type DestinyDefinitionsSourcesDestinyItemSourceDefinition struct {
	// The level at which the item spawns. Essentially the Primary Key for this source data: there will be multiple of these source entries per item that has source data, grouped by the level at which the item spawns.
	Level int32 `json:"level,omitempty"`
	// The minimum Quality at which the item spawns for this level. Examine DestinyInventoryItemDefinition for more information about what Quality means. Just don't ask Phaedrus about it, he'll never stop talking and you'll have to write a book about it.
	MinQuality int32 `json:"minQuality,omitempty"`
	// The maximum quality at which the item spawns for this level.
	MaxQuality int32 `json:"maxQuality,omitempty"`
	// The minimum Character Level required for equipping the item when the item spawns at the item level defined on this DestinyItemSourceDefinition, as far as we saw in our processing.
	MinLevelRequired int32 `json:"minLevelRequired,omitempty"`
	// The maximum Character Level required for equipping the item when the item spawns at the item level defined on this DestinyItemSourceDefinition, as far as we saw in our processing.
	MaxLevelRequired int32 `json:"maxLevelRequired,omitempty"`
	// The stats computed for this level/quality range.
	ComputedStats map[string]DestinyDefinitionsDestinyInventoryItemStatDefinition `json:"computedStats,omitempty"`
	// The DestinyRewardSourceDefinitions found that can spawn the item at this level.
	SourceHashes []int32 `json:"sourceHashes,omitempty"`
}

Properties of a DestinyInventoryItemDefinition that store all of the information we were able to discern about how the item spawns, and where you can find the item. Items will have many of these sources, one per level at which it spawns, to try and give more granular data about where items spawn for specific level ranges.

type DestinyDefinitionsTraitsDestinyTraitDefinition ¶

type DestinyDefinitionsTraitsDestinyTraitDefinition struct {
	DisplayProperties *DestinyDefinitionsCommonDestinyDisplayPropertiesDefinition `json:"displayProperties,omitempty"`
	// An identifier for how this trait can be displayed. For example: a 'keyword' hint to show an explanation for certain related terms.
	DisplayHint string `json:"displayHint,omitempty"`
	// 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.
	Hash int32 `json:"hash,omitempty"`
	// The index of the entity as it was found in the investment tables.
	Index int32 `json:"index,omitempty"`
	// If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
	Redacted bool `json:"redacted,omitempty"`
}

type DestinyDefinitionsVendorsDestinyVendorLocationDefinition ¶

type DestinyDefinitionsVendorsDestinyVendorLocationDefinition struct {
	// The hash identifier for a Destination at which this vendor may be located. Each destination where a Vendor may exist will only ever have a single entry.
	DestinationHash int32 `json:"destinationHash,omitempty"`
	// The relative path to the background image representing this Vendor at this location, for use in a banner.
	BackgroundImagePath string `json:"backgroundImagePath,omitempty"`
}

These definitions represent vendors' locations and relevant display information at different times in the game.

type DestinyDestinyActivity ¶

type DestinyDestinyActivity struct {
	// The hash identifier of the Activity. Use this to look up the DestinyActivityDefinition of the activity.
	ActivityHash int32 `json:"activityHash,omitempty"`
	// If true, then the activity should have a \"new\" indicator in the Director UI.
	IsNew bool `json:"isNew,omitempty"`
	// If true, the user is allowed to lead a Fireteam into this activity.
	CanLead bool `json:"canLead,omitempty"`
	// If true, the user is allowed to join with another Fireteam in this activity.
	CanJoin bool `json:"canJoin,omitempty"`
	// If true, we both have the ability to know that the user has completed this activity and they have completed it. Unfortunately, we can't necessarily know this for all activities. As such, this should probably only be used if you already know in advance which specific activities you wish to check.
	IsCompleted bool `json:"isCompleted,omitempty"`
	// If true, the user should be able to see this activity.
	IsVisible bool `json:"isVisible,omitempty"`
	// The difficulty level of the activity, if applicable.
	DisplayLevel int32 `json:"displayLevel,omitempty"`
	// The recommended light level for the activity, if applicable.
	RecommendedLight int32 `json:"recommendedLight,omitempty"`
	// A DestinyActivityDifficultyTier enum value indicating the difficulty of the activity.
	DifficultyTier int32                                     `json:"difficultyTier,omitempty"`
	Challenges     []DestinyChallengesDestinyChallengeStatus `json:"challenges,omitempty"`
	// If the activity has modifiers, this will be the list of modifiers that all variants have in common. Perform lookups against DestinyActivityModifierDefinition which defines the modifier being applied to get at the modifier data.  Note that, in the DestiyActivityDefinition, you will see many more modifiers than this being referred to: those are all *possible* modifiers for the activity, not the active ones. Use only the active ones to match what's really live.
	ModifierHashes []int32 `json:"modifierHashes,omitempty"`
	// The set of activity options for this activity, keyed by an identifier that's unique for this activity (not guaranteed to be unique between or across all activities, though should be unique for every *variant* of a given *conceptual* activity: for instance, the original D2 Raid has many variant DestinyActivityDefinitions. While other activities could potentially have the same option hashes, for any given D2 base Raid variant the hash will be unique).  As a concrete example of this data, the hashes you get for Raids will correspond to the currently active \"Challenge Mode\".  We don't have any human readable information for these, but saavy 3rd party app users could manually associate the key (a hash identifier for the \"option\" that is enabled/disabled) and the value (whether it's enabled or disabled presently)  On our side, we don't necessarily even know what these are used for (the game designers know, but we don't), and we have no human readable data for them. In order to use them, you will have to do some experimentation.
	BooleanActivityOptions map[string]bool `json:"booleanActivityOptions,omitempty"`
	// If returned, this is the index into the DestinyActivityDefinition's \"loadouts\" property, indicating the currently active loadout requirements.
	LoadoutRequirementIndex int32 `json:"loadoutRequirementIndex,omitempty"`
}

Represents the \"Live\" data that we can obtain about a Character's status with a specific Activity. This will tell you whether the character can participate in the activity, as well as some other basic mutable information. Meant to be combined with static DestinyActivityDefinition data for a full picture of the Activity.

type DestinyDestinyActivityDifficultyTier ¶

type DestinyDestinyActivityDifficultyTier int32

DestinyDestinyActivityDifficultyTier : An enumeration representing the potential difficulty levels of an activity. Their names are... more qualitative than quantitative.

type DestinyDestinyActivityModeCategory ¶

type DestinyDestinyActivityModeCategory int32

DestinyDestinyActivityModeCategory : Activity Modes are grouped into a few possible broad categories.

type DestinyDestinyActivityNavPointType ¶

type DestinyDestinyActivityNavPointType int32

type DestinyDestinyAmmunitionType ¶

type DestinyDestinyAmmunitionType int32

type DestinyDestinyBreakerType ¶

type DestinyDestinyBreakerType int32

DestinyDestinyBreakerType : A plug can optionally have a \"Breaker Type\": a special ability that can affect units in unique ways. Activating this plug can grant one of these types.

type DestinyDestinyClass ¶

type DestinyDestinyClass int32

type DestinyDestinyCollectibleState ¶

type DestinyDestinyCollectibleState int32

DestinyDestinyCollectibleState : A Flags Enumeration/bitmask where each bit represents a different state that the Collectible can be in. A collectible can be in any number of these states, and you can choose to use or ignore any or all of them when making your own UI that shows Collectible info. Our displays are going to honor them, but we're also the kind of people who only pretend to inhale before quickly passing it to the left. So, you know, do what you got to do. (All joking aside, please note the caveat I mention around the Invisible flag: there are cases where it is in the best interest of your users to honor these flags even if you're a \"show all the data\" person. Collector-oriented compulsion is a very unfortunate and real thing, and I would hate to instill that compulsion in others through showing them items that they cannot earn. Please consider this when you are making your own apps/sites.)

type DestinyDestinyComponentType ¶

type DestinyDestinyComponentType int32

DestinyDestinyComponentType : Represents the possible components that can be returned from Destiny \"Get\" calls such as GetProfile, GetCharacter, GetVendor etc... When making one of these requests, you will pass one or more of these components as a comma separated list in the \"?components=\" querystring parameter. For instance, if you want baseline Profile data, Character Data, and character progressions, you would pass \"?components=Profiles,Characters,CharacterProgressions\" You may use either the numerical or string values.

type DestinyDestinyEnergyType ¶

type DestinyDestinyEnergyType int32

DestinyDestinyEnergyType : Represents the socket energy types for Armor 2.0, Ghosts 2.0, and Stasis subclasses.

type DestinyDestinyEquipItemResult ¶

type DestinyDestinyEquipItemResult struct {
	// The instance ID of the item in question (all items that can be equipped must, but definition, be Instanced and thus have an Instance ID that you can use to refer to them)
	ItemInstanceId int64 `json:"itemInstanceId,omitempty"`
	// A PlatformErrorCodes enum indicating whether it succeeded, and if it failed why.
	EquipStatus int32 `json:"equipStatus,omitempty"`
}

The results of an Equipping operation performed through the Destiny API.

type DestinyDestinyEquipItemResults ¶

type DestinyDestinyEquipItemResults struct {
	EquipResults []DestinyDestinyEquipItemResult `json:"equipResults,omitempty"`
}

The results of a bulk Equipping operation performed through the Destiny API.

type DestinyDestinyGamePrivacySetting ¶

type DestinyDestinyGamePrivacySetting int32

DestinyDestinyGamePrivacySetting : A player can choose to restrict requests to join their Fireteam to specific states. These are the possible states a user can choose.

type DestinyDestinyGameVersions ¶

type DestinyDestinyGameVersions int32

DestinyDestinyGameVersions : A flags enumeration/bitmask indicating the versions of the game that a given user has purchased.

type DestinyDestinyGatingScope ¶

type DestinyDestinyGatingScope int32

DestinyDestinyGatingScope : This enumeration represents the most restrictive type of gating that is being performed by an entity. This is useful as a shortcut to avoid a lot of lookups when determining whether the gating on an Entity applies to everyone equally, or to their specific Profile or Character states. None = There is no gating on this item. Global = The gating on this item is based entirely on global game state. It will be gated the same for everyone. Clan = The gating on this item is at the Clan level. For instance, if you're gated by Clan level this will be the case. Profile = The gating includes Profile-specific checks, but not on the Profile's characters. An example of this might be when you acquire an Emblem: the Emblem will be available in your Kiosk for all characters in your Profile from that point onward. Character = The gating includes Character-specific checks, including character level restrictions. An example of this might be an item that you can't purchase from a Vendor until you reach a specific Character Level. Item = The gating includes item-specific checks. For BNet, this generally implies that we'll show this data only on a character level or deeper. AssumedWorstCase = The unlocks and checks being used for this calculation are of an unknown type and are used for unknown purposes. For instance, if some great person decided that an unlock value should be globally scoped, but then the game changes it using character-specific data in a way that BNet doesn't know about. Because of the open-ended potential for this to occur, many unlock checks for \"globally\" scoped unlock data may be assumed as the worst case unless it has been specifically whitelisted as otherwise. That sucks, but them's the breaks.

type DestinyDestinyGender ¶

type DestinyDestinyGender int32

type DestinyDestinyGraphNodeState ¶

type DestinyDestinyGraphNodeState int32

DestinyDestinyGraphNodeState : Represents a potential state of an Activity Graph node.

type DestinyDestinyItemQuantity ¶

type DestinyDestinyItemQuantity struct {
	// The hash identifier for the item in question. Use it to look up the item's DestinyInventoryItemDefinition.
	ItemHash int32 `json:"itemHash,omitempty"`
	// If this quantity is referring to a specific instance of an item, this will have the item's instance ID. Normally, this will be null.
	ItemInstanceId int64 `json:"itemInstanceId,omitempty"`
	// The amount of the item needed/available depending on the context of where DestinyItemQuantity is being used.
	Quantity int32 `json:"quantity,omitempty"`
	// Indicates that this item quantity may be conditionally shown or hidden, based on various sources of state. For example: server flags, account state, or character progress.
	HasConditionalVisibility bool `json:"hasConditionalVisibility,omitempty"`
}

Used in a number of Destiny contracts to return data about an item stack and its quantity. Can optionally return an itemInstanceId if the item is instanced - in which case, the quantity returned will be 1. If it's not... uh, let me know okay? Thanks.

type DestinyDestinyItemSortType ¶

type DestinyDestinyItemSortType int32

DestinyDestinyItemSortType : Determines how items are sorted in an inventory bucket.

type DestinyDestinyItemSubType ¶

type DestinyDestinyItemSubType int32

DestinyDestinyItemSubType : This Enumeration further classifies items by more specific categorizations than DestinyItemType. The \"Sub-Type\" is where we classify and categorize items one step further in specificity: \"Auto Rifle\" instead of just \"Weapon\" for example, or \"Vanguard Bounty\" instead of merely \"Bounty\". These sub-types are provided for historical compatibility with Destiny 1, but an ideal alternative is to use DestinyItemCategoryDefinitions and the DestinyItemDefinition.itemCategories property instead. Item Categories allow for arbitrary hierarchies of specificity, and for items to belong to multiple categories across multiple hierarchies simultaneously. For this enum, we pick a single type as a \"best guess\" fit. NOTE: This is not all of the item types available, and some of these are holdovers from Destiny 1 that may or may not still exist.

type DestinyDestinyItemType ¶

type DestinyDestinyItemType int32

DestinyDestinyItemType : An enumeration that indicates the high-level \"type\" of the item, attempting to iron out the context specific differences for specific instances of an entity. For instance, though a weapon may be of various weapon \"Types\", in DestinyItemType they are all classified as \"Weapon\". This allows for better filtering on a higher level of abstraction for the concept of types. This enum is provided for historical compatibility with Destiny 1, but an ideal alternative is to use DestinyItemCategoryDefinitions and the DestinyItemDefinition.itemCategories property instead. Item Categories allow for arbitrary hierarchies of specificity, and for items to belong to multiple categories across multiple hierarchies simultaneously. For this enum, we pick a single type as a \"best guess\" fit. NOTE: This is not all of the item types available, and some of these are holdovers from Destiny 1 that may or may not still exist. I keep updating these because they're so damn convenient. I guess I shouldn't fight it.

type DestinyDestinyJoinClosedReasons ¶

type DestinyDestinyJoinClosedReasons int32

DestinyDestinyJoinClosedReasons : A Flags enumeration representing the reasons why a person can't join this user's fireteam.

type DestinyDestinyObjectiveGrantStyle ¶

type DestinyDestinyObjectiveGrantStyle int32

DestinyDestinyObjectiveGrantStyle : Some Objectives provide perks, generally as part of providing some kind of interesting modifier for a Challenge or Quest. This indicates when the Perk is granted.

type DestinyDestinyObjectiveUiStyle ¶

type DestinyDestinyObjectiveUiStyle int32

DestinyDestinyObjectiveUiStyle : If the objective has a known UI label, this enumeration will represent it.

type DestinyDestinyPartyMemberStates ¶

type DestinyDestinyPartyMemberStates int32

DestinyDestinyPartyMemberStates : A flags enumeration that represents a Fireteam Member's status.

type DestinyDestinyPresentationDisplayStyle ¶

type DestinyDestinyPresentationDisplayStyle int32

DestinyDestinyPresentationDisplayStyle : A hint for how the presentation node should be displayed when shown in a list. How you use this is your UI is up to you.

type DestinyDestinyPresentationNodeState ¶

type DestinyDestinyPresentationNodeState int32

DestinyDestinyPresentationNodeState : I know this doesn't look like a Flags Enumeration/bitmask right now, but I assure you it is. This is the possible states that a Presentation Node can be in, and it is almost certain that its potential states will increase in the future. So don't treat it like a straight up enumeration.

type DestinyDestinyPresentationNodeType ¶

type DestinyDestinyPresentationNodeType int32

type DestinyDestinyPresentationScreenStyle ¶

type DestinyDestinyPresentationScreenStyle int32

DestinyDestinyPresentationScreenStyle : A hint for what screen should be shown when this presentation node is clicked into. How you use this is your UI is up to you.

type DestinyDestinyProgression ¶

type DestinyDestinyProgression struct {
	// The hash identifier of the Progression in question. Use it to look up the DestinyProgressionDefinition in static data.
	ProgressionHash int32 `json:"progressionHash,omitempty"`
	// The amount of progress earned today for this progression.
	DailyProgress int32 `json:"dailyProgress,omitempty"`
	// If this progression has a daily limit, this is that limit.
	DailyLimit int32 `json:"dailyLimit,omitempty"`
	// The amount of progress earned toward this progression in the current week.
	WeeklyProgress int32 `json:"weeklyProgress,omitempty"`
	// If this progression has a weekly limit, this is that limit.
	WeeklyLimit int32 `json:"weeklyLimit,omitempty"`
	// This is the total amount of progress obtained overall for this progression (for instance, the total amount of Character Level experience earned)
	CurrentProgress int32 `json:"currentProgress,omitempty"`
	// This is the level of the progression (for instance, the Character Level).
	Level int32 `json:"level,omitempty"`
	// This is the maximum possible level you can achieve for this progression (for example, the maximum character level obtainable)
	LevelCap int32 `json:"levelCap,omitempty"`
	// Progressions define their levels in \"steps\". Since the last step may be repeatable, the user may be at a higher level than the actual Step achieved in the progression. Not necessarily useful, but potentially interesting for those cruising the API. Relate this to the \"steps\" property of the DestinyProgression to see which step the user is on, if you care about that. (Note that this is Content Version dependent since it refers to indexes.)
	StepIndex int32 `json:"stepIndex,omitempty"`
	// The amount of progression (i.e. \"Experience\") needed to reach the next level of this Progression. Jeez, progression is such an overloaded word.
	ProgressToNextLevel int32 `json:"progressToNextLevel,omitempty"`
	// The total amount of progression (i.e. \"Experience\") needed in order to reach the next level.
	NextLevelAt int32 `json:"nextLevelAt,omitempty"`
	// The number of resets of this progression you've executed this season, if applicable to this progression.
	CurrentResetCount int32 `json:"currentResetCount,omitempty"`
	// Information about historical resets of this progression, if there is any data for it.
	SeasonResets []DestinyDestinyProgressionResetEntry `json:"seasonResets,omitempty"`
	// Information about historical rewards for this progression, if there is any data for it.
	RewardItemStates []int32 `json:"rewardItemStates,omitempty"`
}

Information about a current character's status with a Progression. A progression is a value that can increase with activity and has levels. Think Character Level and Reputation Levels. Combine this \"live\" data with the related DestinyProgressionDefinition for a full picture of the Progression.

type DestinyDestinyProgressionResetEntry ¶

type DestinyDestinyProgressionResetEntry struct {
	Season int32 `json:"season,omitempty"`
	Resets int32 `json:"resets,omitempty"`
}

Represents a season and the number of resets you had in that season. We do not necessarily - even for progressions with resets - track it over all seasons. So be careful and check the season numbers being returned.

type DestinyDestinyProgressionRewardItemAcquisitionBehavior ¶

type DestinyDestinyProgressionRewardItemAcquisitionBehavior int32

DestinyDestinyProgressionRewardItemAcquisitionBehavior : Represents the different kinds of acquisition behavior for progression reward items.

type DestinyDestinyProgressionRewardItemState ¶

type DestinyDestinyProgressionRewardItemState int32

DestinyDestinyProgressionRewardItemState : Represents the different states a progression reward item can be in.

type DestinyDestinyProgressionScope ¶

type DestinyDestinyProgressionScope int32

DestinyDestinyProgressionScope : There are many Progressions in Destiny (think Character Level, or Reputation). These are the various \"Scopes\" of Progressions, which affect many things: * Where/if they are stored * How they are calculated * Where they can be used in other game logic

type DestinyDestinyProgressionStepDisplayEffect ¶

type DestinyDestinyProgressionStepDisplayEffect int32

DestinyDestinyProgressionStepDisplayEffect : If progression is earned, this determines whether the progression shows visual effects on the character or its item - or neither.

type DestinyDestinyRace ¶

type DestinyDestinyRace int32

type DestinyDestinyRecordState ¶

type DestinyDestinyRecordState int32

DestinyDestinyRecordState : A Flags enumeration/bitmask where each bit represents a possible state that a Record/Triumph can be in.

type DestinyDestinyRecordToastStyle ¶

type DestinyDestinyRecordToastStyle int32

type DestinyDestinyRecordValueStyle ¶

type DestinyDestinyRecordValueStyle int32

type DestinyDestinyScope ¶

type DestinyDestinyScope int32

DestinyDestinyScope : There's a lot of places where we need to know scope on more than just a profile or character level. For everything else, there's this more generic sense of scope.

type DestinyDestinySocketCategoryStyle ¶

type DestinyDestinySocketCategoryStyle int32

DestinyDestinySocketCategoryStyle : Represents the possible and known UI styles used by the game for rendering Socket Categories.

type DestinyDestinySocketVisibility ¶

type DestinyDestinySocketVisibility int32

type DestinyDestinyStat ¶

type DestinyDestinyStat struct {
	// The hash identifier for the Stat. Use it to look up the DestinyStatDefinition for static data about the stat.
	StatHash int32 `json:"statHash,omitempty"`
	// The current value of the Stat.
	Value int32 `json:"value,omitempty"`
}

Represents a stat on an item *or* Character (NOT a Historical Stat, but a physical attribute stat like Attack, Defense etc...)

type DestinyDestinyStatAggregationType ¶

type DestinyDestinyStatAggregationType int32

DestinyDestinyStatAggregationType : When a Stat (DestinyStatDefinition) is aggregated, this is the rules used for determining the level and formula used for aggregation. * CharacterAverage = apply a weighted average using the related DestinyStatGroupDefinition on the DestinyInventoryItemDefinition across the character's equipped items. See both of those definitions for details. * Character = don't aggregate: the stat should be located and used directly on the character. * Item = don't aggregate: the stat should be located and used directly on the item.

type DestinyDestinyStatCategory ¶

type DestinyDestinyStatCategory int32

DestinyDestinyStatCategory : At last, stats have categories. Use this for whatever purpose you might wish.

type DestinyDestinyTalentNode ¶

type DestinyDestinyTalentNode struct {
	// The index of the Talent Node being referred to (an index into DestinyTalentGridDefinition.nodes[]). CONTENT VERSION DEPENDENT.
	NodeIndex int32 `json:"nodeIndex,omitempty"`
	// The hash of the Talent Node being referred to (in DestinyTalentGridDefinition.nodes). Deceptively CONTENT VERSION DEPENDENT. We have no guarantee of the hash's immutability between content versions.
	NodeHash int32 `json:"nodeHash,omitempty"`
	// An DestinyTalentNodeState enum value indicating the node's state: whether it can be activated or swapped, and why not if neither can be performed.
	State int32 `json:"state,omitempty"`
	// If true, the node is activated: it's current step then provides its benefits.
	IsActivated bool `json:"isActivated,omitempty"`
	// The currently relevant Step for the node. It is this step that has rendering data for the node and the benefits that are provided if the node is activated. (the actual rules for benefits provided are extremely complicated in theory, but with how Talent Grids are being used in Destiny 2 you don't have to worry about a lot of those old Destiny 1 rules.) This is an index into: DestinyTalentGridDefinition.nodes[nodeIndex].steps[stepIndex]
	StepIndex int32 `json:"stepIndex,omitempty"`
	// If the node has material requirements to be activated, this is the list of those requirements.
	MaterialsToUpgrade []DestinyDefinitionsDestinyMaterialRequirement `json:"materialsToUpgrade,omitempty"`
	// The progression level required on the Talent Grid in order to be able to activate this talent node. Talent Grids have their own Progression - similar to Character Level, but in this case it is experience related to the item itself.
	ActivationGridLevel int32 `json:"activationGridLevel,omitempty"`
	// If you want to show a progress bar or circle for how close this talent node is to being activate-able, this is the percentage to show. It follows the node's underlying rules about when the progress bar should first show up, and when it should be filled.
	ProgressPercent float32 `json:"progressPercent,omitempty"`
	// Whether or not the talent node is actually visible in the game's UI. Whether you want to show it in your own UI is up to you! I'm not gonna tell you who to sock it to.
	Hidden bool `json:"hidden,omitempty"`
	// This property has some history. A talent grid can provide stats on both the item it's related to and the character equipping the item. This returns data about those stat bonuses.
	NodeStatsBlock *AllOfDestinyDestinyTalentNodeNodeStatsBlock `json:"nodeStatsBlock,omitempty"`
}

I see you've come to find out more about Talent Nodes. I'm so sorry. Talent Nodes are the conceptual, visual nodes that appear on Talent Grids. Talent Grids, in Destiny 1, were found on almost every instanced item: they had Nodes that could be activated to change the properties of the item. In Destiny 2, Talent Grids only exist for Builds/Subclasses, and while the basic concept is the same (Nodes can be activated once you've gained sufficient Experience on the Item, and provide effects), there are some new concepts from Destiny 1. Examine DestinyTalentGridDefinition and its subordinates for more information. This is the \"Live\" information for the current status of a Talent Node on a specific item. Talent Nodes have many Steps, but only one can be active at any one time: and it is the Step that determines both the visual and the game state-changing properties that the Node provides. Examine this and DestinyTalentNodeStepDefinition carefully. *IMPORTANT NOTE* Talent Nodes are, unfortunately, Content Version DEPENDENT. Though they refer to hashes for Nodes and Steps, those hashes are not guaranteed to be immutable across content versions. This is a source of great exasperation for me, but as a result anyone using Talent Grid data must ensure that the content version of their static content matches that of the server responses before showing or making decisions based on talent grid data.

type DestinyDestinyTalentNodeStatBlock ¶

type DestinyDestinyTalentNodeStatBlock struct {
	// The stat benefits conferred when this talent node is activated for the current Step that is active on the node.
	CurrentStepStats []DestinyDestinyStat `json:"currentStepStats,omitempty"`
	// This is a holdover from the old days of Destiny 1, when a node could be activated multiple times, conferring multiple steps worth of benefits: you would use this property to show what activating the \"next\" step on the node would provide vs. what the current step is providing. While Nodes are currently not being used this way, the underlying system for this functionality still exists. I hesitate to remove this property while the ability for designers to make such a talent grid still exists. Whether you want to show it is up to you.
	NextStepStats []DestinyDestinyStat `json:"nextStepStats,omitempty"`
}

This property has some history. A talent grid can provide stats on both the item it's related to and the character equipping the item. This returns data about those stat bonuses.

type DestinyDestinyTalentNodeState ¶

type DestinyDestinyTalentNodeState int32

type DestinyDestinyUnlockStatus ¶

type DestinyDestinyUnlockStatus struct {
	// The hash identifier for the Unlock Flag. Use to lookup DestinyUnlockDefinition for static data. Not all unlocks have human readable data - in fact, most don't. But when they do, it can be very useful to show. Even if they don't have human readable data, you might be able to infer the meaning of an unlock flag with a bit of experimentation...
	UnlockHash int32 `json:"unlockHash,omitempty"`
	// Whether the unlock flag is set.
	IsSet bool `json:"isSet,omitempty"`
}

Indicates the status of an \"Unlock Flag\" on a Character or Profile. These are individual bits of state that can be either set or not set, and sometimes provide interesting human-readable information in their related DestinyUnlockDefinition.

type DestinyDestinyUnlockValueUiStyle ¶

type DestinyDestinyUnlockValueUiStyle int32

DestinyDestinyUnlockValueUiStyle : If you're showing an unlock value in the UI, this is the format in which it should be shown. You'll have to build your own algorithms on the client side to determine how best to render these options.

type DestinyDestinyVendorFilter ¶

type DestinyDestinyVendorFilter int32

DestinyDestinyVendorFilter : Indicates the type of filter to apply to Vendor results.

type DestinyDestinyVendorInteractionRewardSelection ¶

type DestinyDestinyVendorInteractionRewardSelection int32

DestinyDestinyVendorInteractionRewardSelection : When a Vendor Interaction provides rewards, they'll either let you choose one or let you have all of them. This determines which it will be.

type DestinyDestinyVendorItemRefundPolicy ¶

type DestinyDestinyVendorItemRefundPolicy int32

DestinyDestinyVendorItemRefundPolicy : The action that happens when the user attempts to refund an item.

type DestinyDestinyVendorItemState ¶

type DestinyDestinyVendorItemState int32

DestinyDestinyVendorItemState : The possible states of Destiny Profile Records. IMPORTANT: Any given item can theoretically have many of these states simultaneously: as a result, this was altered to be a flags enumeration/bitmask for v3.2.0.

type DestinyDestinyVendorProgressionType ¶

type DestinyDestinyVendorProgressionType int32

DestinyDestinyVendorProgressionType : Describes the type of progression that a vendor has.

type DestinyDestinyVendorReplyType ¶

type DestinyDestinyVendorReplyType int32

DestinyDestinyVendorReplyType : This determines the type of reply that a Vendor will have during an Interaction.

type DestinyDyeReference ¶

type DestinyDyeReference struct {
	ChannelHash int32 `json:"channelHash,omitempty"`
	DyeHash     int32 `json:"dyeHash,omitempty"`
}

type DestinyEntitiesCharactersDestinyCharacterActivitiesComponent ¶

type DestinyEntitiesCharactersDestinyCharacterActivitiesComponent struct {
	// The last date that the user started playing an activity.
	DateActivityStarted time.Time `json:"dateActivityStarted,omitempty"`
	// The list of activities that the user can play.
	AvailableActivities []DestinyDestinyActivity `json:"availableActivities,omitempty"`
	// If the user is in an activity, this will be the hash of the Activity being played. Note that you must combine this info with currentActivityModeHash to get a real picture of what the user is doing right now. For instance, PVP \"Activities\" are just maps: it's the ActivityMode that determines what type of PVP game they're playing.
	CurrentActivityHash int32 `json:"currentActivityHash,omitempty"`
	// If the user is in an activity, this will be the hash of the activity mode being played. Combine with currentActivityHash to give a person a full picture of what they're doing right now.
	CurrentActivityModeHash int32 `json:"currentActivityModeHash,omitempty"`
	// And the current activity's most specific mode type, if it can be found.
	CurrentActivityModeType int32 `json:"currentActivityModeType,omitempty"`
	// If the user is in an activity, this will be the hashes of the DestinyActivityModeDefinition being played. Combine with currentActivityHash to give a person a full picture of what they're doing right now.
	CurrentActivityModeHashes []int32 `json:"currentActivityModeHashes,omitempty"`
	// All Activity Modes that apply to the current activity being played, in enum form.
	CurrentActivityModeTypes []int32 `json:"currentActivityModeTypes,omitempty"`
	// If the user is in a playlist, this is the hash identifier for the playlist that they chose.
	CurrentPlaylistActivityHash int32 `json:"currentPlaylistActivityHash,omitempty"`
	// This will have the activity hash of the last completed story/campaign mission, in case you care about that.
	LastCompletedStoryHash int32 `json:"lastCompletedStoryHash,omitempty"`
}

This component holds activity data for a character. It will tell you about the character's current activity status, as well as activities that are available to the user.

type DestinyEntitiesCharactersDestinyCharacterComponent ¶

type DestinyEntitiesCharactersDestinyCharacterComponent struct {
	// Every Destiny Profile has a membershipId. This is provided on the character as well for convenience.
	MembershipId int64 `json:"membershipId,omitempty"`
	// membershipType tells you the platform on which the character plays. Examine the BungieMembershipType enumeration for possible values.
	MembershipType int32 `json:"membershipType,omitempty"`
	// The unique identifier for the character.
	CharacterId int64 `json:"characterId,omitempty"`
	// The last date that the user played Destiny.
	DateLastPlayed time.Time `json:"dateLastPlayed,omitempty"`
	// If the user is currently playing, this is how long they've been playing.
	MinutesPlayedThisSession int64 `json:"minutesPlayedThisSession,omitempty"`
	// If this value is 525,600, then they played Destiny for a year. Or they're a very dedicated Rent fan. Note that this includes idle time, not just time spent actually in activities shooting things.
	MinutesPlayedTotal int64 `json:"minutesPlayedTotal,omitempty"`
	// The user's calculated \"Light Level\". Light level is an indicator of your power that mostly matters in the end game, once you've reached the maximum character level: it's a level that's dependent on the average Attack/Defense power of your items.
	Light int32 `json:"light,omitempty"`
	// Your character's stats, such as Agility, Resilience, etc... *not* historical stats.  You'll have to call a different endpoint for those.
	Stats map[string]int32 `json:"stats,omitempty"`
	// Use this hash to look up the character's DestinyRaceDefinition.
	RaceHash int32 `json:"raceHash,omitempty"`
	// Use this hash to look up the character's DestinyGenderDefinition.
	GenderHash int32 `json:"genderHash,omitempty"`
	// Use this hash to look up the character's DestinyClassDefinition.
	ClassHash int32 `json:"classHash,omitempty"`
	// Mostly for historical purposes at this point, this is an enumeration for the character's race.  It'll be preferable in the general case to look up the related definition: but for some people this was too convenient to remove.
	RaceType int32 `json:"raceType,omitempty"`
	// Mostly for historical purposes at this point, this is an enumeration for the character's class.  It'll be preferable in the general case to look up the related definition: but for some people this was too convenient to remove.
	ClassType int32 `json:"classType,omitempty"`
	// Mostly for historical purposes at this point, this is an enumeration for the character's Gender.  It'll be preferable in the general case to look up the related definition: but for some people this was too convenient to remove. And yeah, it's an enumeration and not a boolean. Fight me.
	GenderType int32 `json:"genderType,omitempty"`
	// A shortcut path to the user's currently equipped emblem image. If you're just showing summary info for a user, this is more convenient than examining their equipped emblem and looking up the definition.
	EmblemPath string `json:"emblemPath,omitempty"`
	// A shortcut path to the user's currently equipped emblem background image. If you're just showing summary info for a user, this is more convenient than examining their equipped emblem and looking up the definition.
	EmblemBackgroundPath string `json:"emblemBackgroundPath,omitempty"`
	// The hash of the currently equipped emblem for the user. Can be used to look up the DestinyInventoryItemDefinition.
	EmblemHash int32 `json:"emblemHash,omitempty"`
	// A shortcut for getting the background color of the user's currently equipped emblem without having to do a DestinyInventoryItemDefinition lookup.
	EmblemColor *AllOfDestinyEntitiesCharactersDestinyCharacterComponentEmblemColor `json:"emblemColor,omitempty"`
	// The progression that indicates your character's level. Not their light level, but their character level: you know, the thing you max out a couple hours in and then ignore for the sake of light level.
	LevelProgression *AllOfDestinyEntitiesCharactersDestinyCharacterComponentLevelProgression `json:"levelProgression,omitempty"`
	// The \"base\" level of your character, not accounting for any light level.
	BaseCharacterLevel int32 `json:"baseCharacterLevel,omitempty"`
	// A number between 0 and 100, indicating the whole and fractional % remaining to get to the next character level.
	PercentToNextLevel float32 `json:"percentToNextLevel,omitempty"`
	// If this Character has a title assigned to it, this is the identifier of the DestinyRecordDefinition that has that title information.
	TitleRecordHash int32 `json:"titleRecordHash,omitempty"`
}

This component contains base properties of the character. You'll probably want to always request this component, but hey you do you.

type DestinyEntitiesCharactersDestinyCharacterProgressionComponent ¶

type DestinyEntitiesCharactersDestinyCharacterProgressionComponent struct {
	// A Dictionary of all known progressions for the Character, keyed by the Progression's hash.  Not all progressions have user-facing data, but those who do will have that data contained in the DestinyProgressionDefinition.
	Progressions map[string]DestinyDestinyProgression `json:"progressions,omitempty"`
	// A dictionary of all known Factions, keyed by the Faction's hash. It contains data about this character's status with the faction.
	Factions map[string]DestinyProgressionDestinyFactionProgression `json:"factions,omitempty"`
	// Milestones are related to the simple progressions shown in the game, but return additional and hopefully helpful information for users about the specifics of the Milestone's status.
	Milestones map[string]DestinyMilestonesDestinyMilestone `json:"milestones,omitempty"`
	// If the user has any active quests, the quests' statuses will be returned here.   Note that quests have been largely supplanted by Milestones, but that doesn't mean that they won't make a comeback independent of milestones at some point.   (Fun fact: quests came back as I feared they would, but we never looped back to populate this... I'm going to put that in the backlog.)
	Quests []DestinyQuestsDestinyQuestStatus `json:"quests,omitempty"`
	// Sometimes, you have items in your inventory that don't have instances, but still have Objective information. This provides you that objective information for uninstanced items.   This dictionary is keyed by the item's hash: which you can use to look up the name and description for the overall task(s) implied by the objective. The value is the list of objectives for this item, and their statuses.
	UninstancedItemObjectives map[string][]DestinyQuestsDestinyObjectiveProgress `json:"uninstancedItemObjectives,omitempty"`
	// Sometimes, you have items in your inventory that don't have instances, but still have perks (for example: Trials passage cards). This gives you the perk information for uninstanced items.  This dictionary is keyed by item hash, which you can use to look up the corresponding item definition. The value is the list of perks states for the item.
	UninstancedItemPerks map[string]DestinyEntitiesItemsDestinyItemPerksComponent `json:"uninstancedItemPerks,omitempty"`
	// The set of checklists that can be examined for this specific character, keyed by the hash identifier of the Checklist (DestinyChecklistDefinition)  For each checklist returned, its value is itself a Dictionary keyed by the checklist's hash identifier with the value being a boolean indicating if it's been discovered yet.
	Checklists map[string]map[string]bool `json:"checklists,omitempty"`
	// Data related to your progress on the current season's artifact that can vary per character.
	SeasonalArtifact *AllOfDestinyEntitiesCharactersDestinyCharacterProgressionComponentSeasonalArtifact `json:"seasonalArtifact,omitempty"`
}

This component returns anything that could be considered \"Progression\" on a user: data where the user is gaining levels, reputation, completions, rewards, etc...

type DestinyEntitiesCharactersDestinyCharacterRenderComponent ¶

type DestinyEntitiesCharactersDestinyCharacterRenderComponent struct {
	// Custom dyes, calculated by iterating over the character's equipped items. Useful for pre-fetching all of the dye data needed from our server.
	CustomDyes []DestinyDyeReference `json:"customDyes,omitempty"`
	// This is actually something that Spasm.js *doesn't* do right now, and that we don't return assets for yet. This is the data about what character customization options you picked. You can combine this with DestinyCharacterCustomizationOptionDefinition to show some cool info, and hopefully someday to actually render a user's face in 3D. We'll see if we ever end up with time for that.
	Customization *AllOfDestinyEntitiesCharactersDestinyCharacterRenderComponentCustomization `json:"customization,omitempty"`
	// A minimal view of:  - Equipped items  - The rendering-related custom options on those equipped items  Combined, that should be enough to render all of the items on the equipped character.
	PeerView *AllOfDestinyEntitiesCharactersDestinyCharacterRenderComponentPeerView `json:"peerView,omitempty"`
}

Only really useful if you're attempting to render the character's current appearance in 3D, this returns a bare minimum of information, pre-aggregated, that you'll need to perform that rendering. Note that you need to combine this with other 3D assets and data from our servers. Examine the Javascript returned by https://bungie.net/sharedbundle/spasm to see how we use this data, but be warned: the rabbit hole goes pretty deep.

type DestinyEntitiesInventoryDestinyInventoryComponent ¶

type DestinyEntitiesInventoryDestinyInventoryComponent struct {
	// The items in this inventory. If you care to bucket them, use the item's bucketHash property to group them.
	Items []DestinyEntitiesItemsDestinyItemComponent `json:"items,omitempty"`
}

A list of minimal information for items in an inventory: be it a character's inventory, or a Profile's inventory. (Note that the Vault is a collection of inventory buckets in the Profile's inventory) Inventory Items returned here are in a flat list, but importantly they have a bucketHash property that indicates the specific inventory bucket that is holding them. These buckets constitute things like the separate sections of the Vault, the user's inventory slots, etc. See DestinyInventoryBucketDefinition for more info.

type DestinyEntitiesItemsDestinyItemComponent ¶

type DestinyEntitiesItemsDestinyItemComponent struct {
	// The identifier for the item's definition, which is where most of the useful static information for the item can be found.
	ItemHash int32 `json:"itemHash,omitempty"`
	// If the item is instanced, it will have an instance ID. Lack of an instance ID implies that the item has no distinct local qualities aside from stack size.
	ItemInstanceId int64 `json:"itemInstanceId,omitempty"`
	// The quantity of the item in this stack. Note that Instanced items cannot stack. If an instanced item, this value will always be 1 (as the stack has exactly one item in it)
	Quantity int32 `json:"quantity,omitempty"`
	// If the item is bound to a location, it will be specified in this enum.
	BindStatus int32 `json:"bindStatus,omitempty"`
	// An easy reference for where the item is located. Redundant if you got the item from an Inventory, but useful when making detail calls on specific items.
	Location int32 `json:"location,omitempty"`
	// The hash identifier for the specific inventory bucket in which the item is located.
	BucketHash int32 `json:"bucketHash,omitempty"`
	// If there is a known error state that would cause this item to not be transferable, this Flags enum will indicate all of those error states. Otherwise, it will be 0 (CanTransfer).
	TransferStatus int32 `json:"transferStatus,omitempty"`
	// If the item can be locked, this will indicate that state.
	Lockable bool `json:"lockable,omitempty"`
	// A flags enumeration indicating the transient/custom states of the item that affect how it is rendered: whether it's tracked or locked for example, or whether it has a masterwork plug inserted.
	State int32 `json:"state,omitempty"`
	// If populated, this is the hash of the item whose icon (and other secondary styles, but *not* the human readable strings) should override whatever icons/styles are on the item being sold.  If you don't do this, certain items whose styles are being overridden by socketed items - such as the \"Recycle Shader\" item - would show whatever their default icon/style is, and it wouldn't be pretty or look accurate.
	OverrideStyleItemHash int32 `json:"overrideStyleItemHash,omitempty"`
	// If the item can expire, this is the date at which it will/did expire.
	ExpirationDate time.Time `json:"expirationDate,omitempty"`
	// If this is true, the object is actually a \"wrapper\" of the object it's representing. This means that it's not the actual item itself, but rather an item that must be \"opened\" in game before you have and can use the item.   Wrappers are an evolution of \"bundles\", which give an easy way to let you preview the contents of what you purchased while still letting you get a refund before you \"open\" it.
	IsWrapper bool `json:"isWrapper,omitempty"`
	// If this is populated, it is a list of indexes into DestinyInventoryItemDefinition.tooltipNotifications for any special tooltip messages that need to be shown for this item.
	TooltipNotificationIndexes []int32 `json:"tooltipNotificationIndexes,omitempty"`
	// The identifier for the currently-selected metric definition, to be displayed on the emblem nameplate.
	MetricHash int32 `json:"metricHash,omitempty"`
	// The objective progress for the currently-selected metric definition, to be displayed on the emblem nameplate.
	MetricObjective *AllOfDestinyEntitiesItemsDestinyItemComponentMetricObjective `json:"metricObjective,omitempty"`
	// The version of this item, used to index into the versions list in the item definition quality block.
	VersionNumber int32 `json:"versionNumber,omitempty"`
	// If available, a list that describes which item values (rewards) should be shown (true) or hidden (false).
	ItemValueVisibility []bool `json:"itemValueVisibility,omitempty"`
}

The base item component, filled with properties that are generally useful to know in any item request or that don't feel worthwhile to put in their own component.

type DestinyEntitiesItemsDestinyItemInstanceComponent ¶

type DestinyEntitiesItemsDestinyItemInstanceComponent struct {
	// If the item has a damage type, this is the item's current damage type.
	DamageType int32 `json:"damageType,omitempty"`
	// The current damage type's hash, so you can look up localized info and icons for it.
	DamageTypeHash int32 `json:"damageTypeHash,omitempty"`
	// The item stat that we consider to be \"primary\" for the item. For instance, this would be \"Attack\" for Weapons or \"Defense\" for armor.
	PrimaryStat *AllOfDestinyEntitiesItemsDestinyItemInstanceComponentPrimaryStat `json:"primaryStat,omitempty"`
	// The Item's \"Level\" has the most significant bearing on its stats, such as Light and Power.
	ItemLevel int32 `json:"itemLevel,omitempty"`
	// The \"Quality\" of the item has a lesser - but still impactful - bearing on stats like Light and Power.
	Quality int32 `json:"quality,omitempty"`
	// Is the item currently equipped on the given character?
	IsEquipped bool `json:"isEquipped,omitempty"`
	// If this is an equippable item, you can check it here. There are permanent as well as transitory reasons why an item might not be able to be equipped: check cannotEquipReason for details.
	CanEquip bool `json:"canEquip,omitempty"`
	// If the item cannot be equipped until you reach a certain level, that level will be reflected here.
	EquipRequiredLevel int32 `json:"equipRequiredLevel,omitempty"`
	// Sometimes, there are limitations to equipping that are represented by character-level flags called \"unlocks\".  This is a list of flags that they need in order to equip the item that the character has not met. Use these to look up the descriptions to show in your UI by looking up the relevant DestinyUnlockDefinitions for the hashes.
	UnlockHashesRequiredToEquip []int32 `json:"unlockHashesRequiredToEquip,omitempty"`
	// If you cannot equip the item, this is a flags enum that enumerates all of the reasons why you couldn't equip the item. You may need to refine your UI further by using unlockHashesRequiredToEquip and equipRequiredLevel.
	CannotEquipReason int32 `json:"cannotEquipReason,omitempty"`
	// If populated, this item has a breaker type corresponding to the given value. See DestinyBreakerTypeDefinition for more details.
	BreakerType int32 `json:"breakerType,omitempty"`
	// If populated, this is the hash identifier for the item's breaker type. See DestinyBreakerTypeDefinition for more details.
	BreakerTypeHash int32 `json:"breakerTypeHash,omitempty"`
	// IF populated, this item supports Energy mechanics (i.e. Armor 2.0), and these are the current details of its energy type and available capacity to spend energy points.
	Energy *AllOfDestinyEntitiesItemsDestinyItemInstanceComponentEnergy `json:"energy,omitempty"`
}

If an item is \"instanced\", this will contain information about the item's instance that doesn't fit easily into other components. One might say this is the \"essential\" instance data for the item. Items are instanced if they require information or state that can vary. For instance, weapons are Instanced: they are given a unique identifier, uniquely generated stats, and can have their properties altered. Non-instanced items have none of these things: for instance, Glimmer has no unique properties aside from how much of it you own. You can tell from an item's definition whether it will be instanced or not by looking at the DestinyInventoryItemDefinition's definition.inventory.isInstanceItem property.

type DestinyEntitiesItemsDestinyItemInstanceEnergy ¶

type DestinyEntitiesItemsDestinyItemInstanceEnergy struct {
	// The type of energy for this item. Plugs that require Energy can only be inserted if they have the \"Any\" Energy Type or the matching energy type of this item. This is a reference to the DestinyEnergyTypeDefinition for the energy type, where you can find extended info about it.
	EnergyTypeHash int32 `json:"energyTypeHash,omitempty"`
	// This is the enum version of the Energy Type value, for convenience.
	EnergyType int32 `json:"energyType,omitempty"`
	// The total capacity of Energy that the item currently has, regardless of if it is currently being used.
	EnergyCapacity int32 `json:"energyCapacity,omitempty"`
	// The amount of Energy currently in use by inserted plugs.
	EnergyUsed int32 `json:"energyUsed,omitempty"`
	// The amount of energy still available for inserting new plugs.
	EnergyUnused int32 `json:"energyUnused,omitempty"`
}

type DestinyEntitiesItemsDestinyItemObjectivesComponent ¶

type DestinyEntitiesItemsDestinyItemObjectivesComponent struct {
	// If the item has a hard association with objectives, your progress on them will be defined here.   Objectives are our standard way to describe a series of tasks that have to be completed for a reward.
	Objectives []DestinyQuestsDestinyObjectiveProgress `json:"objectives,omitempty"`
	// I may regret naming it this way - but this represents when an item has an objective that doesn't serve a beneficial purpose, but rather is used for \"flavor\" or additional information. For instance, when Emblems track specific stats, those stats are represented as Objectives on the item.
	FlavorObjective *AllOfDestinyEntitiesItemsDestinyItemObjectivesComponentFlavorObjective `json:"flavorObjective,omitempty"`
	// If we have any information on when these objectives were completed, this will be the date of that completion. This won't be on many items, but could be interesting for some items that do store this information.
	DateCompleted time.Time `json:"dateCompleted,omitempty"`
}

Items can have objectives and progression. When you request this block, you will obtain information about any Objectives and progression tied to this item.

type DestinyEntitiesItemsDestinyItemPerksComponent ¶

type DestinyEntitiesItemsDestinyItemPerksComponent struct {
	// The list of perks to display in an item tooltip - and whether or not they have been activated.
	Perks []DestinyPerksDestinyPerkReference `json:"perks,omitempty"`
}

Instanced items can have perks: benefits that the item bestows. These are related to DestinySandboxPerkDefinition, and sometimes - but not always - have human readable info. When they do, they are the icons and text that you see in an item's tooltip. Talent Grids, Sockets, and the item itself can apply Perks, which are then summarized here for your convenience.

type DestinyEntitiesItemsDestinyItemRenderComponent ¶

type DestinyEntitiesItemsDestinyItemRenderComponent struct {
	// If you should use custom dyes on this item, it will be indicated here.
	UseCustomDyes bool `json:"useCustomDyes,omitempty"`
	// A dictionary for rendering gear components, with:  key = Art Arrangement Region Index  value = The chosen Arrangement Index for the Region, based on the value of a stat on the item used for making the choice.
	ArtRegions map[string]int32 `json:"artRegions,omitempty"`
}

Many items can be rendered in 3D. When you request this block, you will obtain the custom data needed to render this specific instance of the item.

type DestinyEntitiesItemsDestinyItemSocketState ¶

type DestinyEntitiesItemsDestinyItemSocketState struct {
	// The currently active plug, if any.  Note that, because all plugs are statically defined, its effect on stats and perks can be statically determined using the plug item's definition. The stats and perks can be taken at face value on the plug item as the stats and perks it will provide to the user/item.
	PlugHash int32 `json:"plugHash,omitempty"`
	// Even if a plug is inserted, it doesn't mean it's enabled.  This flag indicates whether the plug is active and providing its benefits.
	IsEnabled bool `json:"isEnabled,omitempty"`
	// A plug may theoretically provide benefits but not be visible - for instance, some older items use a plug's damage type perk to modify their own damage type. These, though they are not visible, still affect the item. This field indicates that state.  An invisible plug, while it provides benefits if it is Enabled, cannot be directly modified by the user.
	IsVisible bool `json:"isVisible,omitempty"`
	// If a plug is inserted but not enabled, this will be populated with indexes into the plug item definition's plug.enabledRules property, so that you can show the reasons why it is not enabled.
	EnableFailIndexes []int32 `json:"enableFailIndexes,omitempty"`
}

The status of a given item's socket. (which plug is inserted, if any: whether it is enabled, what \"reusable\" plugs can be inserted, etc...) If I had it to do over, this would probably have a DestinyItemPlug representing the inserted item instead of most of these properties. :shrug:

type DestinyEntitiesItemsDestinyItemSocketsComponent ¶

type DestinyEntitiesItemsDestinyItemSocketsComponent struct {
	// The list of all sockets on the item, and their status information.
	Sockets []DestinyEntitiesItemsDestinyItemSocketState `json:"sockets,omitempty"`
}

Instanced items can have sockets, which are slots on the item where plugs can be inserted. Sockets are a bit complex: be sure to examine the documentation on the DestinyInventoryItemDefinition's \"socket\" block and elsewhere on these objects for more details.

type DestinyEntitiesItemsDestinyItemStatsComponent ¶

type DestinyEntitiesItemsDestinyItemStatsComponent struct {
	// If the item has stats that it provides (damage, defense, etc...), it will be given here.
	Stats map[string]DestinyDestinyStat `json:"stats,omitempty"`
}

If you want the stats on an item's instanced data, get this component. These are stats like Attack, Defense etc... and *not* historical stats. Note that some stats have additional computation in-game at runtime - for instance, Magazine Size - and thus these stats might not be 100% accurate compared to what you see in-game for some stats. I know, it sucks. I hate it too.

type DestinyEntitiesItemsDestinyItemTalentGridComponent ¶

type DestinyEntitiesItemsDestinyItemTalentGridComponent struct {
	// Most items don't have useful talent grids anymore, but Builds in particular still do.  You can use this hash to lookup the DestinyTalentGridDefinition attached to this item, which will be crucial for understanding the node values on the item.
	TalentGridHash int32 `json:"talentGridHash,omitempty"`
	// Detailed information about the individual nodes in the talent grid.  A node represents a single visual \"pip\" in the talent grid or Build detail view, though each node may have multiple \"steps\" which indicate the actual bonuses and visual representation of that node.
	Nodes []DestinyDestinyTalentNode `json:"nodes,omitempty"`
	// Indicates whether the talent grid on this item is completed, and thus whether it should have a gold border around it.  Only will be true if the item actually *has* a talent grid, and only then if it is completed (i.e. every exclusive set has an activated node, and every non-exclusive set node has been activated)
	IsGridComplete bool `json:"isGridComplete,omitempty"`
	// If the item has a progression, it will be detailed here. A progression means that the item can gain experience. Thresholds of experience are what determines whether and when a talent node can be activated.
	GridProgression *AllOfDestinyEntitiesItemsDestinyItemTalentGridComponentGridProgression `json:"gridProgression,omitempty"`
}

Well, we're here in Destiny 2, and Talent Grids are unfortunately still around. The good news is that they're pretty much only being used for certain base information on items and for Builds/Subclasses. The bad news is that they still suck. If you really want this information, grab this component. An important note is that talent grids are defined as such: A Grid has 1:M Nodes, which has 1:M Steps. Any given node can only have a single step active at one time, which represents the actual visual contents and effects of the Node (for instance, if you see a \"Super Cool Bonus\" node, the actual icon and text for the node is coming from the current Step of that node). Nodes can be grouped into exclusivity sets *and* as of D2, exclusivity groups (which are collections of exclusivity sets that affect each other). See DestinyTalentGridDefinition for more information. Brace yourself, the water's cold out there in the deep end.

type DestinyEntitiesProfilesDestinyProfileComponent ¶

type DestinyEntitiesProfilesDestinyProfileComponent struct {
	// If you need to render the Profile (their platform name, icon, etc...) somewhere, this property contains that information.
	UserInfo *AllOfDestinyEntitiesProfilesDestinyProfileComponentUserInfo `json:"userInfo,omitempty"`
	// The last time the user played with any character on this Profile.
	DateLastPlayed time.Time `json:"dateLastPlayed,omitempty"`
	// If you want to know what expansions they own, this will contain that data.   IMPORTANT: This field may not return the data you're interested in for Cross-Saved users. It returns the last ownership data we saw for this account - which is to say, what they've purchased on the platform on which they last played, which now could be a different platform.   If you don't care about per-platform ownership and only care about whatever platform it seems they are playing on most recently, then this should be \"good enough.\" Otherwise, this should be considered deprecated. We do not have a good alternative to provide at this time with platform specific ownership data for DLC.
	VersionsOwned int32 `json:"versionsOwned,omitempty"`
	// A list of the character IDs, for further querying on your part.
	CharacterIds []int64 `json:"characterIds,omitempty"`
	// A list of seasons that this profile owns. Unlike versionsOwned, these stay with the profile across Platforms, and thus will be valid.   It turns out that Stadia Pro subscriptions will give access to seasons but only while playing on Stadia and with an active subscription. So some users (users who have Stadia Pro but choose to play on some other platform) won't see these as available: it will be whatever seasons are available for the platform on which they last played.
	SeasonHashes []int32 `json:"seasonHashes,omitempty"`
	// A list of hashes for event cards that a profile owns. Unlike most values in versionsOwned, these stay with the profile across all platforms.
	EventCardHashesOwned []int32 `json:"eventCardHashesOwned,omitempty"`
	// If populated, this is a reference to the season that is currently active.
	CurrentSeasonHash int32 `json:"currentSeasonHash,omitempty"`
	// If populated, this is the reward power cap for the current season.
	CurrentSeasonRewardPowerCap int32 `json:"currentSeasonRewardPowerCap,omitempty"`
	// If populated, this is a reference to the event card that is currently active.
	ActiveEventCardHash int32 `json:"activeEventCardHash,omitempty"`
	// The 'current' Guardian Rank value, which starts at rank 1.
	CurrentGuardianRank int32 `json:"currentGuardianRank,omitempty"`
	// The 'lifetime highest' Guardian Rank value, which starts at rank 1.
	LifetimeHighestGuardianRank int32 `json:"lifetimeHighestGuardianRank,omitempty"`
}

The most essential summary information about a Profile (in Destiny 1, we called these \"Accounts\").

type DestinyEntitiesProfilesDestinyVendorReceiptsComponent ¶

type DestinyEntitiesProfilesDestinyVendorReceiptsComponent struct {
	// The receipts for refundable purchases made at a vendor.
	Receipts []DestinyVendorsDestinyVendorReceipt `json:"receipts,omitempty"`
}

For now, this isn't used for much: it's a record of the recent refundable purchases that the user has made. In the future, it could be used for providing refunds/buyback via the API. Wouldn't that be fun?

type DestinyEntitiesVendorsDestinyVendorCategoriesComponent ¶

type DestinyEntitiesVendorsDestinyVendorCategoriesComponent struct {
	// The list of categories for items that the vendor sells, in rendering order.  These categories each point to a \"display category\" in the displayCategories property of the DestinyVendorDefinition, as opposed to the other categories.
	Categories []DestinyEntitiesVendorsDestinyVendorCategory `json:"categories,omitempty"`
}

A vendor can have many categories of items that they sell. This component will return the category information for available items, as well as the index into those items in the user's sale item list. Note that, since both the category and items are indexes, this data is Content Version dependent. Be sure to check that your content is up to date before using this data. This is an unfortunate, but permanent, limitation of Vendor data.

type DestinyEntitiesVendorsDestinyVendorCategory ¶

type DestinyEntitiesVendorsDestinyVendorCategory struct {
	// An index into the DestinyVendorDefinition.displayCategories property, so you can grab the display data for this category.
	DisplayCategoryIndex int32 `json:"displayCategoryIndex,omitempty"`
	// An ordered list of indexes into items being sold in this category (DestinyVendorDefinition.itemList) which will contain more information about the items being sold themselves. Can also be used to index into DestinyVendorSaleItemComponent data, if you asked for that data to be returned.
	ItemIndexes []int32 `json:"itemIndexes,omitempty"`
}

Information about the category and items currently sold in that category.

type DestinyEntitiesVendorsDestinyVendorComponent ¶

type DestinyEntitiesVendorsDestinyVendorComponent struct {
	// If True, you can purchase from the Vendor.
	CanPurchase bool `json:"canPurchase,omitempty"`
	// If the Vendor has a related Reputation, this is the Progression data that represents the character's Reputation level with this Vendor.
	Progression *AllOfDestinyEntitiesVendorsDestinyVendorComponentProgression `json:"progression,omitempty"`
	// An index into the vendor definition's \"locations\" property array, indicating which location they are at currently. If -1, then the vendor has no known location (and you may choose not to show them in your UI as a result. I mean, it's your bag honey)
	VendorLocationIndex int32 `json:"vendorLocationIndex,omitempty"`
	// If this vendor has a seasonal rank, this will be the calculated value of that rank. How nice is that? I mean, that's pretty sweeet. It's a whole 32 bit integer.
	SeasonalRank int32 `json:"seasonalRank,omitempty"`
	// The unique identifier for the vendor. Use it to look up their DestinyVendorDefinition.
	VendorHash int32 `json:"vendorHash,omitempty"`
	// The date when this vendor's inventory will next rotate/refresh.  Note that this is distinct from the date ranges that the vendor is visible/available in-game: this field indicates the specific time when the vendor's available items refresh and rotate, regardless of whether the vendor is actually available at that time. Unfortunately, these two values may be (and are, for the case of important vendors like Xur) different.  Issue https://github.com/Bungie-net/api/issues/353 is tracking a fix to start providing visibility date ranges where possible in addition to this refresh date, so that all important dates for vendors are available for use.
	NextRefreshDate time.Time `json:"nextRefreshDate,omitempty"`
	// If True, the Vendor is currently accessible.   If False, they may not actually be visible in the world at the moment.
	Enabled bool `json:"enabled,omitempty"`
}

This component contains essential/summary information about the vendor.

type DestinyEntitiesVendorsDestinyVendorSaleItemComponent ¶

type DestinyEntitiesVendorsDestinyVendorSaleItemComponent struct {
	// A flag indicating whether the requesting character can buy the item, and if not the reasons why the character can't buy it.
	SaleStatus int32 `json:"saleStatus,omitempty"`
	// If you can't buy the item due to a complex character state, these will be hashes for DestinyUnlockDefinitions that you can check to see messages regarding the failure (if the unlocks have human readable information: it is not guaranteed that Unlocks will have human readable strings, and your application will have to handle that)  Prefer using failureIndexes instead. These are provided for informational purposes, but have largely been supplanted by failureIndexes.
	RequiredUnlocks []int32 `json:"requiredUnlocks,omitempty"`
	// If any complex unlock states are checked in determining purchasability, these will be returned here along with the status of the unlock check.  Prefer using failureIndexes instead. These are provided for informational purposes, but have largely been supplanted by failureIndexes.
	UnlockStatuses []DestinyDestinyUnlockStatus `json:"unlockStatuses,omitempty"`
	// Indexes in to the \"failureStrings\" lookup table in DestinyVendorDefinition for the given Vendor. Gives some more reliable failure information for why you can't purchase an item.  It is preferred to use these over requiredUnlocks and unlockStatuses: the latter are provided mostly in case someone can do something interesting with it that I didn't anticipate.
	FailureIndexes []int32 `json:"failureIndexes,omitempty"`
	// A flags enumeration value representing the current state of any \"state modifiers\" on the item being sold. These are meant to correspond with some sort of visual indicator as to the augmentation: for instance, if an item is on sale or if you already own the item in question.  Determining how you want to represent these in your own app (or if you even want to) is an exercise left for the reader.
	Augments int32 `json:"augments,omitempty"`
	// If available, a list that describes which item values (rewards) should be shown (true) or hidden (false).
	ItemValueVisibility []bool `json:"itemValueVisibility,omitempty"`
	// The index into the DestinyVendorDefinition.itemList property. Note that this means Vendor data *is* Content Version dependent: make sure you have the latest content before you use Vendor data, or these indexes may mismatch.   Most systems avoid this problem, but Vendors is one area where we are unable to reasonably avoid content dependency at the moment.
	VendorItemIndex int32 `json:"vendorItemIndex,omitempty"`
	// The hash of the item being sold, as a quick shortcut for looking up the DestinyInventoryItemDefinition of the sale item.
	ItemHash int32 `json:"itemHash,omitempty"`
	// If populated, this is the hash of the item whose icon (and other secondary styles, but *not* the human readable strings) should override whatever icons/styles are on the item being sold.  If you don't do this, certain items whose styles are being overridden by socketed items - such as the \"Recycle Shader\" item - would show whatever their default icon/style is, and it wouldn't be pretty or look accurate.
	OverrideStyleItemHash int32 `json:"overrideStyleItemHash,omitempty"`
	// How much of the item you'll be getting.
	Quantity int32 `json:"quantity,omitempty"`
	// A summary of the current costs of the item.
	Costs []DestinyDestinyItemQuantity `json:"costs,omitempty"`
	// If this item has its own custom date where it may be removed from the Vendor's rotation, this is that date.  Note that there's not actually any guarantee that it will go away: it could be chosen again and end up still being in the Vendor's sale items! But this is the next date where that test will occur, and is also the date that the game shows for availability on things like Bounties being sold. So it's the best we can give.
	OverrideNextRefreshDate time.Time `json:"overrideNextRefreshDate,omitempty"`
	// If true, this item can be purchased through the Bungie.net API.
	ApiPurchasable bool `json:"apiPurchasable,omitempty"`
}

Request this component if you want the details about an item being sold in relation to the character making the request: whether the character can buy it, whether they can afford it, and other data related to purchasing the item. Note that if you want instance, stats, etc... data for the item, you'll have to request additional components such as ItemInstances, ItemPerks etc... and acquire them from the DestinyVendorResponse's \"items\" property.

type DestinyEquipFailureReason ¶

type DestinyEquipFailureReason int32

DestinyEquipFailureReason : The reasons why an item cannot be equipped, if any. Many flags can be set, or \"None\" if

type DestinyEquippingItemBlockAttributes ¶

type DestinyEquippingItemBlockAttributes int32

type DestinyHistoricalStatsDefinitionsDestinyHistoricalStatsDefinition ¶

type DestinyHistoricalStatsDefinitionsDestinyHistoricalStatsDefinition struct {
	// Unique programmer friendly ID for this stat
	StatId string `json:"statId,omitempty"`
	// Statistic group
	Group int32 `json:"group,omitempty"`
	// Time periods the statistic covers
	PeriodTypes []int32 `json:"periodTypes,omitempty"`
	// Game modes where this statistic can be reported.
	Modes []int32 `json:"modes,omitempty"`
	// Category for the stat.
	Category int32 `json:"category,omitempty"`
	// Display name
	StatName string `json:"statName,omitempty"`
	// Display name abbreviated
	StatNameAbbr string `json:"statNameAbbr,omitempty"`
	// Description of a stat if applicable.
	StatDescription string `json:"statDescription,omitempty"`
	// Unit, if any, for the statistic
	UnitType int32 `json:"unitType,omitempty"`
	// Optional URI to an icon for the statistic
	IconImage string `json:"iconImage,omitempty"`
	// Optional icon for the statistic
	MergeMethod int32 `json:"mergeMethod,omitempty"`
	// Localized Unit Name for the stat.
	UnitLabel string `json:"unitLabel,omitempty"`
	// Weight assigned to this stat indicating its relative impressiveness.
	Weight int32 `json:"weight,omitempty"`
	// The tier associated with this medal - be it implicitly or explicitly.
	MedalTierHash int32 `json:"medalTierHash,omitempty"`
}

type DestinyHistoricalStatsDefinitionsDestinyStatsCategoryType ¶

type DestinyHistoricalStatsDefinitionsDestinyStatsCategoryType int32

type DestinyHistoricalStatsDefinitionsDestinyStatsGroupType ¶

type DestinyHistoricalStatsDefinitionsDestinyStatsGroupType int32

DestinyHistoricalStatsDefinitionsDestinyStatsGroupType : If the enum value is > 100, it is a \"special\" group that cannot be queried for directly (special cases apply to when they are returned, and are not relevant in general cases)

type DestinyHistoricalStatsDefinitionsDestinyStatsMergeMethod ¶

type DestinyHistoricalStatsDefinitionsDestinyStatsMergeMethod int32

type DestinyHistoricalStatsDefinitionsPeriodType ¶

type DestinyHistoricalStatsDefinitionsPeriodType int32

type DestinyHistoricalStatsDefinitionsUnitType ¶

type DestinyHistoricalStatsDefinitionsUnitType int32

type DestinyHistoricalStatsDestinyActivityHistoryResults ¶

type DestinyHistoricalStatsDestinyActivityHistoryResults struct {
	// List of activities, the most recent activity first.
	Activities []DestinyHistoricalStatsDestinyHistoricalStatsPeriodGroup `json:"activities,omitempty"`
}

type DestinyHistoricalStatsDestinyAggregateActivityResults ¶

type DestinyHistoricalStatsDestinyAggregateActivityResults struct {
	// List of all activities the player has participated in.
	Activities []DestinyHistoricalStatsDestinyAggregateActivityStats `json:"activities,omitempty"`
}

type DestinyHistoricalStatsDestinyAggregateActivityStats ¶

type DestinyHistoricalStatsDestinyAggregateActivityStats struct {
	// Hash ID that can be looked up in the DestinyActivityTable.
	ActivityHash int32 `json:"activityHash,omitempty"`
	// Collection of stats for the player in this activity.
	Values map[string]DestinyHistoricalStatsDestinyHistoricalStatsValue `json:"values,omitempty"`
}

type DestinyHistoricalStatsDestinyClanAggregateStat ¶

type DestinyHistoricalStatsDestinyClanAggregateStat struct {
	// The id of the mode of stats (allPvp, allPvE, etc)
	Mode int32 `json:"mode,omitempty"`
	// The id of the stat
	StatId string `json:"statId,omitempty"`
	// Value of the stat for this player
	Value *AllOfDestinyHistoricalStatsDestinyClanAggregateStatValue `json:"value,omitempty"`
}

type DestinyHistoricalStatsDestinyHistoricalStatsAccountResult ¶

type DestinyHistoricalStatsDestinyHistoricalStatsAccountResult struct {
	MergedDeletedCharacters *DestinyHistoricalStatsDestinyHistoricalStatsWithMerged    `json:"mergedDeletedCharacters,omitempty"`
	MergedAllCharacters     *DestinyHistoricalStatsDestinyHistoricalStatsWithMerged    `json:"mergedAllCharacters,omitempty"`
	Characters              []DestinyHistoricalStatsDestinyHistoricalStatsPerCharacter `json:"characters,omitempty"`
}

type DestinyHistoricalStatsDestinyHistoricalStatsActivity ¶

type DestinyHistoricalStatsDestinyHistoricalStatsActivity struct {
	// The unique hash identifier of the DestinyActivityDefinition that was played. If I had this to do over, it'd be named activityHash. Too late now.
	ReferenceId int32 `json:"referenceId,omitempty"`
	// The unique hash identifier of the DestinyActivityDefinition that was played.
	DirectorActivityHash int32 `json:"directorActivityHash,omitempty"`
	// The unique identifier for this *specific* match that was played.  This value can be used to get additional data about this activity such as who else was playing via the GetPostGameCarnageReport endpoint.
	InstanceId int64 `json:"instanceId,omitempty"`
	// Indicates the most specific game mode of the activity that we could find.
	Mode int32 `json:"mode,omitempty"`
	// The list of all Activity Modes to which this activity applies, including aggregates. This will let you see, for example, whether the activity was both Clash and part of the Trials of the Nine event.
	Modes []int32 `json:"modes,omitempty"`
	// Whether or not the match was a private match.
	IsPrivate bool `json:"isPrivate,omitempty"`
	// The Membership Type indicating the platform on which this match was played.
	MembershipType int32 `json:"membershipType,omitempty"`
}

Summary information about the activity that was played.

type DestinyHistoricalStatsDestinyHistoricalStatsByPeriod ¶

type DestinyHistoricalStatsDestinyHistoricalStatsByPeriod struct {
	AllTime      map[string]DestinyHistoricalStatsDestinyHistoricalStatsValue `json:"allTime,omitempty"`
	AllTimeTier1 map[string]DestinyHistoricalStatsDestinyHistoricalStatsValue `json:"allTimeTier1,omitempty"`
	AllTimeTier2 map[string]DestinyHistoricalStatsDestinyHistoricalStatsValue `json:"allTimeTier2,omitempty"`
	AllTimeTier3 map[string]DestinyHistoricalStatsDestinyHistoricalStatsValue `json:"allTimeTier3,omitempty"`
	Daily        []DestinyHistoricalStatsDestinyHistoricalStatsPeriodGroup    `json:"daily,omitempty"`
	Monthly      []DestinyHistoricalStatsDestinyHistoricalStatsPeriodGroup    `json:"monthly,omitempty"`
}

type DestinyHistoricalStatsDestinyHistoricalStatsPerCharacter ¶

type DestinyHistoricalStatsDestinyHistoricalStatsPerCharacter struct {
	CharacterId int64                                                           `json:"characterId,omitempty"`
	Deleted     bool                                                            `json:"deleted,omitempty"`
	Results     map[string]DestinyHistoricalStatsDestinyHistoricalStatsByPeriod `json:"results,omitempty"`
	Merged      *DestinyHistoricalStatsDestinyHistoricalStatsByPeriod           `json:"merged,omitempty"`
}

type DestinyHistoricalStatsDestinyHistoricalStatsPeriodGroup ¶

type DestinyHistoricalStatsDestinyHistoricalStatsPeriodGroup struct {
	// Period for the group. If the stat periodType is day, then this will have a specific day. If the type is monthly, then this value will be the first day of the applicable month. This value is not set when the periodType is 'all time'.
	Period time.Time `json:"period,omitempty"`
	// If the period group is for a specific activity, this property will be set.
	ActivityDetails *AllOfDestinyHistoricalStatsDestinyHistoricalStatsPeriodGroupActivityDetails `json:"activityDetails,omitempty"`
	// Collection of stats for the period.
	Values map[string]DestinyHistoricalStatsDestinyHistoricalStatsValue `json:"values,omitempty"`
}

type DestinyHistoricalStatsDestinyHistoricalStatsValue ¶

type DestinyHistoricalStatsDestinyHistoricalStatsValue struct {
	// Unique ID for this stat
	StatId string `json:"statId,omitempty"`
	// Basic stat value.
	Basic *AllOfDestinyHistoricalStatsDestinyHistoricalStatsValueBasic `json:"basic,omitempty"`
	// Per game average for the statistic, if applicable
	Pga *AllOfDestinyHistoricalStatsDestinyHistoricalStatsValuePga `json:"pga,omitempty"`
	// Weighted value of the stat if a weight greater than 1 has been assigned.
	Weighted *AllOfDestinyHistoricalStatsDestinyHistoricalStatsValueWeighted `json:"weighted,omitempty"`
	// When a stat represents the best, most, longest, fastest or some other personal best, the actual activity ID where that personal best was established is available on this property.
	ActivityId int64 `json:"activityId,omitempty"`
}

type DestinyHistoricalStatsDestinyHistoricalStatsValuePair ¶

type DestinyHistoricalStatsDestinyHistoricalStatsValuePair struct {
	// Raw value of the statistic
	Value float64 `json:"value,omitempty"`
	// Localized formated version of the value.
	DisplayValue string `json:"displayValue,omitempty"`
}

type DestinyHistoricalStatsDestinyHistoricalStatsWithMerged ¶

type DestinyHistoricalStatsDestinyHistoricalStatsWithMerged struct {
	Results map[string]DestinyHistoricalStatsDestinyHistoricalStatsByPeriod `json:"results,omitempty"`
	Merged  *DestinyHistoricalStatsDestinyHistoricalStatsByPeriod           `json:"merged,omitempty"`
}

type DestinyHistoricalStatsDestinyHistoricalWeaponStats ¶

type DestinyHistoricalStatsDestinyHistoricalWeaponStats struct {
	// The hash ID of the item definition that describes the weapon.
	ReferenceId int32 `json:"referenceId,omitempty"`
	// Collection of stats for the period.
	Values map[string]DestinyHistoricalStatsDestinyHistoricalStatsValue `json:"values,omitempty"`
}

type DestinyHistoricalStatsDestinyHistoricalWeaponStatsData ¶

type DestinyHistoricalStatsDestinyHistoricalWeaponStatsData struct {
	// List of weapons and their perspective values.
	Weapons []DestinyHistoricalStatsDestinyHistoricalWeaponStats `json:"weapons,omitempty"`
}

type DestinyHistoricalStatsDestinyLeaderboard ¶

type DestinyHistoricalStatsDestinyLeaderboard struct {
	StatId  string                                          `json:"statId,omitempty"`
	Entries []DestinyHistoricalStatsDestinyLeaderboardEntry `json:"entries,omitempty"`
}

type DestinyHistoricalStatsDestinyLeaderboardEntry ¶

type DestinyHistoricalStatsDestinyLeaderboardEntry struct {
	// Where this player ranks on the leaderboard. A value of 1 is the top rank.
	Rank int32 `json:"rank,omitempty"`
	// Identity details of the player
	Player *AllOfDestinyHistoricalStatsDestinyLeaderboardEntryPlayer `json:"player,omitempty"`
	// ID of the player's best character for the reported stat.
	CharacterId int64 `json:"characterId,omitempty"`
	// Value of the stat for this player
	Value *AllOfDestinyHistoricalStatsDestinyLeaderboardEntryValue `json:"value,omitempty"`
}

type DestinyHistoricalStatsDestinyPlayer ¶

type DestinyHistoricalStatsDestinyPlayer struct {
	// Details about the player as they are known in game (platform display name, Destiny emblem)
	DestinyUserInfo *AllOfDestinyHistoricalStatsDestinyPlayerDestinyUserInfo `json:"destinyUserInfo,omitempty"`
	// Class of the character if applicable and available.
	CharacterClass string `json:"characterClass,omitempty"`
	ClassHash      int32  `json:"classHash,omitempty"`
	RaceHash       int32  `json:"raceHash,omitempty"`
	GenderHash     int32  `json:"genderHash,omitempty"`
	// Level of the character if available. Zero if it is not available.
	CharacterLevel int32 `json:"characterLevel,omitempty"`
	// Light Level of the character if available. Zero if it is not available.
	LightLevel int32 `json:"lightLevel,omitempty"`
	// Details about the player as they are known on BungieNet. This will be undefined if the player has marked their credential private, or does not have a BungieNet account.
	BungieNetUserInfo *AllOfDestinyHistoricalStatsDestinyPlayerBungieNetUserInfo `json:"bungieNetUserInfo,omitempty"`
	// Current clan name for the player. This value may be null or an empty string if the user does not have a clan.
	ClanName string `json:"clanName,omitempty"`
	// Current clan tag for the player. This value may be null or an empty string if the user does not have a clan.
	ClanTag string `json:"clanTag,omitempty"`
	// If we know the emblem's hash, this can be used to look up the player's emblem at the time of a match when receiving PGCR data, or otherwise their currently equipped emblem (if we are able to obtain it).
	EmblemHash int32 `json:"emblemHash,omitempty"`
}

type DestinyHistoricalStatsDestinyPostGameCarnageReportData ¶

type DestinyHistoricalStatsDestinyPostGameCarnageReportData struct {
	// Date and time for the activity.
	Period time.Time `json:"period,omitempty"`
	// If this activity has \"phases\", this is the phase at which the activity was started. This value is only valid for activities before the Beyond Light expansion shipped. Subsequent activities will not have a valid value here.
	StartingPhaseIndex int32 `json:"startingPhaseIndex,omitempty"`
	// True if the activity was started from the beginning, if that information is available and the activity was played post Witch Queen release.
	ActivityWasStartedFromBeginning bool `json:"activityWasStartedFromBeginning,omitempty"`
	// Details about the activity.
	ActivityDetails *AllOfDestinyHistoricalStatsDestinyPostGameCarnageReportDataActivityDetails `json:"activityDetails,omitempty"`
	// Collection of players and their data for this activity.
	Entries []DestinyHistoricalStatsDestinyPostGameCarnageReportEntry `json:"entries,omitempty"`
	// Collection of stats for the player in this activity.
	Teams []DestinyHistoricalStatsDestinyPostGameCarnageReportTeamEntry `json:"teams,omitempty"`
}

type DestinyHistoricalStatsDestinyPostGameCarnageReportEntry ¶

type DestinyHistoricalStatsDestinyPostGameCarnageReportEntry struct {
	// Standing of the player
	Standing int32 `json:"standing,omitempty"`
	// Score of the player if available
	Score *AllOfDestinyHistoricalStatsDestinyPostGameCarnageReportEntryScore `json:"score,omitempty"`
	// Identity details of the player
	Player *AllOfDestinyHistoricalStatsDestinyPostGameCarnageReportEntryPlayer `json:"player,omitempty"`
	// ID of the player's character used in the activity.
	CharacterId int64 `json:"characterId,omitempty"`
	// Collection of stats for the player in this activity.
	Values map[string]DestinyHistoricalStatsDestinyHistoricalStatsValue `json:"values,omitempty"`
	// Extended data extracted from the activity blob.
	Extended *AllOfDestinyHistoricalStatsDestinyPostGameCarnageReportEntryExtended `json:"extended,omitempty"`
}

type DestinyHistoricalStatsDestinyPostGameCarnageReportExtendedData ¶

type DestinyHistoricalStatsDestinyPostGameCarnageReportExtendedData struct {
	// List of weapons and their perspective values.
	Weapons []DestinyHistoricalStatsDestinyHistoricalWeaponStats `json:"weapons,omitempty"`
	// Collection of stats for the player in this activity.
	Values map[string]DestinyHistoricalStatsDestinyHistoricalStatsValue `json:"values,omitempty"`
}

type DestinyHistoricalStatsDestinyPostGameCarnageReportTeamEntry ¶

type DestinyHistoricalStatsDestinyPostGameCarnageReportTeamEntry struct {
	// Integer ID for the team.
	TeamId int32 `json:"teamId,omitempty"`
	// Team's standing relative to other teams.
	Standing *AllOfDestinyHistoricalStatsDestinyPostGameCarnageReportTeamEntryStanding `json:"standing,omitempty"`
	// Score earned by the team
	Score *AllOfDestinyHistoricalStatsDestinyPostGameCarnageReportTeamEntryScore `json:"score,omitempty"`
	// Alpha or Bravo
	TeamName string `json:"teamName,omitempty"`
}

type DestinyItemBindStatus ¶

type DestinyItemBindStatus int32

type DestinyItemComponentSetOfint32 ¶

type DestinyItemComponentSetOfint32 struct {
	Instances      *DictionaryComponentResponseOfint32AndDestinyItemInstanceComponent       `json:"instances,omitempty"`
	RenderData     *DictionaryComponentResponseOfint32AndDestinyItemRenderComponent         `json:"renderData,omitempty"`
	Stats          *DictionaryComponentResponseOfint32AndDestinyItemStatsComponent          `json:"stats,omitempty"`
	Sockets        *DictionaryComponentResponseOfint32AndDestinyItemSocketsComponent        `json:"sockets,omitempty"`
	ReusablePlugs  *DictionaryComponentResponseOfint32AndDestinyItemReusablePlugsComponent  `json:"reusablePlugs,omitempty"`
	PlugObjectives *DictionaryComponentResponseOfint32AndDestinyItemPlugObjectivesComponent `json:"plugObjectives,omitempty"`
	TalentGrids    *DictionaryComponentResponseOfint32AndDestinyItemTalentGridComponent     `json:"talentGrids,omitempty"`
	PlugStates     *DictionaryComponentResponseOfuint32AndDestinyItemPlugComponent          `json:"plugStates,omitempty"`
	Objectives     *DictionaryComponentResponseOfint32AndDestinyItemObjectivesComponent     `json:"objectives,omitempty"`
	Perks          *DictionaryComponentResponseOfint32AndDestinyItemPerksComponent          `json:"perks,omitempty"`
}

type DestinyItemComponentSetOfint64 ¶

type DestinyItemComponentSetOfint64 struct {
	Instances      *DictionaryComponentResponseOfint64AndDestinyItemInstanceComponent       `json:"instances,omitempty"`
	RenderData     *DictionaryComponentResponseOfint64AndDestinyItemRenderComponent         `json:"renderData,omitempty"`
	Stats          *DictionaryComponentResponseOfint64AndDestinyItemStatsComponent          `json:"stats,omitempty"`
	Sockets        *DictionaryComponentResponseOfint64AndDestinyItemSocketsComponent        `json:"sockets,omitempty"`
	ReusablePlugs  *DictionaryComponentResponseOfint64AndDestinyItemReusablePlugsComponent  `json:"reusablePlugs,omitempty"`
	PlugObjectives *DictionaryComponentResponseOfint64AndDestinyItemPlugObjectivesComponent `json:"plugObjectives,omitempty"`
	TalentGrids    *DictionaryComponentResponseOfint64AndDestinyItemTalentGridComponent     `json:"talentGrids,omitempty"`
	PlugStates     *DictionaryComponentResponseOfuint32AndDestinyItemPlugComponent          `json:"plugStates,omitempty"`
	Objectives     *DictionaryComponentResponseOfint64AndDestinyItemObjectivesComponent     `json:"objectives,omitempty"`
	Perks          *DictionaryComponentResponseOfint64AndDestinyItemPerksComponent          `json:"perks,omitempty"`
}

type DestinyItemComponentSetOfuint32 ¶

type DestinyItemComponentSetOfuint32 struct {
	Instances      *DictionaryComponentResponseOfuint32AndDestinyItemInstanceComponent       `json:"instances,omitempty"`
	RenderData     *DictionaryComponentResponseOfuint32AndDestinyItemRenderComponent         `json:"renderData,omitempty"`
	Stats          *DictionaryComponentResponseOfuint32AndDestinyItemStatsComponent          `json:"stats,omitempty"`
	Sockets        *DictionaryComponentResponseOfuint32AndDestinyItemSocketsComponent        `json:"sockets,omitempty"`
	ReusablePlugs  *DictionaryComponentResponseOfuint32AndDestinyItemReusablePlugsComponent  `json:"reusablePlugs,omitempty"`
	PlugObjectives *DictionaryComponentResponseOfuint32AndDestinyItemPlugObjectivesComponent `json:"plugObjectives,omitempty"`
	TalentGrids    *DictionaryComponentResponseOfuint32AndDestinyItemTalentGridComponent     `json:"talentGrids,omitempty"`
	PlugStates     *DictionaryComponentResponseOfuint32AndDestinyItemPlugComponent           `json:"plugStates,omitempty"`
	Objectives     *DictionaryComponentResponseOfuint32AndDestinyItemObjectivesComponent     `json:"objectives,omitempty"`
	Perks          *DictionaryComponentResponseOfuint32AndDestinyItemPerksComponent          `json:"perks,omitempty"`
}

type DestinyItemLocation ¶

type DestinyItemLocation int32

type DestinyItemPerkVisibility ¶

type DestinyItemPerkVisibility int32

DestinyItemPerkVisibility : Indicates how a perk should be shown, or if it should be, in the game UI. Maybe useful for those of you trying to filter out internal-use-only perks (or for those of you trying to figure out what they do!)

type DestinyItemState ¶

type DestinyItemState int32

DestinyItemState : A flags enumeration/bitmask where each bit represents a different possible state that the item can be in that may effect how the item is displayed to the user and what actions can be performed against it.

type DestinyMilestonesDestinyMilestone ¶

type DestinyMilestonesDestinyMilestone struct {
	// The unique identifier for the Milestone. Use it to look up the DestinyMilestoneDefinition, so you can combine the other data in this contract with static definition data.
	MilestoneHash int32 `json:"milestoneHash,omitempty"`
	// Indicates what quests are available for this Milestone. Usually this will be only a single Quest, but some quests have multiple available that you can choose from at any given time. All possible quests for a milestone can be found in the DestinyMilestoneDefinition, but they must be combined with this Live data to determine which one(s) are actually active right now. It is possible for Milestones to not have any quests.
	AvailableQuests []DestinyMilestonesDestinyMilestoneQuest `json:"availableQuests,omitempty"`
	// The currently active Activities in this milestone, when the Milestone is driven by Challenges.  Not all Milestones have Challenges, but when they do this will indicate the Activities and Challenges under those Activities related to this Milestone.
	Activities []DestinyMilestonesDestinyMilestoneChallengeActivity `json:"activities,omitempty"`
	// Milestones may have arbitrary key/value pairs associated with them, for data that users will want to know about but that doesn't fit neatly into any of the common components such as Quests. A good example of this would be - if this existed in Destiny 1 - the number of wins you currently have on your Trials of Osiris ticket. Looking in the DestinyMilestoneDefinition, you can use the string identifier of this dictionary to look up more info about the value, including localized string content for displaying the value. The value in the dictionary is the floating point number. The definition will tell you how to format this number.
	Values map[string]float32 `json:"values,omitempty"`
	// A milestone may have one or more active vendors that are \"related\" to it (that provide rewards, or that are the initiators of the Milestone). I already regret this, even as I'm typing it. [I told you I'd regret this] You see, sometimes a milestone may be directly correlated with a set of vendors that provide varying tiers of rewards. The player may not be able to interact with one or more of those vendors. This will return the hashes of the Vendors that the player *can* interact with, allowing you to show their current inventory as rewards or related items to the Milestone or its activities.  Before we even use it, it's already deprecated! How much of a bummer is that? We need more data.
	VendorHashes []int32 `json:"vendorHashes,omitempty"`
	// Replaces vendorHashes, which I knew was going to be trouble the day it walked in the door. This will return not only what Vendors are active and relevant to the activity (in an implied order that you can choose to ignore), but also other data - for example, if the Vendor is featuring a specific item relevant to this event that you should show with them.
	Vendors []DestinyMilestonesDestinyMilestoneVendor `json:"vendors,omitempty"`
	// If the entity to which this component is attached has known active Rewards for the player, this will detail information about those rewards, keyed by the RewardEntry Hash. (See DestinyMilestoneDefinition for more information about Reward Entries) Note that these rewards are not for the Quests related to the Milestone. Think of these as \"overview/checklist\" rewards that may be provided for Milestones that may provide rewards for performing a variety of tasks that aren't under a specific Quest.
	Rewards []DestinyMilestonesDestinyMilestoneRewardCategory `json:"rewards,omitempty"`
	// If known, this is the date when the event last began or refreshed. It will only be populated for events with fixed and repeating start and end dates.
	StartDate time.Time `json:"startDate,omitempty"`
	// If known, this is the date when the event will next end or repeat. It will only be populated for events with fixed and repeating start and end dates.
	EndDate time.Time `json:"endDate,omitempty"`
	// Used for ordering milestones in a display to match how we order them in BNet. May pull from static data, or possibly in the future from dynamic information.
	Order int32 `json:"order,omitempty"`
}

Represents a runtime instance of a user's milestone status. Live Milestone data should be combined with DestinyMilestoneDefinition data to show the user a picture of what is available for them to do in the game, and their status in regards to said \"things to do.\" Consider it a big, wonky to-do list, or Advisors 3.0 for those who remember the Destiny 1 API.

type DestinyMilestonesDestinyMilestoneActivity ¶

type DestinyMilestonesDestinyMilestoneActivity struct {
	// The hash of an arbitrarily chosen variant of this activity. We'll go ahead and call that the \"canonical\" activity, because if you're using this value you should only use it for properties that are common across the variants: things like the name of the activity, it's location, etc... Use this hash to look up the DestinyActivityDefinition of this activity for rendering data.
	ActivityHash int32 `json:"activityHash,omitempty"`
	// The hash identifier of the most specific Activity Mode under which this activity is played. This is useful for situations where the activity in question is - for instance - a PVP map, but it's not clear what mode the PVP map is being played under. If it's a playlist, this will be less specific: but hopefully useful in some way.
	ActivityModeHash int32 `json:"activityModeHash,omitempty"`
	// The enumeration equivalent of the most specific Activity Mode under which this activity is played.
	ActivityModeType int32 `json:"activityModeType,omitempty"`
	// If the activity has modifiers, this will be the list of modifiers that all variants have in common. Perform lookups against DestinyActivityModifierDefinition which defines the modifier being applied to get at the modifier data. Note that, in the DestiyActivityDefinition, you will see many more modifiers than this being referred to: those are all *possible* modifiers for the activity, not the active ones. Use only the active ones to match what's really live.
	ModifierHashes []int32 `json:"modifierHashes,omitempty"`
	// If you want more than just name/location/etc... you're going to have to dig into and show the variants of the conceptual activity. These will differ in seemingly arbitrary ways, like difficulty level and modifiers applied. Show it in whatever way tickles your fancy.
	Variants []DestinyMilestonesDestinyMilestoneActivityVariant `json:"variants,omitempty"`
}

Sometimes, we know the specific activity that the Milestone wants you to play. This entity provides additional information about that Activity and all of its variants. (sometimes there's only one variant, but I think you get the point)

type DestinyMilestonesDestinyMilestoneActivityCompletionStatus ¶

type DestinyMilestonesDestinyMilestoneActivityCompletionStatus struct {
	// If the activity has been \"completed\", that information will be returned here.
	Completed bool `json:"completed,omitempty"`
	// If the Activity has discrete \"phases\" that we can track, that info will be here. Otherwise, this value will be NULL. Note that this is a list and not a dictionary: the order implies the ascending order of phases or progression in this activity.
	Phases []DestinyMilestonesDestinyMilestoneActivityPhase `json:"phases,omitempty"`
}

Represents this player's personal completion status for the Activity under a Milestone, if the activity has trackable completion and progress information. (most activities won't, or the concept won't apply. For instance, it makes sense to talk about a tier of a raid as being Completed or having progress, but it doesn't make sense to talk about a Crucible Playlist in those terms.

type DestinyMilestonesDestinyMilestoneActivityPhase ¶

type DestinyMilestonesDestinyMilestoneActivityPhase struct {
	// Indicates if the phase has been completed.
	Complete bool `json:"complete,omitempty"`
	// In DestinyActivityDefinition, if the activity has phases, there will be a set of phases defined in the \"insertionPoints\" property. This is the hash that maps to that phase.
	PhaseHash int32 `json:"phaseHash,omitempty"`
}

Represents whatever information we can return about an explicit phase in an activity. In the future, I hope we'll have more than just \"guh, you done gone and did something,\" but for the forseeable future that's all we've got. I'm making it more than just a list of booleans out of that overly-optimistic hope.

type DestinyMilestonesDestinyMilestoneActivityVariant ¶

type DestinyMilestonesDestinyMilestoneActivityVariant struct {
	// The hash for the specific variant of the activity related to this milestone. You can pull more detailed static info from the DestinyActivityDefinition, such as difficulty level.
	ActivityHash int32 `json:"activityHash,omitempty"`
	// An OPTIONAL component: if it makes sense to talk about this activity variant in terms of whether or not it has been completed or what progress you have made in it, this will be returned. Otherwise, this will be NULL.
	CompletionStatus *AllOfDestinyMilestonesDestinyMilestoneActivityVariantCompletionStatus `json:"completionStatus,omitempty"`
	// The hash identifier of the most specific Activity Mode under which this activity is played. This is useful for situations where the activity in question is - for instance - a PVP map, but it's not clear what mode the PVP map is being played under. If it's a playlist, this will be less specific: but hopefully useful in some way.
	ActivityModeHash int32 `json:"activityModeHash,omitempty"`
	// The enumeration equivalent of the most specific Activity Mode under which this activity is played.
	ActivityModeType int32 `json:"activityModeType,omitempty"`
}

Represents custom data that we know about an individual variant of an activity.

type DestinyMilestonesDestinyMilestoneChallengeActivity ¶

type DestinyMilestonesDestinyMilestoneChallengeActivity struct {
	ActivityHash int32                                     `json:"activityHash,omitempty"`
	Challenges   []DestinyChallengesDestinyChallengeStatus `json:"challenges,omitempty"`
	// If the activity has modifiers, this will be the list of modifiers that all variants have in common. Perform lookups against DestinyActivityModifierDefinition which defines the modifier being applied to get at the modifier data.  Note that, in the DestiyActivityDefinition, you will see many more modifiers than this being referred to: those are all *possible* modifiers for the activity, not the active ones. Use only the active ones to match what's really live.
	ModifierHashes []int32 `json:"modifierHashes,omitempty"`
	// The set of activity options for this activity, keyed by an identifier that's unique for this activity (not guaranteed to be unique between or across all activities, though should be unique for every *variant* of a given *conceptual* activity: for instance, the original D2 Raid has many variant DestinyActivityDefinitions. While other activities could potentially have the same option hashes, for any given D2 base Raid variant the hash will be unique).  As a concrete example of this data, the hashes you get for Raids will correspond to the currently active \"Challenge Mode\".  We don't have any human readable information for these, but saavy 3rd party app users could manually associate the key (a hash identifier for the \"option\" that is enabled/disabled) and the value (whether it's enabled or disabled presently)  On our side, we don't necessarily even know what these are used for (the game designers know, but we don't), and we have no human readable data for them. In order to use them, you will have to do some experimentation.
	BooleanActivityOptions map[string]bool `json:"booleanActivityOptions,omitempty"`
	// If returned, this is the index into the DestinyActivityDefinition's \"loadouts\" property, indicating the currently active loadout requirements.
	LoadoutRequirementIndex int32 `json:"loadoutRequirementIndex,omitempty"`
	// If the Activity has discrete \"phases\" that we can track, that info will be here. Otherwise, this value will be NULL. Note that this is a list and not a dictionary: the order implies the ascending order of phases or progression in this activity.
	Phases []DestinyMilestonesDestinyMilestoneActivityPhase `json:"phases,omitempty"`
}

type DestinyMilestonesDestinyMilestoneContent ¶

type DestinyMilestonesDestinyMilestoneContent struct {
	// The \"About this Milestone\" text from the Firehose.
	About string `json:"about,omitempty"`
	// The Current Status of the Milestone, as driven by the Firehose.
	Status string `json:"status,omitempty"`
	// A list of tips, provided by the Firehose.
	Tips []string `json:"tips,omitempty"`
	// If DPS has defined items related to this Milestone, they can categorize those items in the Firehose. That data will then be returned as item categories here.
	ItemCategories []DestinyMilestonesDestinyMilestoneContentItemCategory `json:"itemCategories,omitempty"`
}

Represents localized, extended content related to Milestones. This is intentionally returned by a separate endpoint and not with Character-level Milestone data because we do not put localized data into standard Destiny responses, both for brevity of response and for caching purposes. If you really need this data, hit the Milestone Content endpoint.

type DestinyMilestonesDestinyMilestoneContentItemCategory ¶

type DestinyMilestonesDestinyMilestoneContentItemCategory struct {
	Title      string  `json:"title,omitempty"`
	ItemHashes []int32 `json:"itemHashes,omitempty"`
}

Part of our dynamic, localized Milestone content is arbitrary categories of items. These are built in our content management system, and thus aren't the same as programmatically generated rewards.

type DestinyMilestonesDestinyMilestoneQuest ¶

type DestinyMilestonesDestinyMilestoneQuest struct {
	// Quests are defined as Items in content. As such, this is the hash identifier of the DestinyInventoryItemDefinition that represents this quest. It will have pointers to all of the steps in the quest, and display information for the quest (title, description, icon etc) Individual steps will be referred to in the Quest item's DestinyInventoryItemDefinition.setData property, and themselves are Items with their own renderable data.
	QuestItemHash int32 `json:"questItemHash,omitempty"`
	// The current status of the quest for the character making the request.
	Status *AllOfDestinyMilestonesDestinyMilestoneQuestStatus `json:"status,omitempty"`
	// *IF* the Milestone has an active Activity that can give you greater details about what you need to do, it will be returned here. Remember to associate this with the DestinyMilestoneDefinition's activities to get details about the activity, including what specific quest it is related to if you have multiple quests to choose from.
	Activity *AllOfDestinyMilestonesDestinyMilestoneQuestActivity `json:"activity,omitempty"`
	// The activities referred to by this quest can have many associated challenges. They are all contained here, with activityHashes so that you can associate them with the specific activity variants in which they can be found. In retrospect, I probably should have put these under the specific Activity Variants, but it's too late to change it now. Theoretically, a quest without Activities can still have Challenges, which is why this is on a higher level than activity/variants, but it probably should have been in both places. That may come as a later revision.
	Challenges []DestinyChallengesDestinyChallengeStatus `json:"challenges,omitempty"`
}

If a Milestone has one or more Quests, this will contain the live information for the character's status with one of those quests.

type DestinyMilestonesDestinyMilestoneRewardCategory ¶

type DestinyMilestonesDestinyMilestoneRewardCategory struct {
	// Look up the relevant DestinyMilestoneDefinition, and then use rewardCategoryHash to look up the category info in DestinyMilestoneDefinition.rewards.
	RewardCategoryHash int32 `json:"rewardCategoryHash,omitempty"`
	// The individual reward entries for this category, and their status.
	Entries []DestinyMilestonesDestinyMilestoneRewardEntry `json:"entries,omitempty"`
}

Represents a category of \"summary\" rewards that can be earned for the Milestone regardless of specific quest rewards that can be earned.

type DestinyMilestonesDestinyMilestoneRewardEntry ¶

type DestinyMilestonesDestinyMilestoneRewardEntry struct {
	// The identifier for the reward entry in question. It is important to look up the related DestinyMilestoneRewardEntryDefinition to get the static details about the reward, which you can do by looking up the milestone's DestinyMilestoneDefinition and examining the DestinyMilestoneDefinition.rewards[rewardCategoryHash].rewardEntries[rewardEntryHash] data.
	RewardEntryHash int32 `json:"rewardEntryHash,omitempty"`
	// If TRUE, the player has earned this reward.
	Earned bool `json:"earned,omitempty"`
	// If TRUE, the player has redeemed/picked up/obtained this reward. Feel free to alias this to \"gotTheShinyBauble\" in your own codebase.
	Redeemed bool `json:"redeemed,omitempty"`
}

The character-specific data for a milestone's reward entry. See DestinyMilestoneDefinition for more information about Reward Entries.

type DestinyMilestonesDestinyMilestoneVendor ¶

type DestinyMilestonesDestinyMilestoneVendor struct {
	// The hash identifier of the Vendor related to this Milestone. You can show useful things from this, such as thier Faction icon or whatever you might care about.
	VendorHash int32 `json:"vendorHash,omitempty"`
	// If this vendor is featuring a specific item for this event, this will be the hash identifier of that item. I'm taking bets now on how long we go before this needs to be a list or some other, more complex representation instead and I deprecate this too. I'm going to go with 5 months. Calling it now, 2017-09-14 at 9:46pm PST.
	PreviewItemHash int32 `json:"previewItemHash,omitempty"`
}

If a Milestone has one or more Vendors that are relevant to it, this will contain information about that vendor that you can choose to show.

type DestinyMilestonesDestinyPublicMilestone ¶

type DestinyMilestonesDestinyPublicMilestone struct {
	// The hash identifier for the milestone. Use it to look up the DestinyMilestoneDefinition for static data about the Milestone.
	MilestoneHash int32 `json:"milestoneHash,omitempty"`
	// A milestone not need have even a single quest, but if there are active quests they will be returned here.
	AvailableQuests []DestinyMilestonesDestinyPublicMilestoneQuest             `json:"availableQuests,omitempty"`
	Activities      []DestinyMilestonesDestinyPublicMilestoneChallengeActivity `json:"activities,omitempty"`
	// Sometimes milestones - or activities active in milestones - will have relevant vendors. These are the vendors that are currently relevant.  Deprecated, already, for the sake of the new \"vendors\" property that has more data. What was I thinking.
	VendorHashes []int32 `json:"vendorHashes,omitempty"`
	// This is why we can't have nice things. This is the ordered list of vendors to be shown that relate to this milestone, potentially along with other interesting data.
	Vendors []DestinyMilestonesDestinyPublicMilestoneVendor `json:"vendors,omitempty"`
	// If known, this is the date when the Milestone started/became active.
	StartDate time.Time `json:"startDate,omitempty"`
	// If known, this is the date when the Milestone will expire/recycle/end.
	EndDate time.Time `json:"endDate,omitempty"`
	// Used for ordering milestones in a display to match how we order them in BNet. May pull from static data, or possibly in the future from dynamic information.
	Order int32 `json:"order,omitempty"`
}

Information about milestones, presented in a character state-agnostic manner. Combine this data with DestinyMilestoneDefinition to get a full picture of the milestone, which is basically a checklist of things to do in the game. Think of this as GetPublicAdvisors 3.0, for those who used the Destiny 1 API.

type DestinyMilestonesDestinyPublicMilestoneActivity ¶

type DestinyMilestonesDestinyPublicMilestoneActivity struct {
	// The hash identifier of the activity that's been chosen to be considered the canonical \"conceptual\" activity definition. This may have many variants, defined herein.
	ActivityHash int32 `json:"activityHash,omitempty"`
	// The activity may have 0-to-many modifiers: if it does, this will contain the hashes to the DestinyActivityModifierDefinition that defines the modifier being applied.
	ModifierHashes []int32 `json:"modifierHashes,omitempty"`
	// Every relevant variation of this conceptual activity, including the conceptual activity itself, have variants defined here.
	Variants []DestinyMilestonesDestinyPublicMilestoneActivityVariant `json:"variants,omitempty"`
	// The hash identifier of the most specific Activity Mode under which this activity is played. This is useful for situations where the activity in question is - for instance - a PVP map, but it's not clear what mode the PVP map is being played under. If it's a playlist, this will be less specific: but hopefully useful in some way.
	ActivityModeHash int32 `json:"activityModeHash,omitempty"`
	// The enumeration equivalent of the most specific Activity Mode under which this activity is played.
	ActivityModeType int32 `json:"activityModeType,omitempty"`
}

A milestone may have one or more conceptual Activities associated with it, and each of those conceptual activities could have a variety of variants, modes, tiers, what-have-you. Our attempts to determine what qualifies as a conceptual activity are, unfortunately, janky. So if you see missing modes or modes that don't seem appropriate to you, let us know and I'll buy you a beer if we ever meet up in person.

type DestinyMilestonesDestinyPublicMilestoneActivityVariant ¶

type DestinyMilestonesDestinyPublicMilestoneActivityVariant struct {
	// The hash identifier of this activity variant. Examine the activity's definition in the Manifest database to determine what makes it a distinct variant. Usually it will be difficulty level or whether or not it is a guided game variant of the activity, but theoretically it could be distinguished in any arbitrary way.
	ActivityHash int32 `json:"activityHash,omitempty"`
	// The hash identifier of the most specific Activity Mode under which this activity is played. This is useful for situations where the activity in question is - for instance - a PVP map, but it's not clear what mode the PVP map is being played under. If it's a playlist, this will be less specific: but hopefully useful in some way.
	ActivityModeHash int32 `json:"activityModeHash,omitempty"`
	// The enumeration equivalent of the most specific Activity Mode under which this activity is played.
	ActivityModeType int32 `json:"activityModeType,omitempty"`
}

Represents a variant of an activity that's relevant to a milestone.

type DestinyMilestonesDestinyPublicMilestoneChallenge ¶

type DestinyMilestonesDestinyPublicMilestoneChallenge struct {
	// The objective for the Challenge, which should have human-readable data about what needs to be done to accomplish the objective. Use this hash to look up the DestinyObjectiveDefinition.
	ObjectiveHash int32 `json:"objectiveHash,omitempty"`
	// IF the Objective is related to a specific Activity, this will be that activity's hash. Use it to look up the DestinyActivityDefinition for additional data to show.
	ActivityHash int32 `json:"activityHash,omitempty"`
}

A Milestone can have many Challenges. Challenges are just extra Objectives that provide a fun way to mix-up play and provide extra rewards.

type DestinyMilestonesDestinyPublicMilestoneChallengeActivity ¶

type DestinyMilestonesDestinyPublicMilestoneChallengeActivity struct {
	ActivityHash             int32   `json:"activityHash,omitempty"`
	ChallengeObjectiveHashes []int32 `json:"challengeObjectiveHashes,omitempty"`
	// If the activity has modifiers, this will be the list of modifiers that all variants have in common. Perform lookups against DestinyActivityModifierDefinition which defines the modifier being applied to get at the modifier data.  Note that, in the DestiyActivityDefinition, you will see many more modifiers than this being referred to: those are all *possible* modifiers for the activity, not the active ones. Use only the active ones to match what's really live.
	ModifierHashes []int32 `json:"modifierHashes,omitempty"`
	// If returned, this is the index into the DestinyActivityDefinition's \"loadouts\" property, indicating the currently active loadout requirements.
	LoadoutRequirementIndex int32 `json:"loadoutRequirementIndex,omitempty"`
	// The ordered list of phases for this activity, if any. Note that we have no human readable info for phases, nor any entities to relate them to: relating these hashes to something human readable is up to you unfortunately.
	PhaseHashes []int32 `json:"phaseHashes,omitempty"`
	// The set of activity options for this activity, keyed by an identifier that's unique for this activity (not guaranteed to be unique between or across all activities, though should be unique for every *variant* of a given *conceptual* activity: for instance, the original D2 Raid has many variant DestinyActivityDefinitions. While other activities could potentially have the same option hashes, for any given D2 base Raid variant the hash will be unique).  As a concrete example of this data, the hashes you get for Raids will correspond to the currently active \"Challenge Mode\".  We have no human readable information for this data, so it's up to you if you want to associate it with such info to show it.
	BooleanActivityOptions map[string]bool `json:"booleanActivityOptions,omitempty"`
}

type DestinyMilestonesDestinyPublicMilestoneQuest ¶

type DestinyMilestonesDestinyPublicMilestoneQuest struct {
	// Quests are defined as Items in content. As such, this is the hash identifier of the DestinyInventoryItemDefinition that represents this quest. It will have pointers to all of the steps in the quest, and display information for the quest (title, description, icon etc) Individual steps will be referred to in the Quest item's DestinyInventoryItemDefinition.setData property, and themselves are Items with their own renderable data.
	QuestItemHash int32 `json:"questItemHash,omitempty"`
	// A milestone need not have an active activity, but if there is one it will be returned here, along with any variant and additional information.
	Activity *AllOfDestinyMilestonesDestinyPublicMilestoneQuestActivity `json:"activity,omitempty"`
	// For the given quest there could be 0-to-Many challenges: mini quests that you can perform in the course of doing this quest, that may grant you rewards and benefits.
	Challenges []DestinyMilestonesDestinyPublicMilestoneChallenge `json:"challenges,omitempty"`
}

type DestinyMilestonesDestinyPublicMilestoneVendor ¶

type DestinyMilestonesDestinyPublicMilestoneVendor struct {
	// The hash identifier of the Vendor related to this Milestone. You can show useful things from this, such as thier Faction icon or whatever you might care about.
	VendorHash int32 `json:"vendorHash,omitempty"`
	// If this vendor is featuring a specific item for this event, this will be the hash identifier of that item. I'm taking bets now on how long we go before this needs to be a list or some other, more complex representation instead and I deprecate this too. I'm going to go with 5 months. Calling it now, 2017-09-14 at 9:46pm PST.
	PreviewItemHash int32 `json:"previewItemHash,omitempty"`
}

type DestinyMiscDestinyColor ¶

type DestinyMiscDestinyColor struct {
	Red   string `json:"red,omitempty"`
	Green string `json:"green,omitempty"`
	Blue  string `json:"blue,omitempty"`
	Alpha string `json:"alpha,omitempty"`
}

Represents a color whose RGBA values are all represented as values between 0 and 255.

type DestinyPerksDestinyPerkReference ¶

type DestinyPerksDestinyPerkReference struct {
	// The hash identifier for the perk, which can be used to look up DestinySandboxPerkDefinition if it exists. Be warned, perks frequently do not have user-viewable information. You should examine whether you actually found a name/description in the perk's definition before you show it to the user.
	PerkHash int32 `json:"perkHash,omitempty"`
	// The icon for the perk.
	IconPath string `json:"iconPath,omitempty"`
	// Whether this perk is currently active. (We may return perks that you have not actually activated yet: these represent perks that you should show in the item's tooltip, but that the user has not yet activated.)
	IsActive bool `json:"isActive,omitempty"`
	// Some perks provide benefits, but aren't visible in the UI. This value will let you know if this is perk should be shown in your UI.
	Visible bool `json:"visible,omitempty"`
}

The list of perks to display in an item tooltip - and whether or not they have been activated. Perks apply a variety of effects to a character, and are generally either intrinsic to the item or provided in activated talent nodes or sockets.

type DestinyPlugAvailabilityMode ¶

type DestinyPlugAvailabilityMode int32

DestinyPlugAvailabilityMode : This enum determines whether the plug is available to be inserted. - Normal means that all existing rules for plug insertion apply. - UnavailableIfSocketContainsMatchingPlugCategory means that the plug is only available if the socket does NOT match the plug category. - AvailableIfSocketContainsMatchingPlugCategory means that the plug is only available if the socket DOES match the plug category. For category matching, use the plug's \"plugCategoryIdentifier\" property, comparing it to

type DestinyPlugUiStyles ¶

type DestinyPlugUiStyles int32

DestinyPlugUiStyles : If the plug has a specific custom style, this enumeration will represent that style/those styles.

type DestinyProgressionDestinyFactionProgression ¶

type DestinyProgressionDestinyFactionProgression struct {
	// The hash identifier of the Faction related to this progression. Use it to look up the DestinyFactionDefinition for more rendering info.
	FactionHash int32 `json:"factionHash,omitempty"`
	// The index of the Faction vendor that is currently available. Will be set to -1 if no vendors are available.
	FactionVendorIndex int32 `json:"factionVendorIndex,omitempty"`
	// The hash identifier of the Progression in question. Use it to look up the DestinyProgressionDefinition in static data.
	ProgressionHash int32 `json:"progressionHash,omitempty"`
	// The amount of progress earned today for this progression.
	DailyProgress int32 `json:"dailyProgress,omitempty"`
	// If this progression has a daily limit, this is that limit.
	DailyLimit int32 `json:"dailyLimit,omitempty"`
	// The amount of progress earned toward this progression in the current week.
	WeeklyProgress int32 `json:"weeklyProgress,omitempty"`
	// If this progression has a weekly limit, this is that limit.
	WeeklyLimit int32 `json:"weeklyLimit,omitempty"`
	// This is the total amount of progress obtained overall for this progression (for instance, the total amount of Character Level experience earned)
	CurrentProgress int32 `json:"currentProgress,omitempty"`
	// This is the level of the progression (for instance, the Character Level).
	Level int32 `json:"level,omitempty"`
	// This is the maximum possible level you can achieve for this progression (for example, the maximum character level obtainable)
	LevelCap int32 `json:"levelCap,omitempty"`
	// Progressions define their levels in \"steps\". Since the last step may be repeatable, the user may be at a higher level than the actual Step achieved in the progression. Not necessarily useful, but potentially interesting for those cruising the API. Relate this to the \"steps\" property of the DestinyProgression to see which step the user is on, if you care about that. (Note that this is Content Version dependent since it refers to indexes.)
	StepIndex int32 `json:"stepIndex,omitempty"`
	// The amount of progression (i.e. \"Experience\") needed to reach the next level of this Progression. Jeez, progression is such an overloaded word.
	ProgressToNextLevel int32 `json:"progressToNextLevel,omitempty"`
	// The total amount of progression (i.e. \"Experience\") needed in order to reach the next level.
	NextLevelAt int32 `json:"nextLevelAt,omitempty"`
	// The number of resets of this progression you've executed this season, if applicable to this progression.
	CurrentResetCount int32 `json:"currentResetCount,omitempty"`
	// Information about historical resets of this progression, if there is any data for it.
	SeasonResets []DestinyDestinyProgressionResetEntry `json:"seasonResets,omitempty"`
	// Information about historical rewards for this progression, if there is any data for it.
	RewardItemStates []int32 `json:"rewardItemStates,omitempty"`
}

Mostly for historical purposes, we segregate Faction progressions from other progressions. This is just a DestinyProgression with a shortcut for finding the DestinyFactionDefinition of the faction related to the progression.

type DestinyQuestsDestinyObjectiveProgress ¶

type DestinyQuestsDestinyObjectiveProgress struct {
	// The unique identifier of the Objective being referred to. Use to look up the DestinyObjectiveDefinition in static data.
	ObjectiveHash int32 `json:"objectiveHash,omitempty"`
	// If the Objective has a Destination associated with it, this is the unique identifier of the Destination being referred to. Use to look up the DestinyDestinationDefinition in static data. This will give localized data about *where* in the universe the objective should be achieved.
	DestinationHash int32 `json:"destinationHash,omitempty"`
	// If the Objective has an Activity associated with it, this is the unique identifier of the Activity being referred to. Use to look up the DestinyActivityDefinition in static data. This will give localized data about *what* you should be playing for the objective to be achieved.
	ActivityHash int32 `json:"activityHash,omitempty"`
	// If progress has been made, and the progress can be measured numerically, this will be the value of that progress. You can compare it to the DestinyObjectiveDefinition.completionValue property for current vs. upper bounds, and use DestinyObjectiveDefinition.inProgressValueStyle or completedValueStyle to determine how this should be rendered. Note that progress, in Destiny 2, need not be a literal numeric progression. It could be one of a number of possible values, even a Timestamp. Always examine DestinyObjectiveDefinition.inProgressValueStyle or completedValueStyle before rendering progress.
	Progress int32 `json:"progress,omitempty"`
	// As of Forsaken, objectives' completion value is determined dynamically at runtime.  This value represents the threshold of progress you need to surpass in order for this objective to be considered \"complete\".  If you were using objective data, switch from using the DestinyObjectiveDefinition's \"completionValue\" to this value.
	CompletionValue int32 `json:"completionValue,omitempty"`
	// Whether or not the Objective is completed.
	Complete bool `json:"complete,omitempty"`
	// If this is true, the objective is visible in-game. Otherwise, it's not yet visible to the player. Up to you if you want to honor this property.
	Visible bool `json:"visible,omitempty"`
}

Returns data about a character's status with a given Objective. Combine with DestinyObjectiveDefinition static data for display purposes.

type DestinyQuestsDestinyQuestStatus ¶

type DestinyQuestsDestinyQuestStatus struct {
	// The hash identifier for the Quest Item. (Note: Quests are defined as Items, and thus you would use this to look up the quest's DestinyInventoryItemDefinition). For information on all steps in the quest, you can then examine its DestinyInventoryItemDefinition.setData property for Quest Steps (which are *also* items). You can use the Item Definition to display human readable data about the overall quest.
	QuestHash int32 `json:"questHash,omitempty"`
	// The hash identifier of the current Quest Step, which is also a DestinyInventoryItemDefinition. You can use this to get human readable data about the current step and what to do in that step.
	StepHash int32 `json:"stepHash,omitempty"`
	// A step can have multiple objectives. This will give you the progress for each objective in the current step, in the order in which they are rendered in-game.
	StepObjectives []DestinyQuestsDestinyObjectiveProgress `json:"stepObjectives,omitempty"`
	// Whether or not the quest is tracked
	Tracked bool `json:"tracked,omitempty"`
	// The current Quest Step will be an instanced item in the player's inventory. If you care about that, this is the instance ID of that item.
	ItemInstanceId int64 `json:"itemInstanceId,omitempty"`
	// Whether or not the whole quest has been completed, regardless of whether or not you have redeemed the rewards for the quest.
	Completed bool `json:"completed,omitempty"`
	// Whether or not you have redeemed rewards for this quest.
	Redeemed bool `json:"redeemed,omitempty"`
	// Whether or not you have started this quest.
	Started bool `json:"started,omitempty"`
	// If the quest has a related Vendor that you should talk to in order to initiate the quest/earn rewards/continue the quest, this will be the hash identifier of that Vendor. Look it up its DestinyVendorDefinition.
	VendorHash int32 `json:"vendorHash,omitempty"`
}

Data regarding the progress of a Quest for a specific character. Quests are composed of multiple steps, each with potentially multiple objectives: this QuestStatus will return Objective data for the *currently active* step in this quest.

type DestinyReportingRequestsDestinyReportOffensePgcrRequest ¶

type DestinyReportingRequestsDestinyReportOffensePgcrRequest struct {
	// So you've decided to report someone instead of cursing them and their descendants. Well, okay then. This is the category or categorie(s) of infractions for which you are reporting the user. These are hash identifiers that map to DestinyReportReasonCategoryDefinition entries.
	ReasonCategoryHashes []int32 `json:"reasonCategoryHashes,omitempty"`
	// If applicable, provide a more specific reason(s) within the general category of problems provided by the reasonHash. This is also an identifier for a reason. All reasonHashes provided must be children of at least one the reasonCategoryHashes provided.
	ReasonHashes []int32 `json:"reasonHashes,omitempty"`
	// Within the PGCR provided when calling the Reporting endpoint, this should be the character ID of the user that you thought was violating terms of use. They must exist in the PGCR provided.
	OffendingCharacterId int64 `json:"offendingCharacterId,omitempty"`
}

If you want to report a player causing trouble in a game, this request will let you report that player and the specific PGCR in which the trouble was caused, along with why. Please don't do this just because you dislike the person! I mean, I know people will do it anyways, but can you like take a good walk, or put a curse on them or something? Do me a solid and reconsider. Note that this request object doesn't have the actual PGCR ID nor your Account/Character ID in it. We will infer that information from your authentication information and the PGCR ID that you pass into the URL of the reporting endpoint itself.

type DestinyRequestsActionsDestinyActionRequest ¶

type DestinyRequestsActionsDestinyActionRequest struct {
	MembershipType int32 `json:"membershipType,omitempty"`
}

type DestinyRequestsActionsDestinyCharacterActionRequest ¶

type DestinyRequestsActionsDestinyCharacterActionRequest struct {
	CharacterId    int64 `json:"characterId,omitempty"`
	MembershipType int32 `json:"membershipType,omitempty"`
}

type DestinyRequestsActionsDestinyInsertPlugsActionRequest ¶

type DestinyRequestsActionsDestinyInsertPlugsActionRequest struct {
	// Action token provided by the AwaGetActionToken API call.
	ActionToken string `json:"actionToken,omitempty"`
	// The instance ID of the item having a plug inserted. Only instanced items can have sockets.
	ItemInstanceId int64 `json:"itemInstanceId,omitempty"`
	// The plugs being inserted.
	Plug           *AllOfDestinyRequestsActionsDestinyInsertPlugsActionRequestPlug `json:"plug,omitempty"`
	CharacterId    int64                                                           `json:"characterId,omitempty"`
	MembershipType int32                                                           `json:"membershipType,omitempty"`
}

type DestinyRequestsActionsDestinyInsertPlugsFreeActionRequest ¶

type DestinyRequestsActionsDestinyInsertPlugsFreeActionRequest struct {
	// The plugs being inserted.
	Plug *AllOfDestinyRequestsActionsDestinyInsertPlugsFreeActionRequestPlug `json:"plug,omitempty"`
	// The instance ID of the item for this action request.
	ItemId         int64 `json:"itemId,omitempty"`
	CharacterId    int64 `json:"characterId,omitempty"`
	MembershipType int32 `json:"membershipType,omitempty"`
}

type DestinyRequestsActionsDestinyInsertPlugsRequestEntry ¶

type DestinyRequestsActionsDestinyInsertPlugsRequestEntry struct {
	// The index into the socket array, which identifies the specific socket being operated on. We also need to know the socketArrayType in order to uniquely identify the socket.  Don't point to or try to insert a plug into an infusion socket. It won't work.
	SocketIndex int32 `json:"socketIndex,omitempty"`
	// This property, combined with the socketIndex, tells us which socket we are referring to (since operations can be performed on both Intrinsic and \"default\" sockets, and they occupy different arrays in the Inventory Item Definition). I know, I know. Don't give me that look.
	SocketArrayType int32 `json:"socketArrayType,omitempty"`
	// Plugs are never instanced (except in infusion). So with the hash alone, we should be able to: 1) Infer whether the player actually needs to have the item, or if it's a reusable plug 2) Perform any operation needed to use the Plug, including removing the plug item and running reward sheets.
	PlugItemHash int32 `json:"plugItemHash,omitempty"`
}

Represents all of the data related to a single plug to be inserted. Note that, while you *can* point to a socket that represents infusion, you will receive an error if you attempt to do so. Come on guys, let's play nice.

type DestinyRequestsActionsDestinyItemActionRequest ¶

type DestinyRequestsActionsDestinyItemActionRequest struct {
	// The instance ID of the item for this action request.
	ItemId         int64 `json:"itemId,omitempty"`
	CharacterId    int64 `json:"characterId,omitempty"`
	MembershipType int32 `json:"membershipType,omitempty"`
}

type DestinyRequestsActionsDestinyItemSetActionRequest ¶

type DestinyRequestsActionsDestinyItemSetActionRequest struct {
	ItemIds        []int64 `json:"itemIds,omitempty"`
	CharacterId    int64   `json:"characterId,omitempty"`
	MembershipType int32   `json:"membershipType,omitempty"`
}

type DestinyRequestsActionsDestinyItemStateRequest ¶

type DestinyRequestsActionsDestinyItemStateRequest struct {
	State bool `json:"state,omitempty"`
	// The instance ID of the item for this action request.
	ItemId         int64 `json:"itemId,omitempty"`
	CharacterId    int64 `json:"characterId,omitempty"`
	MembershipType int32 `json:"membershipType,omitempty"`
}

type DestinyRequestsActionsDestinyLoadoutActionRequest ¶

type DestinyRequestsActionsDestinyLoadoutActionRequest struct {
	// The index of the loadout for this action request.
	LoadoutIndex   int32 `json:"loadoutIndex,omitempty"`
	CharacterId    int64 `json:"characterId,omitempty"`
	MembershipType int32 `json:"membershipType,omitempty"`
}

type DestinyRequestsActionsDestinyLoadoutUpdateActionRequest ¶

type DestinyRequestsActionsDestinyLoadoutUpdateActionRequest struct {
	ColorHash int32 `json:"colorHash,omitempty"`
	IconHash  int32 `json:"iconHash,omitempty"`
	NameHash  int32 `json:"nameHash,omitempty"`
	// The index of the loadout for this action request.
	LoadoutIndex   int32 `json:"loadoutIndex,omitempty"`
	CharacterId    int64 `json:"characterId,omitempty"`
	MembershipType int32 `json:"membershipType,omitempty"`
}

type DestinyRequestsActionsDestinyPostmasterTransferRequest ¶

type DestinyRequestsActionsDestinyPostmasterTransferRequest struct {
	ItemReferenceHash int32 `json:"itemReferenceHash,omitempty"`
	StackSize         int32 `json:"stackSize,omitempty"`
	// The instance ID of the item for this action request.
	ItemId         int64 `json:"itemId,omitempty"`
	CharacterId    int64 `json:"characterId,omitempty"`
	MembershipType int32 `json:"membershipType,omitempty"`
}

type DestinyRequestsActionsDestinySocketArrayType ¶

type DestinyRequestsActionsDestinySocketArrayType int32

DestinyRequestsActionsDestinySocketArrayType : If you look in the DestinyInventoryItemDefinition's \"sockets\" property, you'll see that there are two types of sockets: intrinsic, and \"socketEntry.\" Unfortunately, because Intrinsic sockets are a whole separate array, it is no longer sufficient to know the index into that array to know which socket we're talking about. You have to know whether it's in the default \"socketEntries\" or if it's in the \"intrinsic\" list.

type DestinyRequestsDestinyItemTransferRequest ¶

type DestinyRequestsDestinyItemTransferRequest struct {
	ItemReferenceHash int32 `json:"itemReferenceHash,omitempty"`
	StackSize         int32 `json:"stackSize,omitempty"`
	TransferToVault   bool  `json:"transferToVault,omitempty"`
	// The instance ID of the item for this action request.
	ItemId         int64 `json:"itemId,omitempty"`
	CharacterId    int64 `json:"characterId,omitempty"`
	MembershipType int32 `json:"membershipType,omitempty"`
}

type DestinyResponsesDestinyCharacterResponse ¶

type DestinyResponsesDestinyCharacterResponse struct {
	// The character-level non-equipped inventory items.  COMPONENT TYPE: CharacterInventories
	Inventory *AllOfDestinyResponsesDestinyCharacterResponseInventory `json:"inventory,omitempty"`
	// Base information about the character in question.  COMPONENT TYPE: Characters
	Character *AllOfDestinyResponsesDestinyCharacterResponseCharacter `json:"character,omitempty"`
	// Character progression data, including Milestones.  COMPONENT TYPE: CharacterProgressions
	Progressions *AllOfDestinyResponsesDestinyCharacterResponseProgressions `json:"progressions,omitempty"`
	// Character rendering data - a minimal set of information about equipment and dyes used for rendering.  COMPONENT TYPE: CharacterRenderData
	RenderData *AllOfDestinyResponsesDestinyCharacterResponseRenderData `json:"renderData,omitempty"`
	// Activity data - info about current activities available to the player.  COMPONENT TYPE: CharacterActivities
	Activities *AllOfDestinyResponsesDestinyCharacterResponseActivities `json:"activities,omitempty"`
	// Equipped items on the character.  COMPONENT TYPE: CharacterEquipment
	Equipment *AllOfDestinyResponsesDestinyCharacterResponseEquipment `json:"equipment,omitempty"`
	// The loadouts available to the character.  COMPONENT TYPE: CharacterLoadouts
	Loadouts *AllOfDestinyResponsesDestinyCharacterResponseLoadouts `json:"loadouts,omitempty"`
	// Items available from Kiosks that are available to this specific character.   COMPONENT TYPE: Kiosks
	Kiosks *AllOfDestinyResponsesDestinyCharacterResponseKiosks `json:"kiosks,omitempty"`
	// 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
	PlugSets *AllOfDestinyResponsesDestinyCharacterResponsePlugSets `json:"plugSets,omitempty"`
	// COMPONENT TYPE: PresentationNodes
	PresentationNodes *AllOfDestinyResponsesDestinyCharacterResponsePresentationNodes `json:"presentationNodes,omitempty"`
	// COMPONENT TYPE: Records
	Records *AllOfDestinyResponsesDestinyCharacterResponseRecords `json:"records,omitempty"`
	// COMPONENT TYPE: Collectibles
	Collectibles *AllOfDestinyResponsesDestinyCharacterResponseCollectibles `json:"collectibles,omitempty"`
	// The set of components belonging to the player's instanced items.  COMPONENT TYPE: [See inside the DestinyItemComponentSet contract for component types.]
	ItemComponents *AllOfDestinyResponsesDestinyCharacterResponseItemComponents `json:"itemComponents,omitempty"`
	// 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.]
	UninstancedItemComponents *AllOfDestinyResponsesDestinyCharacterResponseUninstancedItemComponents `json:"uninstancedItemComponents,omitempty"`
	// 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
	CurrencyLookups *AllOfDestinyResponsesDestinyCharacterResponseCurrencyLookups `json:"currencyLookups,omitempty"`
}

The response contract for GetDestinyCharacter, with components that can be returned for character and item-level data.

type DestinyResponsesDestinyCollectibleNodeDetailResponse ¶

type DestinyResponsesDestinyCollectibleNodeDetailResponse struct {
	// COMPONENT TYPE: Collectibles
	Collectibles *AllOfDestinyResponsesDestinyCollectibleNodeDetailResponseCollectibles `json:"collectibles,omitempty"`
	// 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.]
	CollectibleItemComponents *AllOfDestinyResponsesDestinyCollectibleNodeDetailResponseCollectibleItemComponents `json:"collectibleItemComponents,omitempty"`
}

Returns the detailed information about a Collectible Presentation Node and any Collectibles that are direct descendants.

type DestinyResponsesDestinyErrorProfile ¶

type DestinyResponsesDestinyErrorProfile struct {
	// The error that we encountered. You should be able to look up localized text to show to the user for these failures.
	ErrorCode int32 `json:"errorCode,omitempty"`
	// Basic info about the account that failed. Don't expect anything other than membership ID, Membership Type, and displayName to be populated.
	InfoCard *AllOfDestinyResponsesDestinyErrorProfileInfoCard `json:"infoCard,omitempty"`
}

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.

type DestinyResponsesDestinyItemChangeResponse ¶

type DestinyResponsesDestinyItemChangeResponse struct {
	Item *DestinyResponsesDestinyItemResponse `json:"item,omitempty"`
	// Items that appeared in the inventory possibly as a result of an action.
	AddedInventoryItems []DestinyEntitiesItemsDestinyItemComponent `json:"addedInventoryItems,omitempty"`
	// Items that disappeared from the inventory possibly as a result of an action.
	RemovedInventoryItems []DestinyEntitiesItemsDestinyItemComponent `json:"removedInventoryItems,omitempty"`
}

type DestinyResponsesDestinyItemResponse ¶

type DestinyResponsesDestinyItemResponse struct {
	// If the item is on a character, this will return the ID of the character that is holding the item.
	CharacterId int64 `json:"characterId,omitempty"`
	// Common data for the item relevant to its non-instanced properties.  COMPONENT TYPE: ItemCommonData
	Item *AllOfDestinyResponsesDestinyItemResponseItem `json:"item,omitempty"`
	// Basic instance data for the item.  COMPONENT TYPE: ItemInstances
	Instance *AllOfDestinyResponsesDestinyItemResponseInstance `json:"instance,omitempty"`
	// Information specifically about the item's objectives.  COMPONENT TYPE: ItemObjectives
	Objectives *AllOfDestinyResponsesDestinyItemResponseObjectives `json:"objectives,omitempty"`
	// Information specifically about the perks currently active on the item.  COMPONENT TYPE: ItemPerks
	Perks *AllOfDestinyResponsesDestinyItemResponsePerks `json:"perks,omitempty"`
	// Information about how to render the item in 3D.  COMPONENT TYPE: ItemRenderData
	RenderData *AllOfDestinyResponsesDestinyItemResponseRenderData `json:"renderData,omitempty"`
	// Information about the computed stats of the item: power, defense, etc...  COMPONENT TYPE: ItemStats
	Stats *AllOfDestinyResponsesDestinyItemResponseStats `json:"stats,omitempty"`
	// 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
	TalentGrid *AllOfDestinyResponsesDestinyItemResponseTalentGrid `json:"talentGrid,omitempty"`
	// 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
	Sockets *AllOfDestinyResponsesDestinyItemResponseSockets `json:"sockets,omitempty"`
	// 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
	ReusablePlugs *AllOfDestinyResponsesDestinyItemResponseReusablePlugs `json:"reusablePlugs,omitempty"`
	// Information about objectives on Plugs for a given item. See the component's documentation for more info.  COMPONENT TYPE: ItemPlugObjectives
	PlugObjectives *AllOfDestinyResponsesDestinyItemResponsePlugObjectives `json:"plugObjectives,omitempty"`
}

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.

type DestinyResponsesDestinyLinkedProfilesResponse ¶

type DestinyResponsesDestinyLinkedProfilesResponse struct {
	// 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 []DestinyResponsesDestinyProfileUserInfoCard `json:"profiles,omitempty"`
	// 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
	BnetMembership *AllOfDestinyResponsesDestinyLinkedProfilesResponseBnetMembership `json:"bnetMembership,omitempty"`
	// 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.
	ProfilesWithErrors []DestinyResponsesDestinyErrorProfile `json:"profilesWithErrors,omitempty"`
}

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

type DestinyResponsesDestinyProfileResponse ¶

type DestinyResponsesDestinyProfileResponse struct {
	// Records the timestamp of when most components were last generated from the world server source. Unless the component type is specified in the documentation for secondaryComponentsMintedTimestamp, this value is sufficient to do data freshness.
	ResponseMintedTimestamp time.Time `json:"responseMintedTimestamp,omitempty"`
	// Some secondary components are not tracked in the primary response timestamp and have their timestamp tracked here. If your component is any of the following, this field is where you will find your timestamp value:   PresentationNodes, Records, Collectibles, Metrics, StringVariables, Craftables, Transitory   All other component types may use the primary timestamp property.
	SecondaryComponentsMintedTimestamp time.Time `json:"secondaryComponentsMintedTimestamp,omitempty"`
	// Recent, refundable purchases you have made from vendors. When will you use it? Couldn't say...  COMPONENT TYPE: VendorReceipts
	VendorReceipts *AllOfDestinyResponsesDestinyProfileResponseVendorReceipts `json:"vendorReceipts,omitempty"`
	// The profile-level inventory of the Destiny Profile.  COMPONENT TYPE: ProfileInventories
	ProfileInventory *AllOfDestinyResponsesDestinyProfileResponseProfileInventory `json:"profileInventory,omitempty"`
	// The profile-level currencies owned by the Destiny Profile.  COMPONENT TYPE: ProfileCurrencies
	ProfileCurrencies *AllOfDestinyResponsesDestinyProfileResponseProfileCurrencies `json:"profileCurrencies,omitempty"`
	// The basic information about the Destiny Profile (formerly \"Account\").  COMPONENT TYPE: Profiles
	Profile *AllOfDestinyResponsesDestinyProfileResponseProfile `json:"profile,omitempty"`
	// Silver quantities for any platform on which this Profile plays destiny.   COMPONENT TYPE: PlatformSilver
	PlatformSilver *AllOfDestinyResponsesDestinyProfileResponsePlatformSilver `json:"platformSilver,omitempty"`
	// 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
	ProfileKiosks *AllOfDestinyResponsesDestinyProfileResponseProfileKiosks `json:"profileKiosks,omitempty"`
	// 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
	ProfilePlugSets *AllOfDestinyResponsesDestinyProfileResponseProfilePlugSets `json:"profilePlugSets,omitempty"`
	// 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
	ProfileProgression *AllOfDestinyResponsesDestinyProfileResponseProfileProgression `json:"profileProgression,omitempty"`
	// COMPONENT TYPE: PresentationNodes
	ProfilePresentationNodes *AllOfDestinyResponsesDestinyProfileResponseProfilePresentationNodes `json:"profilePresentationNodes,omitempty"`
	// COMPONENT TYPE: Records
	ProfileRecords *AllOfDestinyResponsesDestinyProfileResponseProfileRecords `json:"profileRecords,omitempty"`
	// COMPONENT TYPE: Collectibles
	ProfileCollectibles *AllOfDestinyResponsesDestinyProfileResponseProfileCollectibles `json:"profileCollectibles,omitempty"`
	// COMPONENT TYPE: Transitory
	ProfileTransitoryData *AllOfDestinyResponsesDestinyProfileResponseProfileTransitoryData `json:"profileTransitoryData,omitempty"`
	// COMPONENT TYPE: Metrics
	Metrics *AllOfDestinyResponsesDestinyProfileResponseMetrics `json:"metrics,omitempty"`
	// COMPONENT TYPE: StringVariables
	ProfileStringVariables *AllOfDestinyResponsesDestinyProfileResponseProfileStringVariables `json:"profileStringVariables,omitempty"`
	// COMPONENT TYPE: SocialCommendations
	ProfileCommendations *AllOfDestinyResponsesDestinyProfileResponseProfileCommendations `json:"profileCommendations,omitempty"`
	// Basic information about each character, keyed by the CharacterId.  COMPONENT TYPE: Characters
	Characters *AllOfDestinyResponsesDestinyProfileResponseCharacters `json:"characters,omitempty"`
	// The character-level non-equipped inventory items, keyed by the Character's Id.  COMPONENT TYPE: CharacterInventories
	CharacterInventories *AllOfDestinyResponsesDestinyProfileResponseCharacterInventories `json:"characterInventories,omitempty"`
	// The character loadouts, keyed by the Character's Id.  COMPONENT TYPE: CharacterLoadouts
	CharacterLoadouts *AllOfDestinyResponsesDestinyProfileResponseCharacterLoadouts `json:"characterLoadouts,omitempty"`
	// Character-level progression data, keyed by the Character's Id.  COMPONENT TYPE: CharacterProgressions
	CharacterProgressions *AllOfDestinyResponsesDestinyProfileResponseCharacterProgressions `json:"characterProgressions,omitempty"`
	// Character rendering data - a minimal set of info needed to render a character in 3D - keyed by the Character's Id.  COMPONENT TYPE: CharacterRenderData
	CharacterRenderData *AllOfDestinyResponsesDestinyProfileResponseCharacterRenderData `json:"characterRenderData,omitempty"`
	// Character activity data - the activities available to this character and its status, keyed by the Character's Id.  COMPONENT TYPE: CharacterActivities
	CharacterActivities *AllOfDestinyResponsesDestinyProfileResponseCharacterActivities `json:"characterActivities,omitempty"`
	// The character's equipped items, keyed by the Character's Id.  COMPONENT TYPE: CharacterEquipment
	CharacterEquipment *AllOfDestinyResponsesDestinyProfileResponseCharacterEquipment `json:"characterEquipment,omitempty"`
	// 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
	CharacterKiosks *AllOfDestinyResponsesDestinyProfileResponseCharacterKiosks `json:"characterKiosks,omitempty"`
	// 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
	CharacterPlugSets *AllOfDestinyResponsesDestinyProfileResponseCharacterPlugSets `json:"characterPlugSets,omitempty"`
	// 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
	CharacterUninstancedItemComponents map[string]DestinyBaseItemComponentSetOfuint32 `json:"characterUninstancedItemComponents,omitempty"`
	// COMPONENT TYPE: PresentationNodes
	CharacterPresentationNodes *AllOfDestinyResponsesDestinyProfileResponseCharacterPresentationNodes `json:"characterPresentationNodes,omitempty"`
	// COMPONENT TYPE: Records
	CharacterRecords *AllOfDestinyResponsesDestinyProfileResponseCharacterRecords `json:"characterRecords,omitempty"`
	// COMPONENT TYPE: Collectibles
	CharacterCollectibles *AllOfDestinyResponsesDestinyProfileResponseCharacterCollectibles `json:"characterCollectibles,omitempty"`
	// COMPONENT TYPE: StringVariables
	CharacterStringVariables *AllOfDestinyResponsesDestinyProfileResponseCharacterStringVariables `json:"characterStringVariables,omitempty"`
	// COMPONENT TYPE: Craftables
	CharacterCraftables *AllOfDestinyResponsesDestinyProfileResponseCharacterCraftables `json:"characterCraftables,omitempty"`
	// 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.]
	ItemComponents *AllOfDestinyResponsesDestinyProfileResponseItemComponents `json:"itemComponents,omitempty"`
	// 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
	CharacterCurrencyLookups *AllOfDestinyResponsesDestinyProfileResponseCharacterCurrencyLookups `json:"characterCurrencyLookups,omitempty"`
}

The response for GetDestinyProfile, with components for character and item-level data.

type DestinyResponsesDestinyProfileUserInfoCard ¶

type DestinyResponsesDestinyProfileUserInfoCard struct {
	DateLastPlayed time.Time `json:"dateLastPlayed,omitempty"`
	// 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.
	IsOverridden bool `json:"isOverridden,omitempty"`
	// If true, this account is hooked up as the \"Primary\" cross save account for one or more platforms.
	IsCrossSavePrimary bool `json:"isCrossSavePrimary,omitempty"`
	// 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.
	PlatformSilver *AllOfDestinyResponsesDestinyProfileUserInfoCardPlatformSilver `json:"platformSilver,omitempty"`
	// 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.
	UnpairedGameVersions int32 `json:"unpairedGameVersions,omitempty"`
	// A platform specific additional display name - ex: psn Real Name, bnet Unique Name, etc.
	SupplementalDisplayName string `json:"supplementalDisplayName,omitempty"`
	// URL the Icon if available.
	IconPath string `json:"iconPath,omitempty"`
	// If there is a cross save override in effect, this value will tell you the type that is overridding this one.
	CrossSaveOverride int32 `json:"crossSaveOverride,omitempty"`
	// 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
	ApplicableMembershipTypes []int32 `json:"applicableMembershipTypes,omitempty"`
	// If True, this is a public user membership.
	IsPublic bool `json:"isPublic,omitempty"`
	// Type of the membership. Not necessarily the native type.
	MembershipType int32 `json:"membershipType,omitempty"`
	// Membership ID as they user is known in the Accounts service
	MembershipId int64 `json:"membershipId,omitempty"`
	// 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.
	DisplayName string `json:"displayName,omitempty"`
	// The bungie global display name, if set.
	BungieGlobalDisplayName string `json:"bungieGlobalDisplayName,omitempty"`
	// The bungie global display name code, if set.
	BungieGlobalDisplayNameCode int32 `json:"bungieGlobalDisplayNameCode,omitempty"`
}

type DestinyResponsesDestinyPublicVendorsResponse ¶

type DestinyResponsesDestinyPublicVendorsResponse struct {
	// 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
	VendorGroups *AllOfDestinyResponsesDestinyPublicVendorsResponseVendorGroups `json:"vendorGroups,omitempty"`
	// 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
	Vendors *AllOfDestinyResponsesDestinyPublicVendorsResponseVendors `json:"vendors,omitempty"`
	// 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
	Categories *AllOfDestinyResponsesDestinyPublicVendorsResponseCategories `json:"categories,omitempty"`
	// 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
	Sales *AllOfDestinyResponsesDestinyPublicVendorsResponseSales `json:"sales,omitempty"`
	// A set of string variable values by hash for a public vendors context.  COMPONENT TYPE: StringVariables
	StringVariables *AllOfDestinyResponsesDestinyPublicVendorsResponseStringVariables `json:"stringVariables,omitempty"`
}

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.

type DestinyResponsesDestinyVendorResponse ¶

type DestinyResponsesDestinyVendorResponse struct {
	// The base properties of the vendor.  COMPONENT TYPE: Vendors
	Vendor *AllOfDestinyResponsesDestinyVendorResponseVendor `json:"vendor,omitempty"`
	// Categories that the vendor has available, and references to the sales therein.  COMPONENT TYPE: VendorCategories
	Categories *AllOfDestinyResponsesDestinyVendorResponseCategories `json:"categories,omitempty"`
	// Sales, keyed by the vendorItemIndex of the item being sold.  COMPONENT TYPE: VendorSales
	Sales *AllOfDestinyResponsesDestinyVendorResponseSales `json:"sales,omitempty"`
	// Item components, keyed by the vendorItemIndex of the active sale items.  COMPONENT TYPE: [See inside the DestinyItemComponentSet contract for component types.]
	ItemComponents *AllOfDestinyResponsesDestinyVendorResponseItemComponents `json:"itemComponents,omitempty"`
	// 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
	CurrencyLookups *AllOfDestinyResponsesDestinyVendorResponseCurrencyLookups `json:"currencyLookups,omitempty"`
	// A map of string variable values by hash for this character context.  COMPONENT TYPE: StringVariables
	StringVariables *AllOfDestinyResponsesDestinyVendorResponseStringVariables `json:"stringVariables,omitempty"`
}

A response containing all of the components for a vendor.

type DestinyResponsesDestinyVendorsResponse ¶

type DestinyResponsesDestinyVendorsResponse struct {
	// 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
	VendorGroups *AllOfDestinyResponsesDestinyVendorsResponseVendorGroups `json:"vendorGroups,omitempty"`
	// 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
	Vendors *AllOfDestinyResponsesDestinyVendorsResponseVendors `json:"vendors,omitempty"`
	// 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
	Categories *AllOfDestinyResponsesDestinyVendorsResponseCategories `json:"categories,omitempty"`
	// 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
	Sales *AllOfDestinyResponsesDestinyVendorsResponseSales `json:"sales,omitempty"`
	// 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.
	ItemComponents map[string]DestinyItemComponentSetOfint32 `json:"itemComponents,omitempty"`
	// 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
	CurrencyLookups *AllOfDestinyResponsesDestinyVendorsResponseCurrencyLookups `json:"currencyLookups,omitempty"`
	// A map of string variable values by hash for this character context.  COMPONENT TYPE: StringVariables
	StringVariables *AllOfDestinyResponsesDestinyVendorsResponseStringVariables `json:"stringVariables,omitempty"`
}

A response containing all of the components for all requested vendors.

type DestinyResponsesInventoryChangedResponse ¶

type DestinyResponsesInventoryChangedResponse struct {
	// Items that appeared in the inventory possibly as a result of an action.
	AddedInventoryItems []DestinyEntitiesItemsDestinyItemComponent `json:"addedInventoryItems,omitempty"`
	// Items that disappeared from the inventory possibly as a result of an action.
	RemovedInventoryItems []DestinyEntitiesItemsDestinyItemComponent `json:"removedInventoryItems,omitempty"`
}

A response containing all of the components for all requested vendors.

type DestinyResponsesPersonalDestinyVendorSaleItemSetComponent ¶

type DestinyResponsesPersonalDestinyVendorSaleItemSetComponent struct {
	SaleItems map[string]DestinyEntitiesVendorsDestinyVendorSaleItemComponent `json:"saleItems,omitempty"`
}

type DestinyResponsesPublicDestinyVendorSaleItemSetComponent ¶

type DestinyResponsesPublicDestinyVendorSaleItemSetComponent struct {
	SaleItems map[string]DestinyComponentsVendorsDestinyPublicVendorSaleItemComponent `json:"saleItems,omitempty"`
}

type DestinySocketPlugSources ¶

type DestinySocketPlugSources int32

DestinySocketPlugSources : Indicates how a socket is populated, and where you should look for valid plug data. This is a flags enumeration/bitmask field, as you may have to look in multiple sources across multiple components for valid plugs. For instance, a socket could have plugs that are sourced from its own definition, as well as plugs that are sourced from Character-scoped AND profile-scoped Plug Sets. Only by combining plug data for every indicated source will you be able to know all of the plugs available for a socket.

type DestinySocketTypeActionType ¶

type DestinySocketTypeActionType int32

DestinySocketTypeActionType : Indicates the type of actions that can be performed

type DestinySocketsDestinyItemPlug ¶

type DestinySocketsDestinyItemPlug struct {
	// Sometimes, Plugs may have objectives: these are often used for flavor and display purposes, but they can be used for any arbitrary purpose (both fortunately and unfortunately). Recently (with Season 2) they were expanded in use to be used as the \"gating\" for whether the plug can be inserted at all. For instance, a Plug might be tracking the number of PVP kills you have made. It will use the parent item's data about that tracking status to determine what to show, and will generally show it using the DestinyObjectiveDefinition's progressDescription property. Refer to the plug's itemHash and objective property for more information if you would like to display even more data.
	PlugObjectives []DestinyQuestsDestinyObjectiveProgress `json:"plugObjectives,omitempty"`
	// The hash identifier of the DestinyInventoryItemDefinition that represents this plug.
	PlugItemHash int32 `json:"plugItemHash,omitempty"`
	// If true, this plug has met all of its insertion requirements. Big if true.
	CanInsert bool `json:"canInsert,omitempty"`
	// If true, this plug will provide its benefits while inserted.
	Enabled bool `json:"enabled,omitempty"`
	// If the plug cannot be inserted for some reason, this will have the indexes into the plug item definition's plug.insertionRules property, so you can show the reasons why it can't be inserted.  This list will be empty if the plug can be inserted.
	InsertFailIndexes []int32 `json:"insertFailIndexes,omitempty"`
	// If a plug is not enabled, this will be populated with indexes into the plug item definition's plug.enabledRules property, so that you can show the reasons why it is not enabled.  This list will be empty if the plug is enabled.
	EnableFailIndexes []int32 `json:"enableFailIndexes,omitempty"`
}

type DestinySocketsDestinyItemPlugBase ¶

type DestinySocketsDestinyItemPlugBase struct {
	// The hash identifier of the DestinyInventoryItemDefinition that represents this plug.
	PlugItemHash int32 `json:"plugItemHash,omitempty"`
	// If true, this plug has met all of its insertion requirements. Big if true.
	CanInsert bool `json:"canInsert,omitempty"`
	// If true, this plug will provide its benefits while inserted.
	Enabled bool `json:"enabled,omitempty"`
	// If the plug cannot be inserted for some reason, this will have the indexes into the plug item definition's plug.insertionRules property, so you can show the reasons why it can't be inserted.  This list will be empty if the plug can be inserted.
	InsertFailIndexes []int32 `json:"insertFailIndexes,omitempty"`
	// If a plug is not enabled, this will be populated with indexes into the plug item definition's plug.enabledRules property, so that you can show the reasons why it is not enabled.  This list will be empty if the plug is enabled.
	EnableFailIndexes []int32 `json:"enableFailIndexes,omitempty"`
}

type DestinySpecialItemType ¶

type DestinySpecialItemType int32

DestinySpecialItemType : As you run into items that need to be classified for Milestone purposes in ways that we cannot infer via direct data, add a new classification here and use a string constant to represent it in the local item config file. NOTE: This is not all of the item types available, and some of these are holdovers from Destiny 1 that may or may not still exist.

type DestinyTierType ¶

type DestinyTierType int32

type DestinyTransferStatuses ¶

type DestinyTransferStatuses int32

DestinyTransferStatuses : Whether you can transfer an item, and why not if you can't.

type DestinyVendorDisplayCategorySortOrder ¶

type DestinyVendorDisplayCategorySortOrder int32

DestinyVendorDisplayCategorySortOrder : Display categories can have custom sort orders. These are the possible options.

type DestinyVendorInteractionType ¶

type DestinyVendorInteractionType int32

DestinyVendorInteractionType : An enumeration of the known UI interactions for Vendors.

type DestinyVendorItemStatus ¶

type DestinyVendorItemStatus int32

type DestinyVendorSaleItemSetComponentOfDestinyPublicVendorSaleItemComponent ¶

type DestinyVendorSaleItemSetComponentOfDestinyPublicVendorSaleItemComponent struct {
	SaleItems map[string]DestinyComponentsVendorsDestinyPublicVendorSaleItemComponent `json:"saleItems,omitempty"`
}

type DestinyVendorSaleItemSetComponentOfDestinyVendorSaleItemComponent ¶

type DestinyVendorSaleItemSetComponentOfDestinyVendorSaleItemComponent struct {
	SaleItems map[string]DestinyEntitiesVendorsDestinyVendorSaleItemComponent `json:"saleItems,omitempty"`
}

type DestinyVendorsDestinyVendorReceipt ¶

type DestinyVendorsDestinyVendorReceipt struct {
	// The amount paid for the item, in terms of items that were consumed in the purchase and their quantity.
	CurrencyPaid []DestinyDestinyItemQuantity `json:"currencyPaid,omitempty"`
	// The item that was received, and its quantity.
	ItemReceived *AllOfDestinyVendorsDestinyVendorReceiptItemReceived `json:"itemReceived,omitempty"`
	// The unlock flag used to determine whether you still have the purchased item.
	LicenseUnlockHash int32 `json:"licenseUnlockHash,omitempty"`
	// The ID of the character who made the purchase.
	PurchasedByCharacterId int64 `json:"purchasedByCharacterId,omitempty"`
	// Whether you can get a refund, and what happens in order for the refund to be received. See the DestinyVendorItemRefundPolicy enum for details.
	RefundPolicy int32 `json:"refundPolicy,omitempty"`
	// The identifier of this receipt.
	SequenceNumber int32 `json:"sequenceNumber,omitempty"`
	// The seconds since epoch at which this receipt is rendered invalid.
	TimeToExpiration int64 `json:"timeToExpiration,omitempty"`
	// The date at which this receipt is rendered invalid.
	ExpiresOn time.Time `json:"expiresOn,omitempty"`
}

If a character purchased an item that is refundable, a Vendor Receipt will be created on the user's Destiny Profile. These expire after a configurable period of time, but until then can be used to get refunds on items. BNet does not provide the ability to refund a purchase *yet*, but you know.

type DictionaryComponentResponseOfint32AndDestinyItemInstanceComponent ¶

type DictionaryComponentResponseOfint32AndDestinyItemInstanceComponent struct {
	Data    map[string]DestinyEntitiesItemsDestinyItemInstanceComponent `json:"data,omitempty"`
	Privacy int32                                                       `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint32AndDestinyItemObjectivesComponent ¶

type DictionaryComponentResponseOfint32AndDestinyItemObjectivesComponent struct {
	Data    map[string]DestinyEntitiesItemsDestinyItemObjectivesComponent `json:"data,omitempty"`
	Privacy int32                                                         `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint32AndDestinyItemPerksComponent ¶

type DictionaryComponentResponseOfint32AndDestinyItemPerksComponent struct {
	Data    map[string]DestinyEntitiesItemsDestinyItemPerksComponent `json:"data,omitempty"`
	Privacy int32                                                    `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint32AndDestinyItemPlugObjectivesComponent ¶

type DictionaryComponentResponseOfint32AndDestinyItemPlugObjectivesComponent struct {
	Data    map[string]DestinyComponentsItemsDestinyItemPlugObjectivesComponent `json:"data,omitempty"`
	Privacy int32                                                               `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint32AndDestinyItemRenderComponent ¶

type DictionaryComponentResponseOfint32AndDestinyItemRenderComponent struct {
	Data    map[string]DestinyEntitiesItemsDestinyItemRenderComponent `json:"data,omitempty"`
	Privacy int32                                                     `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint32AndDestinyItemReusablePlugsComponent ¶

type DictionaryComponentResponseOfint32AndDestinyItemReusablePlugsComponent struct {
	Data    map[string]DestinyComponentsItemsDestinyItemReusablePlugsComponent `json:"data,omitempty"`
	Privacy int32                                                              `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint32AndDestinyItemSocketsComponent ¶

type DictionaryComponentResponseOfint32AndDestinyItemSocketsComponent struct {
	Data    map[string]DestinyEntitiesItemsDestinyItemSocketsComponent `json:"data,omitempty"`
	Privacy int32                                                      `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint32AndDestinyItemStatsComponent ¶

type DictionaryComponentResponseOfint32AndDestinyItemStatsComponent struct {
	Data    map[string]DestinyEntitiesItemsDestinyItemStatsComponent `json:"data,omitempty"`
	Privacy int32                                                    `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint32AndDestinyItemTalentGridComponent ¶

type DictionaryComponentResponseOfint32AndDestinyItemTalentGridComponent struct {
	Data    map[string]DestinyEntitiesItemsDestinyItemTalentGridComponent `json:"data,omitempty"`
	Privacy int32                                                         `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint32AndDestinyVendorSaleItemComponent ¶

type DictionaryComponentResponseOfint32AndDestinyVendorSaleItemComponent struct {
	Data    map[string]DestinyEntitiesVendorsDestinyVendorSaleItemComponent `json:"data,omitempty"`
	Privacy int32                                                           `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint64AndDestinyCharacterActivitiesComponent ¶

type DictionaryComponentResponseOfint64AndDestinyCharacterActivitiesComponent struct {
	Data    map[string]DestinyEntitiesCharactersDestinyCharacterActivitiesComponent `json:"data,omitempty"`
	Privacy int32                                                                   `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint64AndDestinyCharacterComponent ¶

type DictionaryComponentResponseOfint64AndDestinyCharacterComponent struct {
	Data    map[string]DestinyEntitiesCharactersDestinyCharacterComponent `json:"data,omitempty"`
	Privacy int32                                                         `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint64AndDestinyCharacterProgressionComponent ¶

type DictionaryComponentResponseOfint64AndDestinyCharacterProgressionComponent struct {
	Data    map[string]DestinyEntitiesCharactersDestinyCharacterProgressionComponent `json:"data,omitempty"`
	Privacy int32                                                                    `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint64AndDestinyCharacterRecordsComponent ¶

type DictionaryComponentResponseOfint64AndDestinyCharacterRecordsComponent struct {
	Data    map[string]DestinyComponentsRecordsDestinyCharacterRecordsComponent `json:"data,omitempty"`
	Privacy int32                                                               `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint64AndDestinyCharacterRenderComponent ¶

type DictionaryComponentResponseOfint64AndDestinyCharacterRenderComponent struct {
	Data    map[string]DestinyEntitiesCharactersDestinyCharacterRenderComponent `json:"data,omitempty"`
	Privacy int32                                                               `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint64AndDestinyCollectiblesComponent ¶

type DictionaryComponentResponseOfint64AndDestinyCollectiblesComponent struct {
	Data    map[string]DestinyComponentsCollectiblesDestinyCollectiblesComponent `json:"data,omitempty"`
	Privacy int32                                                                `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint64AndDestinyCraftablesComponent ¶

type DictionaryComponentResponseOfint64AndDestinyCraftablesComponent struct {
	Data    map[string]DestinyComponentsCraftablesDestinyCraftablesComponent `json:"data,omitempty"`
	Privacy int32                                                            `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint64AndDestinyCurrenciesComponent ¶

type DictionaryComponentResponseOfint64AndDestinyCurrenciesComponent struct {
	Data    map[string]DestinyComponentsInventoryDestinyCurrenciesComponent `json:"data,omitempty"`
	Privacy int32                                                           `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint64AndDestinyInventoryComponent ¶

type DictionaryComponentResponseOfint64AndDestinyInventoryComponent struct {
	Data    map[string]DestinyEntitiesInventoryDestinyInventoryComponent `json:"data,omitempty"`
	Privacy int32                                                        `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint64AndDestinyItemInstanceComponent ¶

type DictionaryComponentResponseOfint64AndDestinyItemInstanceComponent struct {
	Data    map[string]DestinyEntitiesItemsDestinyItemInstanceComponent `json:"data,omitempty"`
	Privacy int32                                                       `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint64AndDestinyItemObjectivesComponent ¶

type DictionaryComponentResponseOfint64AndDestinyItemObjectivesComponent struct {
	Data    map[string]DestinyEntitiesItemsDestinyItemObjectivesComponent `json:"data,omitempty"`
	Privacy int32                                                         `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint64AndDestinyItemPerksComponent ¶

type DictionaryComponentResponseOfint64AndDestinyItemPerksComponent struct {
	Data    map[string]DestinyEntitiesItemsDestinyItemPerksComponent `json:"data,omitempty"`
	Privacy int32                                                    `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint64AndDestinyItemPlugObjectivesComponent ¶

type DictionaryComponentResponseOfint64AndDestinyItemPlugObjectivesComponent struct {
	Data    map[string]DestinyComponentsItemsDestinyItemPlugObjectivesComponent `json:"data,omitempty"`
	Privacy int32                                                               `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint64AndDestinyItemRenderComponent ¶

type DictionaryComponentResponseOfint64AndDestinyItemRenderComponent struct {
	Data    map[string]DestinyEntitiesItemsDestinyItemRenderComponent `json:"data,omitempty"`
	Privacy int32                                                     `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint64AndDestinyItemReusablePlugsComponent ¶

type DictionaryComponentResponseOfint64AndDestinyItemReusablePlugsComponent struct {
	Data    map[string]DestinyComponentsItemsDestinyItemReusablePlugsComponent `json:"data,omitempty"`
	Privacy int32                                                              `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint64AndDestinyItemSocketsComponent ¶

type DictionaryComponentResponseOfint64AndDestinyItemSocketsComponent struct {
	Data    map[string]DestinyEntitiesItemsDestinyItemSocketsComponent `json:"data,omitempty"`
	Privacy int32                                                      `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint64AndDestinyItemStatsComponent ¶

type DictionaryComponentResponseOfint64AndDestinyItemStatsComponent struct {
	Data    map[string]DestinyEntitiesItemsDestinyItemStatsComponent `json:"data,omitempty"`
	Privacy int32                                                    `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint64AndDestinyItemTalentGridComponent ¶

type DictionaryComponentResponseOfint64AndDestinyItemTalentGridComponent struct {
	Data    map[string]DestinyEntitiesItemsDestinyItemTalentGridComponent `json:"data,omitempty"`
	Privacy int32                                                         `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint64AndDestinyKiosksComponent ¶

type DictionaryComponentResponseOfint64AndDestinyKiosksComponent struct {
	Data    map[string]DestinyComponentsKiosksDestinyKiosksComponent `json:"data,omitempty"`
	Privacy int32                                                    `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint64AndDestinyLoadoutsComponent ¶

type DictionaryComponentResponseOfint64AndDestinyLoadoutsComponent struct {
	Data    map[string]DestinyComponentsLoadoutsDestinyLoadoutsComponent `json:"data,omitempty"`
	Privacy int32                                                        `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint64AndDestinyPlugSetsComponent ¶

type DictionaryComponentResponseOfint64AndDestinyPlugSetsComponent struct {
	Data    map[string]DestinyComponentsPlugSetsDestinyPlugSetsComponent `json:"data,omitempty"`
	Privacy int32                                                        `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint64AndDestinyPresentationNodesComponent ¶

type DictionaryComponentResponseOfint64AndDestinyPresentationNodesComponent struct {
	Data    map[string]DestinyComponentsPresentationDestinyPresentationNodesComponent `json:"data,omitempty"`
	Privacy int32                                                                     `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfint64AndDestinyStringVariablesComponent ¶

type DictionaryComponentResponseOfint64AndDestinyStringVariablesComponent struct {
	Data    map[string]DestinyComponentsStringVariablesDestinyStringVariablesComponent `json:"data,omitempty"`
	Privacy int32                                                                      `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfuint32AndDestinyItemInstanceComponent ¶

type DictionaryComponentResponseOfuint32AndDestinyItemInstanceComponent struct {
	Data    map[string]DestinyEntitiesItemsDestinyItemInstanceComponent `json:"data,omitempty"`
	Privacy int32                                                       `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfuint32AndDestinyItemObjectivesComponent ¶

type DictionaryComponentResponseOfuint32AndDestinyItemObjectivesComponent struct {
	Data    map[string]DestinyEntitiesItemsDestinyItemObjectivesComponent `json:"data,omitempty"`
	Privacy int32                                                         `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfuint32AndDestinyItemPerksComponent ¶

type DictionaryComponentResponseOfuint32AndDestinyItemPerksComponent struct {
	Data    map[string]DestinyEntitiesItemsDestinyItemPerksComponent `json:"data,omitempty"`
	Privacy int32                                                    `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfuint32AndDestinyItemPlugComponent ¶

type DictionaryComponentResponseOfuint32AndDestinyItemPlugComponent struct {
	Data    map[string]DestinyComponentsItemsDestinyItemPlugComponent `json:"data,omitempty"`
	Privacy int32                                                     `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfuint32AndDestinyItemPlugObjectivesComponent ¶

type DictionaryComponentResponseOfuint32AndDestinyItemPlugObjectivesComponent struct {
	Data    map[string]DestinyComponentsItemsDestinyItemPlugObjectivesComponent `json:"data,omitempty"`
	Privacy int32                                                               `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfuint32AndDestinyItemRenderComponent ¶

type DictionaryComponentResponseOfuint32AndDestinyItemRenderComponent struct {
	Data    map[string]DestinyEntitiesItemsDestinyItemRenderComponent `json:"data,omitempty"`
	Privacy int32                                                     `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfuint32AndDestinyItemReusablePlugsComponent ¶

type DictionaryComponentResponseOfuint32AndDestinyItemReusablePlugsComponent struct {
	Data    map[string]DestinyComponentsItemsDestinyItemReusablePlugsComponent `json:"data,omitempty"`
	Privacy int32                                                              `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfuint32AndDestinyItemSocketsComponent ¶

type DictionaryComponentResponseOfuint32AndDestinyItemSocketsComponent struct {
	Data    map[string]DestinyEntitiesItemsDestinyItemSocketsComponent `json:"data,omitempty"`
	Privacy int32                                                      `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfuint32AndDestinyItemStatsComponent ¶

type DictionaryComponentResponseOfuint32AndDestinyItemStatsComponent struct {
	Data    map[string]DestinyEntitiesItemsDestinyItemStatsComponent `json:"data,omitempty"`
	Privacy int32                                                    `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfuint32AndDestinyItemTalentGridComponent ¶

type DictionaryComponentResponseOfuint32AndDestinyItemTalentGridComponent struct {
	Data    map[string]DestinyEntitiesItemsDestinyItemTalentGridComponent `json:"data,omitempty"`
	Privacy int32                                                         `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfuint32AndDestinyPublicVendorComponent ¶

type DictionaryComponentResponseOfuint32AndDestinyPublicVendorComponent struct {
	Data    map[string]DestinyComponentsVendorsDestinyPublicVendorComponent `json:"data,omitempty"`
	Privacy int32                                                           `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfuint32AndDestinyVendorCategoriesComponent ¶

type DictionaryComponentResponseOfuint32AndDestinyVendorCategoriesComponent struct {
	Data    map[string]DestinyEntitiesVendorsDestinyVendorCategoriesComponent `json:"data,omitempty"`
	Privacy int32                                                             `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfuint32AndDestinyVendorComponent ¶

type DictionaryComponentResponseOfuint32AndDestinyVendorComponent struct {
	Data    map[string]DestinyEntitiesVendorsDestinyVendorComponent `json:"data,omitempty"`
	Privacy int32                                                   `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfuint32AndPersonalDestinyVendorSaleItemSetComponent ¶

type DictionaryComponentResponseOfuint32AndPersonalDestinyVendorSaleItemSetComponent struct {
	Data    map[string]DestinyResponsesPersonalDestinyVendorSaleItemSetComponent `json:"data,omitempty"`
	Privacy int32                                                                `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type DictionaryComponentResponseOfuint32AndPublicDestinyVendorSaleItemSetComponent ¶

type DictionaryComponentResponseOfuint32AndPublicDestinyVendorSaleItemSetComponent struct {
	Data    map[string]DestinyResponsesPublicDestinyVendorSaleItemSetComponent `json:"data,omitempty"`
	Privacy int32                                                              `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type EntitiesEntityActionResult ¶

type EntitiesEntityActionResult struct {
	EntityId int64 `json:"entityId,omitempty"`
	Result   int32 `json:"result,omitempty"`
}

type ExceptionsPlatformErrorCodes ¶

type ExceptionsPlatformErrorCodes int32

type FireteamApiFireteamGetAvailableClanFireteamsOpts ¶

type FireteamApiFireteamGetAvailableClanFireteamsOpts struct {
	ExcludeImmediate optional.Bool
	LangFilter       optional.String
}

type FireteamApiFireteamGetMyClanFireteamsOpts ¶

type FireteamApiFireteamGetMyClanFireteamsOpts struct {
	GroupFilter optional.Bool
	LangFilter  optional.String
}

type FireteamApiFireteamSearchPublicAvailableClanFireteamsOpts ¶

type FireteamApiFireteamSearchPublicAvailableClanFireteamsOpts struct {
	ExcludeImmediate optional.Bool
	LangFilter       optional.String
}

type FireteamApiService ¶

type FireteamApiService service

func (*FireteamApiService) FireteamGetActivePrivateClanFireteamCount ¶

func (a *FireteamApiService) FireteamGetActivePrivateClanFireteamCount(ctx context.Context, groupId int64) (*http.Response, error)

FireteamApiService Gets a count of all active non-public fireteams for the specified clan. Maximum value returned is 25.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId The group id of the clan.

func (*FireteamApiService) FireteamGetAvailableClanFireteams ¶

func (a *FireteamApiService) FireteamGetAvailableClanFireteams(ctx context.Context, activityType int32, dateRange int32, groupId int64, page int32, platform int32, publicOnly int32, slotFilter int32, localVarOptionals *FireteamApiFireteamGetAvailableClanFireteamsOpts) (*http.Response, error)

func (*FireteamApiService) FireteamGetClanFireteam ¶

func (a *FireteamApiService) FireteamGetClanFireteam(ctx context.Context, fireteamId int64, groupId int64) (*http.Response, error)

FireteamApiService Gets a specific fireteam.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param fireteamId The unique id of the fireteam.
@param groupId The group id of the clan.

func (*FireteamApiService) FireteamGetMyClanFireteams ¶

func (a *FireteamApiService) FireteamGetMyClanFireteams(ctx context.Context, groupId int64, includeClosed bool, page int32, platform int32, localVarOptionals *FireteamApiFireteamGetMyClanFireteamsOpts) (*http.Response, error)

func (*FireteamApiService) FireteamSearchPublicAvailableClanFireteams ¶

func (a *FireteamApiService) FireteamSearchPublicAvailableClanFireteams(ctx context.Context, activityType int32, dateRange int32, page int32, platform int32, slotFilter int32, localVarOptionals *FireteamApiFireteamSearchPublicAvailableClanFireteamsOpts) (*http.Response, error)

type FireteamFireteamDateRange ¶

type FireteamFireteamDateRange int32

type FireteamFireteamMember ¶

type FireteamFireteamMember struct {
	DestinyUserInfo                 *FireteamFireteamUserInfoCard `json:"destinyUserInfo,omitempty"`
	BungieNetUserInfo               *UserUserInfoCard             `json:"bungieNetUserInfo,omitempty"`
	CharacterId                     int64                         `json:"characterId,omitempty"`
	DateJoined                      time.Time                     `json:"dateJoined,omitempty"`
	HasMicrophone                   bool                          `json:"hasMicrophone,omitempty"`
	LastPlatformInviteAttemptDate   time.Time                     `json:"lastPlatformInviteAttemptDate,omitempty"`
	LastPlatformInviteAttemptResult int32                         `json:"lastPlatformInviteAttemptResult,omitempty"`
}

type FireteamFireteamPlatform ¶

type FireteamFireteamPlatform int32

type FireteamFireteamPlatformInviteResult ¶

type FireteamFireteamPlatformInviteResult int32

type FireteamFireteamPublicSearchOption ¶

type FireteamFireteamPublicSearchOption int32

type FireteamFireteamResponse ¶

type FireteamFireteamResponse struct {
	Summary    *FireteamFireteamSummary `json:"Summary,omitempty"`
	Members    []FireteamFireteamMember `json:"Members,omitempty"`
	Alternates []FireteamFireteamMember `json:"Alternates,omitempty"`
}

type FireteamFireteamSlotSearch ¶

type FireteamFireteamSlotSearch int32

type FireteamFireteamSummary ¶

type FireteamFireteamSummary struct {
	FireteamId                               int64     `json:"fireteamId,omitempty"`
	GroupId                                  int64     `json:"groupId,omitempty"`
	Platform                                 int32     `json:"platform,omitempty"`
	ActivityType                             int32     `json:"activityType,omitempty"`
	IsImmediate                              bool      `json:"isImmediate,omitempty"`
	ScheduledTime                            time.Time `json:"scheduledTime,omitempty"`
	OwnerMembershipId                        int64     `json:"ownerMembershipId,omitempty"`
	PlayerSlotCount                          int32     `json:"playerSlotCount,omitempty"`
	AlternateSlotCount                       int32     `json:"alternateSlotCount,omitempty"`
	AvailablePlayerSlotCount                 int32     `json:"availablePlayerSlotCount,omitempty"`
	AvailableAlternateSlotCount              int32     `json:"availableAlternateSlotCount,omitempty"`
	Title                                    string    `json:"title,omitempty"`
	DateCreated                              time.Time `json:"dateCreated,omitempty"`
	DateModified                             time.Time `json:"dateModified,omitempty"`
	IsPublic                                 bool      `json:"isPublic,omitempty"`
	Locale                                   string    `json:"locale,omitempty"`
	IsValid                                  bool      `json:"isValid,omitempty"`
	DatePlayerModified                       time.Time `json:"datePlayerModified,omitempty"`
	TitleBeforeModeration                    string    `json:"titleBeforeModeration,omitempty"`
	OwnerCurrentGuardianRankSnapshot         int32     `json:"ownerCurrentGuardianRankSnapshot,omitempty"`
	OwnerHighestLifetimeGuardianRankSnapshot int32     `json:"ownerHighestLifetimeGuardianRankSnapshot,omitempty"`
	OwnerTotalCommendationScoreSnapshot      int32     `json:"ownerTotalCommendationScoreSnapshot,omitempty"`
}

type FireteamFireteamUserInfoCard ¶

type FireteamFireteamUserInfoCard struct {
	FireteamDisplayName    string `json:"FireteamDisplayName,omitempty"`
	FireteamMembershipType int32  `json:"FireteamMembershipType,omitempty"`
	// A platform specific additional display name - ex: psn Real Name, bnet Unique Name, etc.
	SupplementalDisplayName string `json:"supplementalDisplayName,omitempty"`
	// URL the Icon if available.
	IconPath string `json:"iconPath,omitempty"`
	// If there is a cross save override in effect, this value will tell you the type that is overridding this one.
	CrossSaveOverride int32 `json:"crossSaveOverride,omitempty"`
	// 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
	ApplicableMembershipTypes []int32 `json:"applicableMembershipTypes,omitempty"`
	// If True, this is a public user membership.
	IsPublic bool `json:"isPublic,omitempty"`
	// Type of the membership. Not necessarily the native type.
	MembershipType int32 `json:"membershipType,omitempty"`
	// Membership ID as they user is known in the Accounts service
	MembershipId int64 `json:"membershipId,omitempty"`
	// 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.
	DisplayName string `json:"displayName,omitempty"`
	// The bungie global display name, if set.
	BungieGlobalDisplayName string `json:"bungieGlobalDisplayName,omitempty"`
	// The bungie global display name code, if set.
	BungieGlobalDisplayNameCode int32 `json:"bungieGlobalDisplayNameCode,omitempty"`
}

type ForumApiForumGetCoreTopicsPagedOpts ¶

type ForumApiForumGetCoreTopicsPagedOpts struct {
	Locales optional.String
}

type ForumApiForumGetForumTagSuggestionsOpts ¶

type ForumApiForumGetForumTagSuggestionsOpts struct {
	Partialtag optional.String
}

type ForumApiForumGetPostAndParentAwaitingApprovalOpts ¶

type ForumApiForumGetPostAndParentAwaitingApprovalOpts struct {
	Showbanned optional.String
}

type ForumApiForumGetPostAndParentOpts ¶

type ForumApiForumGetPostAndParentOpts struct {
	Showbanned optional.String
}

type ForumApiForumGetPostsThreadedPagedFromChildOpts ¶

type ForumApiForumGetPostsThreadedPagedFromChildOpts struct {
	Showbanned optional.String
}

type ForumApiForumGetPostsThreadedPagedOpts ¶

type ForumApiForumGetPostsThreadedPagedOpts struct {
	Showbanned optional.String
}

type ForumApiForumGetTopicsPagedOpts ¶

type ForumApiForumGetTopicsPagedOpts struct {
	Locales   optional.String
	Tagstring optional.String
}

type ForumApiService ¶

type ForumApiService service

func (*ForumApiService) ForumGetCoreTopicsPaged ¶

func (a *ForumApiService) ForumGetCoreTopicsPaged(ctx context.Context, categoryFilter int32, page int32, quickDate int32, sort int32, localVarOptionals *ForumApiForumGetCoreTopicsPagedOpts) (*http.Response, error)

func (*ForumApiService) ForumGetForumTagSuggestions ¶

func (a *ForumApiService) ForumGetForumTagSuggestions(ctx context.Context, localVarOptionals *ForumApiForumGetForumTagSuggestionsOpts) (*http.Response, error)

func (*ForumApiService) ForumGetPoll ¶

func (a *ForumApiService) ForumGetPoll(ctx context.Context, topicId int64) (*http.Response, error)

ForumApiService Gets the specified forum poll.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param topicId The post id of the topic that has the poll.

func (*ForumApiService) ForumGetPostAndParent ¶

func (a *ForumApiService) ForumGetPostAndParent(ctx context.Context, childPostId int64, localVarOptionals *ForumApiForumGetPostAndParentOpts) (*http.Response, error)

func (*ForumApiService) ForumGetPostAndParentAwaitingApproval ¶

func (a *ForumApiService) ForumGetPostAndParentAwaitingApproval(ctx context.Context, childPostId int64, localVarOptionals *ForumApiForumGetPostAndParentAwaitingApprovalOpts) (*http.Response, error)

func (*ForumApiService) ForumGetPostsThreadedPaged ¶

func (a *ForumApiService) ForumGetPostsThreadedPaged(ctx context.Context, getParentPost bool, page int32, pageSize int32, parentPostId int64, replySize int32, rootThreadMode bool, sortMode int32, localVarOptionals *ForumApiForumGetPostsThreadedPagedOpts) (*http.Response, error)

func (*ForumApiService) ForumGetPostsThreadedPagedFromChild ¶

func (a *ForumApiService) ForumGetPostsThreadedPagedFromChild(ctx context.Context, childPostId int64, page int32, pageSize int32, replySize int32, rootThreadMode bool, sortMode int32, localVarOptionals *ForumApiForumGetPostsThreadedPagedFromChildOpts) (*http.Response, error)

func (*ForumApiService) ForumGetRecruitmentThreadSummaries ¶

func (a *ForumApiService) ForumGetRecruitmentThreadSummaries(ctx context.Context, body []int64) (*http.Response, error)

ForumApiService Allows the caller to get a list of to 25 recruitment thread summary information objects.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*ForumApiService) ForumGetTopicForContent ¶

func (a *ForumApiService) ForumGetTopicForContent(ctx context.Context, contentId int64) (*http.Response, error)

ForumApiService Gets the post Id for the given content item's comments, if it exists.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param contentId

func (*ForumApiService) ForumGetTopicsPaged ¶

func (a *ForumApiService) ForumGetTopicsPaged(ctx context.Context, categoryFilter int32, group int64, page int32, pageSize int32, quickDate int32, sort int32, localVarOptionals *ForumApiForumGetTopicsPagedOpts) (*http.Response, error)

type ForumCommunityContentSortMode ¶

type ForumCommunityContentSortMode int32

type ForumForumMediaType ¶

type ForumForumMediaType int32

type ForumForumPostPopularity ¶

type ForumForumPostPopularity int32

type ForumForumPostSortEnum ¶

type ForumForumPostSortEnum int32

type ForumForumRecruitmentDetail ¶

type ForumForumRecruitmentDetail struct {
	TopicId              int64             `json:"topicId,omitempty"`
	MicrophoneRequired   bool              `json:"microphoneRequired,omitempty"`
	Intensity            int32             `json:"intensity,omitempty"`
	Tone                 int32             `json:"tone,omitempty"`
	Approved             bool              `json:"approved,omitempty"`
	ConversationId       int64             `json:"conversationId,omitempty"`
	PlayerSlotsTotal     int32             `json:"playerSlotsTotal,omitempty"`
	PlayerSlotsRemaining int32             `json:"playerSlotsRemaining,omitempty"`
	Fireteam             []UserGeneralUser `json:"Fireteam,omitempty"`
	KickedPlayerIds      []int64           `json:"kickedPlayerIds,omitempty"`
}

type ForumForumRecruitmentIntensityLabel ¶

type ForumForumRecruitmentIntensityLabel int32

type ForumForumRecruitmentToneLabel ¶

type ForumForumRecruitmentToneLabel int32

type ForumForumTopicsCategoryFiltersEnum ¶

type ForumForumTopicsCategoryFiltersEnum int32

type ForumForumTopicsQuickDateEnum ¶

type ForumForumTopicsQuickDateEnum int32

type ForumForumTopicsSortEnum ¶

type ForumForumTopicsSortEnum int32

type ForumPollResponse ¶

type ForumPollResponse struct {
	TopicId    int64             `json:"topicId,omitempty"`
	Results    []ForumPollResult `json:"results,omitempty"`
	TotalVotes int32             `json:"totalVotes,omitempty"`
}

type ForumPollResult ¶

type ForumPollResult struct {
	AnswerText          string    `json:"answerText,omitempty"`
	AnswerSlot          int32     `json:"answerSlot,omitempty"`
	LastVoteDate        time.Time `json:"lastVoteDate,omitempty"`
	Votes               int32     `json:"votes,omitempty"`
	RequestingUserVoted bool      `json:"requestingUserVoted,omitempty"`
}

type ForumPostResponse ¶

type ForumPostResponse struct {
	LastReplyTimestamp  time.Time              `json:"lastReplyTimestamp,omitempty"`
	IsPinned            bool                   `json:"IsPinned,omitempty"`
	UrlMediaType        int32                  `json:"urlMediaType,omitempty"`
	Thumbnail           string                 `json:"thumbnail,omitempty"`
	Popularity          int32                  `json:"popularity,omitempty"`
	IsActive            bool                   `json:"isActive,omitempty"`
	IsAnnouncement      bool                   `json:"isAnnouncement,omitempty"`
	UserRating          int32                  `json:"userRating,omitempty"`
	UserHasRated        bool                   `json:"userHasRated,omitempty"`
	UserHasMutedPost    bool                   `json:"userHasMutedPost,omitempty"`
	LatestReplyPostId   int64                  `json:"latestReplyPostId,omitempty"`
	LatestReplyAuthorId int64                  `json:"latestReplyAuthorId,omitempty"`
	IgnoreStatus        *IgnoresIgnoreResponse `json:"ignoreStatus,omitempty"`
	Locale              string                 `json:"locale,omitempty"`
}

type ForumPostSearchResponse ¶

type ForumPostSearchResponse struct {
	RelatedPosts                 []ForumPostResponse              `json:"relatedPosts,omitempty"`
	Authors                      []UserGeneralUser                `json:"authors,omitempty"`
	Groups                       []GroupsV2GroupResponse          `json:"groups,omitempty"`
	SearchedTags                 []TagsModelsContractsTagResponse `json:"searchedTags,omitempty"`
	Polls                        []ForumPollResponse              `json:"polls,omitempty"`
	RecruitmentDetails           []ForumForumRecruitmentDetail    `json:"recruitmentDetails,omitempty"`
	AvailablePages               int32                            `json:"availablePages,omitempty"`
	Results                      []ForumPostResponse              `json:"results,omitempty"`
	TotalResults                 int32                            `json:"totalResults,omitempty"`
	HasMore                      bool                             `json:"hasMore,omitempty"`
	Query                        *QueriesPagedQuery               `json:"query,omitempty"`
	ReplacementContinuationToken string                           `json:"replacementContinuationToken,omitempty"`
	// If useTotalResults is true, then totalResults represents an accurate count.  If False, it does not, and may be estimated/only the size of the current page.  Either way, you should probably always only trust hasMore.  This is a long-held historical throwback to when we used to do paging with known total results. Those queries toasted our database, and we were left to hastily alter our endpoints and create backward- compatible shims, of which useTotalResults is one.
	UseTotalResults bool `json:"useTotalResults,omitempty"`
}

type ForumsForumFlagsEnum ¶

type ForumsForumFlagsEnum int32

type ForumsForumPostCategoryEnums ¶

type ForumsForumPostCategoryEnums int32

type GenericSwaggerError ¶

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type GlobalAlert ¶

type GlobalAlert struct {
	AlertKey       string      `json:"AlertKey,omitempty"`
	AlertHtml      string      `json:"AlertHtml,omitempty"`
	AlertTimestamp time.Time   `json:"AlertTimestamp,omitempty"`
	AlertLink      string      `json:"AlertLink,omitempty"`
	AlertLevel     int32       `json:"AlertLevel,omitempty"`
	AlertType      int32       `json:"AlertType,omitempty"`
	StreamInfo     *StreamInfo `json:"StreamInfo,omitempty"`
}

type GlobalAlertLevel ¶

type GlobalAlertLevel int32

type GlobalAlertType ¶

type GlobalAlertType int32

type GroupV2ApiGroupV2GetMembersOfGroupcurrentPageOpts ¶

type GroupV2ApiGroupV2GetMembersOfGroupcurrentPageOpts struct {
	MemberType optional.Int32
	NameSearch optional.String
}

type GroupV2ApiService ¶

type GroupV2ApiService service

func (*GroupV2ApiService) GroupV2AbdicateFoundership ¶

func (a *GroupV2ApiService) GroupV2AbdicateFoundership(ctx context.Context, founderIdNew int64, groupId int64, membershipType int32) (*http.Response, error)

GroupV2ApiService An administrative method to allow the founder of a group or clan to give up their position to another admin permanently.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param founderIdNew The new founder for this group. Must already be a group admin.
@param groupId The target group id.
@param membershipType Membership type of the provided founderIdNew.

func (*GroupV2ApiService) GroupV2AddOptionalConversation ¶

func (a *GroupV2ApiService) GroupV2AddOptionalConversation(ctx context.Context, body GroupsV2GroupOptionalConversationAddRequest, groupId int64) (*http.Response, error)

GroupV2ApiService Add a new optional conversation/chat channel. Requires admin permissions to the group.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param groupId Group ID of the group to edit.

func (*GroupV2ApiService) GroupV2ApproveAllPending ¶

func (a *GroupV2ApiService) GroupV2ApproveAllPending(ctx context.Context, body GroupsV2GroupApplicationRequest, groupId int64) (InlineResponse2001, *http.Response, error)

GroupV2ApiService Approve all of the pending users for the given group.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param groupId ID of the group.

@return InlineResponse2001

func (*GroupV2ApiService) GroupV2ApprovePending ¶

func (a *GroupV2ApiService) GroupV2ApprovePending(ctx context.Context, body GroupsV2GroupApplicationRequest, groupId int64, membershipId int64, membershipType int32) (*http.Response, error)

GroupV2ApiService Approve the given membershipId to join the group/clan as long as they have applied.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param groupId ID of the group.
@param membershipId The membership id being approved.
@param membershipType Membership type of the supplied membership ID.

func (*GroupV2ApiService) GroupV2ApprovePendingForList ¶

func (a *GroupV2ApiService) GroupV2ApprovePendingForList(ctx context.Context, body GroupsV2GroupApplicationListRequest, groupId int64) (InlineResponse2001, *http.Response, error)

GroupV2ApiService Approve all of the pending users for the given group.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param groupId ID of the group.

@return InlineResponse2001

func (*GroupV2ApiService) GroupV2BanMember ¶

func (a *GroupV2ApiService) GroupV2BanMember(ctx context.Context, body GroupsV2GroupBanRequest, groupId int64, membershipId int64, membershipType int32) (*http.Response, error)

GroupV2ApiService Bans the requested member from the requested group for the specified period of time.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param groupId Group ID that has the member to ban.
@param membershipId Membership ID of the member to ban from the group.
@param membershipType Membership type of the provided membership ID.

func (*GroupV2ApiService) GroupV2DenyAllPending ¶

func (a *GroupV2ApiService) GroupV2DenyAllPending(ctx context.Context, body GroupsV2GroupApplicationRequest, groupId int64) (InlineResponse2001, *http.Response, error)

GroupV2ApiService Deny all of the pending users for the given group.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param groupId ID of the group.

@return InlineResponse2001

func (*GroupV2ApiService) GroupV2DenyPendingForList ¶

func (a *GroupV2ApiService) GroupV2DenyPendingForList(ctx context.Context, body GroupsV2GroupApplicationListRequest, groupId int64) (InlineResponse2001, *http.Response, error)

GroupV2ApiService Deny all of the pending users for the given group that match the passed-in .

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param groupId ID of the group.

@return InlineResponse2001

func (*GroupV2ApiService) GroupV2EditClanBanner ¶

func (a *GroupV2ApiService) GroupV2EditClanBanner(ctx context.Context, body GroupsV2ClanBanner, groupId int64) (*http.Response, error)

GroupV2ApiService Edit an existing group's clan banner. You must have suitable permissions in the group to perform this operation. All fields are required.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param groupId Group ID of the group to edit.

func (*GroupV2ApiService) GroupV2EditFounderOptions ¶

func (a *GroupV2ApiService) GroupV2EditFounderOptions(ctx context.Context, body GroupsV2GroupOptionsEditAction, groupId int64) (*http.Response, error)

GroupV2ApiService Edit group options only available to a founder. You must have suitable permissions in the group to perform this operation.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param groupId Group ID of the group to edit.

func (*GroupV2ApiService) GroupV2EditGroup ¶

func (a *GroupV2ApiService) GroupV2EditGroup(ctx context.Context, body GroupsV2GroupEditAction, groupId int64) (*http.Response, error)

GroupV2ApiService Edit an existing group. You must have suitable permissions in the group to perform this operation. This latest revision will only edit the fields you pass in - pass null for properties you want to leave unaltered.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param groupId Group ID of the group to edit.

func (*GroupV2ApiService) GroupV2EditGroupMembership ¶

func (a *GroupV2ApiService) GroupV2EditGroupMembership(ctx context.Context, groupId int64, membershipId int64, membershipType int32, memberType int32) (*http.Response, error)

GroupV2ApiService Edit the membership type of a given member. You must have suitable permissions in the group to perform this operation.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId ID of the group to which the member belongs.
@param membershipId Membership ID to modify.
@param membershipType Membership type of the provide membership ID.
@param memberType New membertype for the specified member.

func (*GroupV2ApiService) GroupV2EditOptionalConversation ¶

func (a *GroupV2ApiService) GroupV2EditOptionalConversation(ctx context.Context, body GroupsV2GroupOptionalConversationEditRequest, conversationId int64, groupId int64) (*http.Response, error)

GroupV2ApiService Edit the settings of an optional conversation/chat channel. Requires admin permissions to the group.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param conversationId Conversation Id of the channel being edited.
@param groupId Group ID of the group to edit.

func (*GroupV2ApiService) GroupV2GetAdminsAndFounderOfGroup ¶

func (a *GroupV2ApiService) GroupV2GetAdminsAndFounderOfGroup(ctx context.Context, currentpage int32, groupId int64) (*http.Response, error)

GroupV2ApiService Get the list of members in a given group who are of admin level or higher.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param currentpage Page number (starting with 1). Each page has a fixed size of 50 items per page.
@param groupId The ID of the group.

func (*GroupV2ApiService) GroupV2GetAvailableAvatars ¶

func (a *GroupV2ApiService) GroupV2GetAvailableAvatars(ctx context.Context) (InlineResponse200, *http.Response, error)

GroupV2ApiService Returns a list of all available group avatars for the signed-in user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return InlineResponse200

func (*GroupV2ApiService) GroupV2GetAvailableThemes ¶

func (a *GroupV2ApiService) GroupV2GetAvailableThemes(ctx context.Context) (*http.Response, error)

GroupV2ApiService Returns a list of all available group themes.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*GroupV2ApiService) GroupV2GetBannedMembersOfGroup ¶

func (a *GroupV2ApiService) GroupV2GetBannedMembersOfGroup(ctx context.Context, currentpage int32, groupId int64) (*http.Response, error)

GroupV2ApiService Get the list of banned members in a given group. Only accessible to group Admins and above. Not applicable to all groups. Check group features.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param currentpage Page number (starting with 1). Each page has a fixed size of 50 entries.
@param groupId Group ID whose banned members you are fetching

func (*GroupV2ApiService) GroupV2GetGroup ¶

func (a *GroupV2ApiService) GroupV2GetGroup(ctx context.Context, groupId int64) (*http.Response, error)

GroupV2ApiService Get information about a specific group of the given ID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId Requested group's id.

func (*GroupV2ApiService) GroupV2GetGroupByName ¶

func (a *GroupV2ApiService) GroupV2GetGroupByName(ctx context.Context, groupName string, groupType int32) (*http.Response, error)

GroupV2ApiService Get information about a specific group with the given name and type.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupName Exact name of the group to find.
@param groupType Type of group to find.

func (*GroupV2ApiService) GroupV2GetGroupByNameV2 ¶

func (a *GroupV2ApiService) GroupV2GetGroupByNameV2(ctx context.Context, body GroupsV2GroupNameSearchRequest) (*http.Response, error)

GroupV2ApiService Get information about a specific group with the given name and type. The POST version.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*GroupV2ApiService) GroupV2GetGroupOptionalConversations ¶

func (a *GroupV2ApiService) GroupV2GetGroupOptionalConversations(ctx context.Context, groupId int64) (*http.Response, error)

GroupV2ApiService Gets a list of available optional conversation channels and their settings.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId Requested group's id.

func (*GroupV2ApiService) GroupV2GetGroupsForMember ¶

func (a *GroupV2ApiService) GroupV2GetGroupsForMember(ctx context.Context, filter int32, groupType int32, membershipId int64, membershipType int32) (*http.Response, error)

GroupV2ApiService Get information about the groups that a given member has joined.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param filter Filter apply to list of joined groups.
@param groupType Type of group the supplied member founded.
@param membershipId Membership ID to for which to find founded groups.
@param membershipType Membership type of the supplied membership ID.

func (*GroupV2ApiService) GroupV2GetInvitedIndividuals ¶

func (a *GroupV2ApiService) GroupV2GetInvitedIndividuals(ctx context.Context, currentpage int32, groupId int64) (*http.Response, error)

GroupV2ApiService Get the list of users who have been invited into the group.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param currentpage Page number (starting with 1). Each page has a fixed size of 50 items per page.
@param groupId ID of the group.

func (*GroupV2ApiService) GroupV2GetMembersOfGroupcurrentPage ¶

func (a *GroupV2ApiService) GroupV2GetMembersOfGroupcurrentPage(ctx context.Context, currentpage int32, groupId int64, localVarOptionals *GroupV2ApiGroupV2GetMembersOfGroupcurrentPageOpts) (*http.Response, error)

func (*GroupV2ApiService) GroupV2GetPendingMemberships ¶

func (a *GroupV2ApiService) GroupV2GetPendingMemberships(ctx context.Context, currentpage int32, groupId int64) (*http.Response, error)

GroupV2ApiService Get the list of users who are awaiting a decision on their application to join a given group. Modified to include application info.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param currentpage Page number (starting with 1). Each page has a fixed size of 50 items per page.
@param groupId ID of the group.

func (*GroupV2ApiService) GroupV2GetPotentialGroupsForMember ¶

func (a *GroupV2ApiService) GroupV2GetPotentialGroupsForMember(ctx context.Context, filter int32, groupType int32, membershipId int64, membershipType int32) (*http.Response, error)

GroupV2ApiService Get information about the groups that a given member has applied to or been invited to.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param filter Filter apply to list of potential joined groups.
@param groupType Type of group the supplied member applied.
@param membershipId Membership ID to for which to find applied groups.
@param membershipType Membership type of the supplied membership ID.

func (*GroupV2ApiService) GroupV2GetRecommendedGroups ¶

func (a *GroupV2ApiService) GroupV2GetRecommendedGroups(ctx context.Context, createDateRange int32, groupType int32) (*http.Response, error)

GroupV2ApiService Gets groups recommended for you based on the groups to whom those you follow belong.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param createDateRange Requested range in which to pull recommended groups
@param groupType Type of groups requested

func (*GroupV2ApiService) GroupV2GetUserClanInviteSetting ¶

func (a *GroupV2ApiService) GroupV2GetUserClanInviteSetting(ctx context.Context, mType int32) (*http.Response, error)

GroupV2ApiService Gets the state of the user's clan invite preferences for a particular membership type - true if they wish to be invited to clans, false otherwise.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param mType The Destiny membership type of the account we wish to access settings.

func (*GroupV2ApiService) GroupV2GroupSearch ¶

func (a *GroupV2ApiService) GroupV2GroupSearch(ctx context.Context, body GroupsV2GroupQuery) (*http.Response, error)

GroupV2ApiService Search for Groups.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*GroupV2ApiService) GroupV2IndividualGroupInvite ¶

func (a *GroupV2ApiService) GroupV2IndividualGroupInvite(ctx context.Context, body GroupsV2GroupApplicationRequest, groupId int64, membershipId int64, membershipType int32) (*http.Response, error)

GroupV2ApiService Invite a user to join this group.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param groupId ID of the group you would like to join.
@param membershipId Membership id of the account being invited.
@param membershipType MembershipType of the account being invited.

func (*GroupV2ApiService) GroupV2IndividualGroupInviteCancel ¶

func (a *GroupV2ApiService) GroupV2IndividualGroupInviteCancel(ctx context.Context, groupId int64, membershipId int64, membershipType int32) (*http.Response, error)

GroupV2ApiService Cancels a pending invitation to join a group.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId ID of the group you would like to join.
@param membershipId Membership id of the account being cancelled.
@param membershipType MembershipType of the account being cancelled.

func (*GroupV2ApiService) GroupV2KickMember ¶

func (a *GroupV2ApiService) GroupV2KickMember(ctx context.Context, groupId int64, membershipId int64, membershipType int32) (*http.Response, error)

GroupV2ApiService Kick a member from the given group, forcing them to reapply if they wish to re-join the group. You must have suitable permissions in the group to perform this operation.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId Group ID to kick the user from.
@param membershipId Membership ID to kick.
@param membershipType Membership type of the provided membership ID.

func (*GroupV2ApiService) GroupV2RecoverGroupForFounder ¶

func (a *GroupV2ApiService) GroupV2RecoverGroupForFounder(ctx context.Context, groupType int32, membershipId int64, membershipType int32) (*http.Response, error)

GroupV2ApiService Allows a founder to manually recover a group they can see in game but not on bungie.net

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupType Type of group the supplied member founded.
@param membershipId Membership ID to for which to find founded groups.
@param membershipType Membership type of the supplied membership ID.

func (*GroupV2ApiService) GroupV2UnbanMember ¶

func (a *GroupV2ApiService) GroupV2UnbanMember(ctx context.Context, groupId int64, membershipId int64, membershipType int32) (*http.Response, error)

GroupV2ApiService Unbans the requested member, allowing them to re-apply for membership.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId
@param membershipId Membership ID of the member to unban from the group
@param membershipType Membership type of the provided membership ID.

type GroupsV2Capabilities ¶

type GroupsV2Capabilities int32

type GroupsV2ChatSecuritySetting ¶

type GroupsV2ChatSecuritySetting int32

type GroupsV2ClanBanner ¶

type GroupsV2ClanBanner struct {
	DecalId                int32 `json:"decalId,omitempty"`
	DecalColorId           int32 `json:"decalColorId,omitempty"`
	DecalBackgroundColorId int32 `json:"decalBackgroundColorId,omitempty"`
	GonfalonId             int32 `json:"gonfalonId,omitempty"`
	GonfalonColorId        int32 `json:"gonfalonColorId,omitempty"`
	GonfalonDetailId       int32 `json:"gonfalonDetailId,omitempty"`
	GonfalonDetailColorId  int32 `json:"gonfalonDetailColorId,omitempty"`
}

type GroupsV2GetGroupsForMemberResponse ¶

type GroupsV2GetGroupsForMemberResponse struct {
	// A convenience property that indicates if every membership this user has that is a part of this group are part of an account that is considered inactive - for example, overridden accounts in Cross Save.   The key is the Group ID for the group being checked, and the value is true if the users' memberships for that group are all inactive.
	AreAllMembershipsInactive    map[string]bool           `json:"areAllMembershipsInactive,omitempty"`
	Results                      []GroupsV2GroupMembership `json:"results,omitempty"`
	TotalResults                 int32                     `json:"totalResults,omitempty"`
	HasMore                      bool                      `json:"hasMore,omitempty"`
	Query                        *QueriesPagedQuery        `json:"query,omitempty"`
	ReplacementContinuationToken string                    `json:"replacementContinuationToken,omitempty"`
	// If useTotalResults is true, then totalResults represents an accurate count.  If False, it does not, and may be estimated/only the size of the current page.  Either way, you should probably always only trust hasMore.  This is a long-held historical throwback to when we used to do paging with known total results. Those queries toasted our database, and we were left to hastily alter our endpoints and create backward- compatible shims, of which useTotalResults is one.
	UseTotalResults bool `json:"useTotalResults,omitempty"`
}

type GroupsV2GroupAllianceStatus ¶

type GroupsV2GroupAllianceStatus int32

type GroupsV2GroupApplicationListRequest ¶

type GroupsV2GroupApplicationListRequest struct {
	Memberships []UserUserMembership `json:"memberships,omitempty"`
	Message     string               `json:"message,omitempty"`
}

type GroupsV2GroupApplicationRequest ¶

type GroupsV2GroupApplicationRequest struct {
	Message string `json:"message,omitempty"`
}

type GroupsV2GroupApplicationResolveState ¶

type GroupsV2GroupApplicationResolveState int32

type GroupsV2GroupApplicationResponse ¶

type GroupsV2GroupApplicationResponse struct {
	Resolution int32 `json:"resolution,omitempty"`
}

type GroupsV2GroupBan ¶

type GroupsV2GroupBan struct {
	GroupId           int64                      `json:"groupId,omitempty"`
	LastModifiedBy    *UserUserInfoCard          `json:"lastModifiedBy,omitempty"`
	CreatedBy         *UserUserInfoCard          `json:"createdBy,omitempty"`
	DateBanned        time.Time                  `json:"dateBanned,omitempty"`
	DateExpires       time.Time                  `json:"dateExpires,omitempty"`
	Comment           string                     `json:"comment,omitempty"`
	BungieNetUserInfo *UserUserInfoCard          `json:"bungieNetUserInfo,omitempty"`
	DestinyUserInfo   *GroupsV2GroupUserInfoCard `json:"destinyUserInfo,omitempty"`
}

type GroupsV2GroupBanRequest ¶

type GroupsV2GroupBanRequest struct {
	Comment string `json:"comment,omitempty"`
	Length  int32  `json:"length,omitempty"`
}

type GroupsV2GroupDateRange ¶

type GroupsV2GroupDateRange int32

type GroupsV2GroupEditAction ¶

type GroupsV2GroupEditAction struct {
	Name                               string `json:"name,omitempty"`
	About                              string `json:"about,omitempty"`
	Motto                              string `json:"motto,omitempty"`
	Theme                              string `json:"theme,omitempty"`
	AvatarImageIndex                   int32  `json:"avatarImageIndex,omitempty"`
	Tags                               string `json:"tags,omitempty"`
	IsPublic                           bool   `json:"isPublic,omitempty"`
	MembershipOption                   int32  `json:"membershipOption,omitempty"`
	IsPublicTopicAdminOnly             bool   `json:"isPublicTopicAdminOnly,omitempty"`
	AllowChat                          bool   `json:"allowChat,omitempty"`
	ChatSecurity                       int32  `json:"chatSecurity,omitempty"`
	Callsign                           string `json:"callsign,omitempty"`
	Locale                             string `json:"locale,omitempty"`
	Homepage                           int32  `json:"homepage,omitempty"`
	EnableInvitationMessagingForAdmins bool   `json:"enableInvitationMessagingForAdmins,omitempty"`
	DefaultPublicity                   int32  `json:"defaultPublicity,omitempty"`
}

type GroupsV2GroupFeatures ¶

type GroupsV2GroupFeatures struct {
	MaximumMembers int32 `json:"maximumMembers,omitempty"`
	// Maximum number of groups of this type a typical membership may join. For example, a user may join about 50 General groups with their Bungie.net account. They may join one clan per Destiny membership.
	MaximumMembershipsOfGroupType int32   `json:"maximumMembershipsOfGroupType,omitempty"`
	Capabilities                  int32   `json:"capabilities,omitempty"`
	MembershipTypes               []int32 `json:"membershipTypes,omitempty"`
	// Minimum Member Level allowed to invite new members to group  Always Allowed: Founder, Acting Founder  True means admins have this power, false means they don't  Default is false for clans, true for groups.
	InvitePermissionOverride bool `json:"invitePermissionOverride,omitempty"`
	// Minimum Member Level allowed to update group culture  Always Allowed: Founder, Acting Founder  True means admins have this power, false means they don't  Default is false for clans, true for groups.
	UpdateCulturePermissionOverride bool `json:"updateCulturePermissionOverride,omitempty"`
	// Minimum Member Level allowed to host guided games  Always Allowed: Founder, Acting Founder, Admin  Allowed Overrides: None, Member, Beginner  Default is Member for clans, None for groups, although this means nothing for groups.
	HostGuidedGamePermissionOverride int32 `json:"hostGuidedGamePermissionOverride,omitempty"`
	// Minimum Member Level allowed to update banner  Always Allowed: Founder, Acting Founder  True means admins have this power, false means they don't  Default is false for clans, true for groups.
	UpdateBannerPermissionOverride bool `json:"updateBannerPermissionOverride,omitempty"`
	// Level to join a member at when accepting an invite, application, or joining an open clan  Default is Beginner.
	JoinLevel int32 `json:"joinLevel,omitempty"`
}

type GroupsV2GroupHomepage ¶

type GroupsV2GroupHomepage int32

type GroupsV2GroupMember ¶

type GroupsV2GroupMember struct {
	MemberType             int32                      `json:"memberType,omitempty"`
	IsOnline               bool                       `json:"isOnline,omitempty"`
	LastOnlineStatusChange int64                      `json:"lastOnlineStatusChange,omitempty"`
	GroupId                int64                      `json:"groupId,omitempty"`
	DestinyUserInfo        *GroupsV2GroupUserInfoCard `json:"destinyUserInfo,omitempty"`
	BungieNetUserInfo      *UserUserInfoCard          `json:"bungieNetUserInfo,omitempty"`
	JoinDate               time.Time                  `json:"joinDate,omitempty"`
}

type GroupsV2GroupMemberApplication ¶

type GroupsV2GroupMemberApplication struct {
	GroupId                int64                      `json:"groupId,omitempty"`
	CreationDate           time.Time                  `json:"creationDate,omitempty"`
	ResolveState           int32                      `json:"resolveState,omitempty"`
	ResolveDate            time.Time                  `json:"resolveDate,omitempty"`
	ResolvedByMembershipId int64                      `json:"resolvedByMembershipId,omitempty"`
	RequestMessage         string                     `json:"requestMessage,omitempty"`
	ResolveMessage         string                     `json:"resolveMessage,omitempty"`
	DestinyUserInfo        *GroupsV2GroupUserInfoCard `json:"destinyUserInfo,omitempty"`
	BungieNetUserInfo      *UserUserInfoCard          `json:"bungieNetUserInfo,omitempty"`
}

type GroupsV2GroupMemberCountFilter ¶

type GroupsV2GroupMemberCountFilter int32

type GroupsV2GroupMemberLeaveResult ¶

type GroupsV2GroupMemberLeaveResult struct {
	Group        *GroupsV2GroupV2 `json:"group,omitempty"`
	GroupDeleted bool             `json:"groupDeleted,omitempty"`
}

type GroupsV2GroupMembership ¶

type GroupsV2GroupMembership struct {
	Member *GroupsV2GroupMember `json:"member,omitempty"`
	Group  *GroupsV2GroupV2     `json:"group,omitempty"`
}

type GroupsV2GroupMembershipBase ¶

type GroupsV2GroupMembershipBase struct {
	Group *GroupsV2GroupV2 `json:"group,omitempty"`
}

type GroupsV2GroupMembershipSearchResponse ¶

type GroupsV2GroupMembershipSearchResponse struct {
	Results                      []GroupsV2GroupMembership `json:"results,omitempty"`
	TotalResults                 int32                     `json:"totalResults,omitempty"`
	HasMore                      bool                      `json:"hasMore,omitempty"`
	Query                        *QueriesPagedQuery        `json:"query,omitempty"`
	ReplacementContinuationToken string                    `json:"replacementContinuationToken,omitempty"`
	// If useTotalResults is true, then totalResults represents an accurate count.  If False, it does not, and may be estimated/only the size of the current page.  Either way, you should probably always only trust hasMore.  This is a long-held historical throwback to when we used to do paging with known total results. Those queries toasted our database, and we were left to hastily alter our endpoints and create backward- compatible shims, of which useTotalResults is one.
	UseTotalResults bool `json:"useTotalResults,omitempty"`
}

type GroupsV2GroupNameSearchRequest ¶

type GroupsV2GroupNameSearchRequest struct {
	GroupName string `json:"groupName,omitempty"`
	GroupType int32  `json:"groupType,omitempty"`
}

type GroupsV2GroupOptionalConversation ¶

type GroupsV2GroupOptionalConversation struct {
	GroupId        int64  `json:"groupId,omitempty"`
	ConversationId int64  `json:"conversationId,omitempty"`
	ChatEnabled    bool   `json:"chatEnabled,omitempty"`
	ChatName       string `json:"chatName,omitempty"`
	ChatSecurity   int32  `json:"chatSecurity,omitempty"`
}

type GroupsV2GroupOptionalConversationAddRequest ¶

type GroupsV2GroupOptionalConversationAddRequest struct {
	ChatName     string `json:"chatName,omitempty"`
	ChatSecurity int32  `json:"chatSecurity,omitempty"`
}

type GroupsV2GroupOptionalConversationEditRequest ¶

type GroupsV2GroupOptionalConversationEditRequest struct {
	ChatEnabled  bool   `json:"chatEnabled,omitempty"`
	ChatName     string `json:"chatName,omitempty"`
	ChatSecurity int32  `json:"chatSecurity,omitempty"`
}

type GroupsV2GroupOptionsEditAction ¶

type GroupsV2GroupOptionsEditAction struct {
	// Minimum Member Level allowed to invite new members to group  Always Allowed: Founder, Acting Founder  True means admins have this power, false means they don't  Default is false for clans, true for groups.
	InvitePermissionOverride bool `json:"InvitePermissionOverride,omitempty"`
	// Minimum Member Level allowed to update group culture  Always Allowed: Founder, Acting Founder  True means admins have this power, false means they don't  Default is false for clans, true for groups.
	UpdateCulturePermissionOverride bool `json:"UpdateCulturePermissionOverride,omitempty"`
	// Minimum Member Level allowed to host guided games  Always Allowed: Founder, Acting Founder, Admin  Allowed Overrides: None, Member, Beginner  Default is Member for clans, None for groups, although this means nothing for groups.
	HostGuidedGamePermissionOverride int32 `json:"HostGuidedGamePermissionOverride,omitempty"`
	// Minimum Member Level allowed to update banner  Always Allowed: Founder, Acting Founder  True means admins have this power, false means they don't  Default is false for clans, true for groups.
	UpdateBannerPermissionOverride bool `json:"UpdateBannerPermissionOverride,omitempty"`
	// Level to join a member at when accepting an invite, application, or joining an open clan  Default is Beginner.
	JoinLevel int32 `json:"JoinLevel,omitempty"`
}

type GroupsV2GroupPostPublicity ¶

type GroupsV2GroupPostPublicity int32

type GroupsV2GroupPotentialMember ¶

type GroupsV2GroupPotentialMember struct {
	PotentialStatus   int32                      `json:"potentialStatus,omitempty"`
	GroupId           int64                      `json:"groupId,omitempty"`
	DestinyUserInfo   *GroupsV2GroupUserInfoCard `json:"destinyUserInfo,omitempty"`
	BungieNetUserInfo *UserUserInfoCard          `json:"bungieNetUserInfo,omitempty"`
	JoinDate          time.Time                  `json:"joinDate,omitempty"`
}

type GroupsV2GroupPotentialMemberStatus ¶

type GroupsV2GroupPotentialMemberStatus int32

type GroupsV2GroupPotentialMembership ¶

type GroupsV2GroupPotentialMembership struct {
	Member *GroupsV2GroupPotentialMember `json:"member,omitempty"`
	Group  *GroupsV2GroupV2              `json:"group,omitempty"`
}

type GroupsV2GroupPotentialMembershipSearchResponse ¶

type GroupsV2GroupPotentialMembershipSearchResponse struct {
	Results                      []GroupsV2GroupPotentialMembership `json:"results,omitempty"`
	TotalResults                 int32                              `json:"totalResults,omitempty"`
	HasMore                      bool                               `json:"hasMore,omitempty"`
	Query                        *QueriesPagedQuery                 `json:"query,omitempty"`
	ReplacementContinuationToken string                             `json:"replacementContinuationToken,omitempty"`
	// If useTotalResults is true, then totalResults represents an accurate count.  If False, it does not, and may be estimated/only the size of the current page.  Either way, you should probably always only trust hasMore.  This is a long-held historical throwback to when we used to do paging with known total results. Those queries toasted our database, and we were left to hastily alter our endpoints and create backward- compatible shims, of which useTotalResults is one.
	UseTotalResults bool `json:"useTotalResults,omitempty"`
}

type GroupsV2GroupQuery ¶

type GroupsV2GroupQuery struct {
	Name                     string `json:"name,omitempty"`
	GroupType                int32  `json:"groupType,omitempty"`
	CreationDate             int32  `json:"creationDate,omitempty"`
	SortBy                   int32  `json:"sortBy,omitempty"`
	GroupMemberCountFilter   int32  `json:"groupMemberCountFilter,omitempty"`
	LocaleFilter             string `json:"localeFilter,omitempty"`
	TagText                  string `json:"tagText,omitempty"`
	ItemsPerPage             int32  `json:"itemsPerPage,omitempty"`
	CurrentPage              int32  `json:"currentPage,omitempty"`
	RequestContinuationToken string `json:"requestContinuationToken,omitempty"`
}

NOTE: GroupQuery, as of Destiny 2, has essentially two totally different and incompatible \"modes\". If you are querying for a group, you can pass any of the properties below. If you are querying for a Clan, you MUST NOT pass any of the following properties (they must be null or undefined in your request, not just empty string/default values): - groupMemberCountFilter - localeFilter - tagText If you pass these, you will get a useless InvalidParameters error.

type GroupsV2GroupResponse ¶

type GroupsV2GroupResponse struct {
	Detail               *GroupsV2GroupV2     `json:"detail,omitempty"`
	Founder              *GroupsV2GroupMember `json:"founder,omitempty"`
	AlliedIds            []int64              `json:"alliedIds,omitempty"`
	ParentGroup          *GroupsV2GroupV2     `json:"parentGroup,omitempty"`
	AllianceStatus       int32                `json:"allianceStatus,omitempty"`
	GroupJoinInviteCount int32                `json:"groupJoinInviteCount,omitempty"`
	// A convenience property that indicates if every membership you (the current user) have that is a part of this group are part of an account that is considered inactive - for example, overridden accounts in Cross Save.
	CurrentUserMembershipsInactiveForDestiny bool `json:"currentUserMembershipsInactiveForDestiny,omitempty"`
	// This property will be populated if the authenticated user is a member of the group. Note that because of account linking, a user can sometimes be part of a clan more than once. As such, this returns the highest member type available.
	CurrentUserMemberMap map[string]GroupsV2GroupMember `json:"currentUserMemberMap,omitempty"`
	// This property will be populated if the authenticated user is an applicant or has an outstanding invitation to join. Note that because of account linking, a user can sometimes be part of a clan more than once.
	CurrentUserPotentialMemberMap map[string]GroupsV2GroupPotentialMember `json:"currentUserPotentialMemberMap,omitempty"`
}

type GroupsV2GroupSearchResponse ¶

type GroupsV2GroupSearchResponse struct {
	Results                      []GroupsV2GroupV2Card `json:"results,omitempty"`
	TotalResults                 int32                 `json:"totalResults,omitempty"`
	HasMore                      bool                  `json:"hasMore,omitempty"`
	Query                        *QueriesPagedQuery    `json:"query,omitempty"`
	ReplacementContinuationToken string                `json:"replacementContinuationToken,omitempty"`
	// If useTotalResults is true, then totalResults represents an accurate count.  If False, it does not, and may be estimated/only the size of the current page.  Either way, you should probably always only trust hasMore.  This is a long-held historical throwback to when we used to do paging with known total results. Those queries toasted our database, and we were left to hastily alter our endpoints and create backward- compatible shims, of which useTotalResults is one.
	UseTotalResults bool `json:"useTotalResults,omitempty"`
}

type GroupsV2GroupSortBy ¶

type GroupsV2GroupSortBy int32

type GroupsV2GroupType ¶

type GroupsV2GroupType int32

type GroupsV2GroupUserBase ¶

type GroupsV2GroupUserBase struct {
	GroupId           int64                      `json:"groupId,omitempty"`
	DestinyUserInfo   *GroupsV2GroupUserInfoCard `json:"destinyUserInfo,omitempty"`
	BungieNetUserInfo *UserUserInfoCard          `json:"bungieNetUserInfo,omitempty"`
	JoinDate          time.Time                  `json:"joinDate,omitempty"`
}

type GroupsV2GroupUserInfoCard ¶

type GroupsV2GroupUserInfoCard struct {
	// This will be the display name the clan server last saw the user as. If the account is an active cross save override, this will be the display name to use. Otherwise, this will match the displayName property.
	LastSeenDisplayName string `json:"LastSeenDisplayName,omitempty"`
	// The platform of the LastSeenDisplayName
	LastSeenDisplayNameType int32 `json:"LastSeenDisplayNameType,omitempty"`
	// A platform specific additional display name - ex: psn Real Name, bnet Unique Name, etc.
	SupplementalDisplayName string `json:"supplementalDisplayName,omitempty"`
	// URL the Icon if available.
	IconPath string `json:"iconPath,omitempty"`
	// If there is a cross save override in effect, this value will tell you the type that is overridding this one.
	CrossSaveOverride int32 `json:"crossSaveOverride,omitempty"`
	// 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
	ApplicableMembershipTypes []int32 `json:"applicableMembershipTypes,omitempty"`
	// If True, this is a public user membership.
	IsPublic bool `json:"isPublic,omitempty"`
	// Type of the membership. Not necessarily the native type.
	MembershipType int32 `json:"membershipType,omitempty"`
	// Membership ID as they user is known in the Accounts service
	MembershipId int64 `json:"membershipId,omitempty"`
	// 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.
	DisplayName string `json:"displayName,omitempty"`
	// The bungie global display name, if set.
	BungieGlobalDisplayName string `json:"bungieGlobalDisplayName,omitempty"`
	// The bungie global display name code, if set.
	BungieGlobalDisplayNameCode int32 `json:"bungieGlobalDisplayNameCode,omitempty"`
}

type GroupsV2GroupV2 ¶

type GroupsV2GroupV2 struct {
	GroupId                            int64                                 `json:"groupId,omitempty"`
	Name                               string                                `json:"name,omitempty"`
	GroupType                          int32                                 `json:"groupType,omitempty"`
	MembershipIdCreated                int64                                 `json:"membershipIdCreated,omitempty"`
	CreationDate                       time.Time                             `json:"creationDate,omitempty"`
	ModificationDate                   time.Time                             `json:"modificationDate,omitempty"`
	About                              string                                `json:"about,omitempty"`
	Tags                               []string                              `json:"tags,omitempty"`
	MemberCount                        int32                                 `json:"memberCount,omitempty"`
	IsPublic                           bool                                  `json:"isPublic,omitempty"`
	IsPublicTopicAdminOnly             bool                                  `json:"isPublicTopicAdminOnly,omitempty"`
	Motto                              string                                `json:"motto,omitempty"`
	AllowChat                          bool                                  `json:"allowChat,omitempty"`
	IsDefaultPostPublic                bool                                  `json:"isDefaultPostPublic,omitempty"`
	ChatSecurity                       int32                                 `json:"chatSecurity,omitempty"`
	Locale                             string                                `json:"locale,omitempty"`
	AvatarImageIndex                   int32                                 `json:"avatarImageIndex,omitempty"`
	Homepage                           int32                                 `json:"homepage,omitempty"`
	MembershipOption                   int32                                 `json:"membershipOption,omitempty"`
	DefaultPublicity                   int32                                 `json:"defaultPublicity,omitempty"`
	Theme                              string                                `json:"theme,omitempty"`
	BannerPath                         string                                `json:"bannerPath,omitempty"`
	AvatarPath                         string                                `json:"avatarPath,omitempty"`
	ConversationId                     int64                                 `json:"conversationId,omitempty"`
	EnableInvitationMessagingForAdmins bool                                  `json:"enableInvitationMessagingForAdmins,omitempty"`
	BanExpireDate                      time.Time                             `json:"banExpireDate,omitempty"`
	Features                           *GroupsV2GroupFeatures                `json:"features,omitempty"`
	ClanInfo                           *GroupsV2GroupV2ClanInfoAndInvestment `json:"clanInfo,omitempty"`
}

type GroupsV2GroupV2Card ¶

type GroupsV2GroupV2Card struct {
	GroupId          int64                    `json:"groupId,omitempty"`
	Name             string                   `json:"name,omitempty"`
	GroupType        int32                    `json:"groupType,omitempty"`
	CreationDate     time.Time                `json:"creationDate,omitempty"`
	About            string                   `json:"about,omitempty"`
	Motto            string                   `json:"motto,omitempty"`
	MemberCount      int32                    `json:"memberCount,omitempty"`
	Locale           string                   `json:"locale,omitempty"`
	MembershipOption int32                    `json:"membershipOption,omitempty"`
	Capabilities     int32                    `json:"capabilities,omitempty"`
	ClanInfo         *GroupsV2GroupV2ClanInfo `json:"clanInfo,omitempty"`
	AvatarPath       string                   `json:"avatarPath,omitempty"`
	Theme            string                   `json:"theme,omitempty"`
}

A small infocard of group information, usually used for when a list of groups are returned

type GroupsV2GroupV2ClanInfo ¶

type GroupsV2GroupV2ClanInfo struct {
	ClanCallsign   string              `json:"clanCallsign,omitempty"`
	ClanBannerData *GroupsV2ClanBanner `json:"clanBannerData,omitempty"`
}

This contract contains clan-specific group information. It does not include any investment data.

type GroupsV2GroupV2ClanInfoAndInvestment ¶

type GroupsV2GroupV2ClanInfoAndInvestment struct {
	D2ClanProgressions map[string]DestinyDestinyProgression `json:"d2ClanProgressions,omitempty"`
	ClanCallsign       string                               `json:"clanCallsign,omitempty"`
	ClanBannerData     *GroupsV2ClanBanner                  `json:"clanBannerData,omitempty"`
}

The same as GroupV2ClanInfo, but includes any investment data.

type GroupsV2GroupsForMemberFilter ¶

type GroupsV2GroupsForMemberFilter int32

type GroupsV2HostGuidedGamesPermissionLevel ¶

type GroupsV2HostGuidedGamesPermissionLevel int32

GroupsV2HostGuidedGamesPermissionLevel : Used for setting the guided game permission level override (admins and founders can always host guided games).

type GroupsV2MembershipOption ¶

type GroupsV2MembershipOption int32

type GroupsV2RuntimeGroupMemberType ¶

type GroupsV2RuntimeGroupMemberType int32

GroupsV2RuntimeGroupMemberType : The member levels used by all V2 Groups API. Individual group types use their own mappings in their native storage (general uses BnetDbGroupMemberType and D2 clans use ClanMemberLevel), but they are all translated to this in the runtime api. These runtime values should NEVER be stored anywhere, so the values can be changed as necessary.

type IgnoresIgnoreLength ¶

type IgnoresIgnoreLength int32

type IgnoresIgnoreResponse ¶

type IgnoresIgnoreResponse struct {
	IsIgnored   bool  `json:"isIgnored,omitempty"`
	IgnoreFlags int32 `json:"ignoreFlags,omitempty"`
}

type IgnoresIgnoreStatus ¶

type IgnoresIgnoreStatus int32

type InlineResponse200 ¶

type InlineResponse200 struct {
	Response           map[string]string `json:"Response,omitempty"`
	ErrorCode          int32             `json:"ErrorCode,omitempty"`
	ThrottleSeconds    int32             `json:"ThrottleSeconds,omitempty"`
	ErrorStatus        string            `json:"ErrorStatus,omitempty"`
	Message            string            `json:"Message,omitempty"`
	MessageData        map[string]string `json:"MessageData,omitempty"`
	DetailedErrorTrace string            `json:"DetailedErrorTrace,omitempty"`
}

type InlineResponse2001 ¶

type InlineResponse2001 struct {
	Response           []EntitiesEntityActionResult `json:"Response,omitempty"`
	ErrorCode          int32                        `json:"ErrorCode,omitempty"`
	ThrottleSeconds    int32                        `json:"ThrottleSeconds,omitempty"`
	ErrorStatus        string                       `json:"ErrorStatus,omitempty"`
	Message            string                       `json:"Message,omitempty"`
	MessageData        map[string]string            `json:"MessageData,omitempty"`
	DetailedErrorTrace string                       `json:"DetailedErrorTrace,omitempty"`
}

type InlineResponse2002 ¶

type InlineResponse2002 struct {
	Response           map[string]TokensBungieRewardDisplay `json:"Response,omitempty"`
	ErrorCode          int32                                `json:"ErrorCode,omitempty"`
	ThrottleSeconds    int32                                `json:"ThrottleSeconds,omitempty"`
	ErrorStatus        string                               `json:"ErrorStatus,omitempty"`
	Message            string                               `json:"Message,omitempty"`
	MessageData        map[string]string                    `json:"MessageData,omitempty"`
	DetailedErrorTrace string                               `json:"DetailedErrorTrace,omitempty"`
}

type InterpolationInterpolationPoint ¶

type InterpolationInterpolationPoint struct {
	Value  int32 `json:"value,omitempty"`
	Weight int32 `json:"weight,omitempty"`
}

type InterpolationInterpolationPointFloat ¶

type InterpolationInterpolationPointFloat struct {
	Value  float32 `json:"value,omitempty"`
	Weight float32 `json:"weight,omitempty"`
}

type LinksHyperlinkReference ¶

type LinksHyperlinkReference struct {
	Title string `json:"title,omitempty"`
	Url   string `json:"url,omitempty"`
}

type PreviewApiDestiny2GetClanAggregateStatsOpts ¶

type PreviewApiDestiny2GetClanAggregateStatsOpts struct {
	Modes optional.String
}

type PreviewApiDestiny2GetClanLeaderboardsOpts ¶

type PreviewApiDestiny2GetClanLeaderboardsOpts struct {
	Maxtop optional.Int32
	Modes  optional.String
	Statid optional.String
}

type PreviewApiDestiny2GetLeaderboardsForCharacterOpts ¶

type PreviewApiDestiny2GetLeaderboardsForCharacterOpts struct {
	Maxtop optional.Int32
	Modes  optional.String
	Statid optional.String
}

type PreviewApiDestiny2GetLeaderboardsOpts ¶

type PreviewApiDestiny2GetLeaderboardsOpts struct {
	Maxtop optional.Int32
	Modes  optional.String
	Statid optional.String
}

type PreviewApiDestiny2GetPublicVendorsOpts ¶

type PreviewApiDestiny2GetPublicVendorsOpts struct {
	Components optional.Interface
}

type PreviewApiService ¶

type PreviewApiService service

func (*PreviewApiService) Destiny2GetClanAggregateStats ¶

func (a *PreviewApiService) Destiny2GetClanAggregateStats(ctx context.Context, groupId int64, localVarOptionals *PreviewApiDestiny2GetClanAggregateStatsOpts) (*http.Response, error)

func (*PreviewApiService) Destiny2GetClanLeaderboards ¶

func (a *PreviewApiService) Destiny2GetClanLeaderboards(ctx context.Context, groupId int64, localVarOptionals *PreviewApiDestiny2GetClanLeaderboardsOpts) (*http.Response, error)

func (*PreviewApiService) Destiny2GetLeaderboards ¶

func (a *PreviewApiService) Destiny2GetLeaderboards(ctx context.Context, destinyMembershipId int64, membershipType int32, localVarOptionals *PreviewApiDestiny2GetLeaderboardsOpts) (*http.Response, error)

func (*PreviewApiService) Destiny2GetLeaderboardsForCharacter ¶

func (a *PreviewApiService) Destiny2GetLeaderboardsForCharacter(ctx context.Context, characterId int64, destinyMembershipId int64, membershipType int32, localVarOptionals *PreviewApiDestiny2GetLeaderboardsForCharacterOpts) (*http.Response, error)

func (*PreviewApiService) Destiny2GetPublicVendors ¶

func (a *PreviewApiService) Destiny2GetPublicVendors(ctx context.Context, localVarOptionals *PreviewApiDestiny2GetPublicVendorsOpts) (*http.Response, error)

func (*PreviewApiService) Destiny2InsertSocketPlug ¶

func (a *PreviewApiService) Destiny2InsertSocketPlug(ctx context.Context, body DestinyRequestsActionsDestinyInsertPlugsActionRequest) (*http.Response, error)

PreviewApiService Insert a plug into a socketed item. I know how it sounds, but I assure you it's much more G-rated than you might be guessing. We haven't decided yet whether this will be able to insert plugs that have side effects, but if we do it will require special scope permission for an application attempting to do so. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline. Request must include proof of permission for 'InsertPlugs' from the account owner.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*PreviewApiService) Destiny2InsertSocketPlugFree ¶

func (a *PreviewApiService) Destiny2InsertSocketPlugFree(ctx context.Context, body DestinyRequestsActionsDestinyInsertPlugsFreeActionRequest) (*http.Response, error)

PreviewApiService Insert a 'free' plug into an item's socket. This does not require 'Advanced Write Action' authorization and is available to 3rd-party apps, but will only work on 'free and reversible' socket actions (Perks, Armor Mods, Shaders, Ornaments, etc.). You must have a valid Destiny Account, and the character must either be in a social space, in orbit, or offline.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

type QueriesPagedQuery ¶

type QueriesPagedQuery struct {
	ItemsPerPage             int32  `json:"itemsPerPage,omitempty"`
	CurrentPage              int32  `json:"currentPage,omitempty"`
	RequestContinuationToken string `json:"requestContinuationToken,omitempty"`
}

type QueriesSearchResult ¶

type QueriesSearchResult struct {
	TotalResults                 int32              `json:"totalResults,omitempty"`
	HasMore                      bool               `json:"hasMore,omitempty"`
	Query                        *QueriesPagedQuery `json:"query,omitempty"`
	ReplacementContinuationToken string             `json:"replacementContinuationToken,omitempty"`
	// If useTotalResults is true, then totalResults represents an accurate count.  If False, it does not, and may be estimated/only the size of the current page.  Either way, you should probably always only trust hasMore.  This is a long-held historical throwback to when we used to do paging with known total results. Those queries toasted our database, and we were left to hastily alter our endpoints and create backward- compatible shims, of which useTotalResults is one.
	UseTotalResults bool `json:"useTotalResults,omitempty"`
}

type SearchResultOfContentItemPublicContract ¶

type SearchResultOfContentItemPublicContract struct {
	Results                      []ContentContentItemPublicContract `json:"results,omitempty"`
	TotalResults                 int32                              `json:"totalResults,omitempty"`
	HasMore                      bool                               `json:"hasMore,omitempty"`
	Query                        *QueriesPagedQuery                 `json:"query,omitempty"`
	ReplacementContinuationToken string                             `json:"replacementContinuationToken,omitempty"`
	// If useTotalResults is true, then totalResults represents an accurate count.  If False, it does not, and may be estimated/only the size of the current page.  Either way, you should probably always only trust hasMore.  This is a long-held historical throwback to when we used to do paging with known total results. Those queries toasted our database, and we were left to hastily alter our endpoints and create backward- compatible shims, of which useTotalResults is one.
	UseTotalResults bool `json:"useTotalResults,omitempty"`
}

type SearchResultOfDestinyEntitySearchResultItem ¶

type SearchResultOfDestinyEntitySearchResultItem struct {
	Results                      []DestinyDefinitionsDestinyEntitySearchResultItem `json:"results,omitempty"`
	TotalResults                 int32                                             `json:"totalResults,omitempty"`
	HasMore                      bool                                              `json:"hasMore,omitempty"`
	Query                        *QueriesPagedQuery                                `json:"query,omitempty"`
	ReplacementContinuationToken string                                            `json:"replacementContinuationToken,omitempty"`
	// If useTotalResults is true, then totalResults represents an accurate count.  If False, it does not, and may be estimated/only the size of the current page.  Either way, you should probably always only trust hasMore.  This is a long-held historical throwback to when we used to do paging with known total results. Those queries toasted our database, and we were left to hastily alter our endpoints and create backward- compatible shims, of which useTotalResults is one.
	UseTotalResults bool `json:"useTotalResults,omitempty"`
}

type SearchResultOfFireteamResponse ¶

type SearchResultOfFireteamResponse struct {
	Results                      []FireteamFireteamResponse `json:"results,omitempty"`
	TotalResults                 int32                      `json:"totalResults,omitempty"`
	HasMore                      bool                       `json:"hasMore,omitempty"`
	Query                        *QueriesPagedQuery         `json:"query,omitempty"`
	ReplacementContinuationToken string                     `json:"replacementContinuationToken,omitempty"`
	// If useTotalResults is true, then totalResults represents an accurate count.  If False, it does not, and may be estimated/only the size of the current page.  Either way, you should probably always only trust hasMore.  This is a long-held historical throwback to when we used to do paging with known total results. Those queries toasted our database, and we were left to hastily alter our endpoints and create backward- compatible shims, of which useTotalResults is one.
	UseTotalResults bool `json:"useTotalResults,omitempty"`
}

type SearchResultOfFireteamSummary ¶

type SearchResultOfFireteamSummary struct {
	Results                      []FireteamFireteamSummary `json:"results,omitempty"`
	TotalResults                 int32                     `json:"totalResults,omitempty"`
	HasMore                      bool                      `json:"hasMore,omitempty"`
	Query                        *QueriesPagedQuery        `json:"query,omitempty"`
	ReplacementContinuationToken string                    `json:"replacementContinuationToken,omitempty"`
	// If useTotalResults is true, then totalResults represents an accurate count.  If False, it does not, and may be estimated/only the size of the current page.  Either way, you should probably always only trust hasMore.  This is a long-held historical throwback to when we used to do paging with known total results. Those queries toasted our database, and we were left to hastily alter our endpoints and create backward- compatible shims, of which useTotalResults is one.
	UseTotalResults bool `json:"useTotalResults,omitempty"`
}

type SearchResultOfGroupBan ¶

type SearchResultOfGroupBan struct {
	Results                      []GroupsV2GroupBan `json:"results,omitempty"`
	TotalResults                 int32              `json:"totalResults,omitempty"`
	HasMore                      bool               `json:"hasMore,omitempty"`
	Query                        *QueriesPagedQuery `json:"query,omitempty"`
	ReplacementContinuationToken string             `json:"replacementContinuationToken,omitempty"`
	// If useTotalResults is true, then totalResults represents an accurate count.  If False, it does not, and may be estimated/only the size of the current page.  Either way, you should probably always only trust hasMore.  This is a long-held historical throwback to when we used to do paging with known total results. Those queries toasted our database, and we were left to hastily alter our endpoints and create backward- compatible shims, of which useTotalResults is one.
	UseTotalResults bool `json:"useTotalResults,omitempty"`
}

type SearchResultOfGroupMember ¶

type SearchResultOfGroupMember struct {
	Results                      []GroupsV2GroupMember `json:"results,omitempty"`
	TotalResults                 int32                 `json:"totalResults,omitempty"`
	HasMore                      bool                  `json:"hasMore,omitempty"`
	Query                        *QueriesPagedQuery    `json:"query,omitempty"`
	ReplacementContinuationToken string                `json:"replacementContinuationToken,omitempty"`
	// If useTotalResults is true, then totalResults represents an accurate count.  If False, it does not, and may be estimated/only the size of the current page.  Either way, you should probably always only trust hasMore.  This is a long-held historical throwback to when we used to do paging with known total results. Those queries toasted our database, and we were left to hastily alter our endpoints and create backward- compatible shims, of which useTotalResults is one.
	UseTotalResults bool `json:"useTotalResults,omitempty"`
}

type SearchResultOfGroupMemberApplication ¶

type SearchResultOfGroupMemberApplication struct {
	Results                      []GroupsV2GroupMemberApplication `json:"results,omitempty"`
	TotalResults                 int32                            `json:"totalResults,omitempty"`
	HasMore                      bool                             `json:"hasMore,omitempty"`
	Query                        *QueriesPagedQuery               `json:"query,omitempty"`
	ReplacementContinuationToken string                           `json:"replacementContinuationToken,omitempty"`
	// If useTotalResults is true, then totalResults represents an accurate count.  If False, it does not, and may be estimated/only the size of the current page.  Either way, you should probably always only trust hasMore.  This is a long-held historical throwback to when we used to do paging with known total results. Those queries toasted our database, and we were left to hastily alter our endpoints and create backward- compatible shims, of which useTotalResults is one.
	UseTotalResults bool `json:"useTotalResults,omitempty"`
}

type SearchResultOfGroupMembership ¶

type SearchResultOfGroupMembership struct {
	Results                      []GroupsV2GroupMembership `json:"results,omitempty"`
	TotalResults                 int32                     `json:"totalResults,omitempty"`
	HasMore                      bool                      `json:"hasMore,omitempty"`
	Query                        *QueriesPagedQuery        `json:"query,omitempty"`
	ReplacementContinuationToken string                    `json:"replacementContinuationToken,omitempty"`
	// If useTotalResults is true, then totalResults represents an accurate count.  If False, it does not, and may be estimated/only the size of the current page.  Either way, you should probably always only trust hasMore.  This is a long-held historical throwback to when we used to do paging with known total results. Those queries toasted our database, and we were left to hastily alter our endpoints and create backward- compatible shims, of which useTotalResults is one.
	UseTotalResults bool `json:"useTotalResults,omitempty"`
}

type SearchResultOfGroupPotentialMembership ¶

type SearchResultOfGroupPotentialMembership struct {
	Results                      []GroupsV2GroupPotentialMembership `json:"results,omitempty"`
	TotalResults                 int32                              `json:"totalResults,omitempty"`
	HasMore                      bool                               `json:"hasMore,omitempty"`
	Query                        *QueriesPagedQuery                 `json:"query,omitempty"`
	ReplacementContinuationToken string                             `json:"replacementContinuationToken,omitempty"`
	// If useTotalResults is true, then totalResults represents an accurate count.  If False, it does not, and may be estimated/only the size of the current page.  Either way, you should probably always only trust hasMore.  This is a long-held historical throwback to when we used to do paging with known total results. Those queries toasted our database, and we were left to hastily alter our endpoints and create backward- compatible shims, of which useTotalResults is one.
	UseTotalResults bool `json:"useTotalResults,omitempty"`
}

type SearchResultOfGroupV2Card ¶

type SearchResultOfGroupV2Card struct {
	Results                      []GroupsV2GroupV2Card `json:"results,omitempty"`
	TotalResults                 int32                 `json:"totalResults,omitempty"`
	HasMore                      bool                  `json:"hasMore,omitempty"`
	Query                        *QueriesPagedQuery    `json:"query,omitempty"`
	ReplacementContinuationToken string                `json:"replacementContinuationToken,omitempty"`
	// If useTotalResults is true, then totalResults represents an accurate count.  If False, it does not, and may be estimated/only the size of the current page.  Either way, you should probably always only trust hasMore.  This is a long-held historical throwback to when we used to do paging with known total results. Those queries toasted our database, and we were left to hastily alter our endpoints and create backward- compatible shims, of which useTotalResults is one.
	UseTotalResults bool `json:"useTotalResults,omitempty"`
}

type SearchResultOfPostResponse ¶

type SearchResultOfPostResponse struct {
	Results                      []ForumPostResponse `json:"results,omitempty"`
	TotalResults                 int32               `json:"totalResults,omitempty"`
	HasMore                      bool                `json:"hasMore,omitempty"`
	Query                        *QueriesPagedQuery  `json:"query,omitempty"`
	ReplacementContinuationToken string              `json:"replacementContinuationToken,omitempty"`
	// If useTotalResults is true, then totalResults represents an accurate count.  If False, it does not, and may be estimated/only the size of the current page.  Either way, you should probably always only trust hasMore.  This is a long-held historical throwback to when we used to do paging with known total results. Those queries toasted our database, and we were left to hastily alter our endpoints and create backward- compatible shims, of which useTotalResults is one.
	UseTotalResults bool `json:"useTotalResults,omitempty"`
}

type SearchResultOfTrendingEntry ¶

type SearchResultOfTrendingEntry struct {
	Results                      []TrendingTrendingEntry `json:"results,omitempty"`
	TotalResults                 int32                   `json:"totalResults,omitempty"`
	HasMore                      bool                    `json:"hasMore,omitempty"`
	Query                        *QueriesPagedQuery      `json:"query,omitempty"`
	ReplacementContinuationToken string                  `json:"replacementContinuationToken,omitempty"`
	// If useTotalResults is true, then totalResults represents an accurate count.  If False, it does not, and may be estimated/only the size of the current page.  Either way, you should probably always only trust hasMore.  This is a long-held historical throwback to when we used to do paging with known total results. Those queries toasted our database, and we were left to hastily alter our endpoints and create backward- compatible shims, of which useTotalResults is one.
	UseTotalResults bool `json:"useTotalResults,omitempty"`
}

type SingleComponentResponseOfDestinyCharacterActivitiesComponent ¶

type SingleComponentResponseOfDestinyCharacterActivitiesComponent struct {
	Data    *DestinyEntitiesCharactersDestinyCharacterActivitiesComponent `json:"data,omitempty"`
	Privacy int32                                                         `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyCharacterComponent ¶

type SingleComponentResponseOfDestinyCharacterComponent struct {
	Data    *DestinyEntitiesCharactersDestinyCharacterComponent `json:"data,omitempty"`
	Privacy int32                                               `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyCharacterProgressionComponent ¶

type SingleComponentResponseOfDestinyCharacterProgressionComponent struct {
	Data    *DestinyEntitiesCharactersDestinyCharacterProgressionComponent `json:"data,omitempty"`
	Privacy int32                                                          `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyCharacterRecordsComponent ¶

type SingleComponentResponseOfDestinyCharacterRecordsComponent struct {
	Data    *DestinyComponentsRecordsDestinyCharacterRecordsComponent `json:"data,omitempty"`
	Privacy int32                                                     `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyCharacterRenderComponent ¶

type SingleComponentResponseOfDestinyCharacterRenderComponent struct {
	Data    *DestinyEntitiesCharactersDestinyCharacterRenderComponent `json:"data,omitempty"`
	Privacy int32                                                     `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyCollectiblesComponent ¶

type SingleComponentResponseOfDestinyCollectiblesComponent struct {
	Data    *DestinyComponentsCollectiblesDestinyCollectiblesComponent `json:"data,omitempty"`
	Privacy int32                                                      `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyCurrenciesComponent ¶

type SingleComponentResponseOfDestinyCurrenciesComponent struct {
	Data    *DestinyComponentsInventoryDestinyCurrenciesComponent `json:"data,omitempty"`
	Privacy int32                                                 `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyInventoryComponent ¶

type SingleComponentResponseOfDestinyInventoryComponent struct {
	Data    *DestinyEntitiesInventoryDestinyInventoryComponent `json:"data,omitempty"`
	Privacy int32                                              `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyItemComponent ¶

type SingleComponentResponseOfDestinyItemComponent struct {
	Data    *DestinyEntitiesItemsDestinyItemComponent `json:"data,omitempty"`
	Privacy int32                                     `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyItemInstanceComponent ¶

type SingleComponentResponseOfDestinyItemInstanceComponent struct {
	Data    *DestinyEntitiesItemsDestinyItemInstanceComponent `json:"data,omitempty"`
	Privacy int32                                             `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyItemObjectivesComponent ¶

type SingleComponentResponseOfDestinyItemObjectivesComponent struct {
	Data    *DestinyEntitiesItemsDestinyItemObjectivesComponent `json:"data,omitempty"`
	Privacy int32                                               `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyItemPerksComponent ¶

type SingleComponentResponseOfDestinyItemPerksComponent struct {
	Data    *DestinyEntitiesItemsDestinyItemPerksComponent `json:"data,omitempty"`
	Privacy int32                                          `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyItemPlugObjectivesComponent ¶

type SingleComponentResponseOfDestinyItemPlugObjectivesComponent struct {
	Data    *DestinyComponentsItemsDestinyItemPlugObjectivesComponent `json:"data,omitempty"`
	Privacy int32                                                     `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyItemRenderComponent ¶

type SingleComponentResponseOfDestinyItemRenderComponent struct {
	Data    *DestinyEntitiesItemsDestinyItemRenderComponent `json:"data,omitempty"`
	Privacy int32                                           `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyItemReusablePlugsComponent ¶

type SingleComponentResponseOfDestinyItemReusablePlugsComponent struct {
	Data    *DestinyComponentsItemsDestinyItemReusablePlugsComponent `json:"data,omitempty"`
	Privacy int32                                                    `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyItemSocketsComponent ¶

type SingleComponentResponseOfDestinyItemSocketsComponent struct {
	Data    *DestinyEntitiesItemsDestinyItemSocketsComponent `json:"data,omitempty"`
	Privacy int32                                            `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyItemStatsComponent ¶

type SingleComponentResponseOfDestinyItemStatsComponent struct {
	Data    *DestinyEntitiesItemsDestinyItemStatsComponent `json:"data,omitempty"`
	Privacy int32                                          `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyItemTalentGridComponent ¶

type SingleComponentResponseOfDestinyItemTalentGridComponent struct {
	Data    *DestinyEntitiesItemsDestinyItemTalentGridComponent `json:"data,omitempty"`
	Privacy int32                                               `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyKiosksComponent ¶

type SingleComponentResponseOfDestinyKiosksComponent struct {
	Data    *DestinyComponentsKiosksDestinyKiosksComponent `json:"data,omitempty"`
	Privacy int32                                          `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyLoadoutsComponent ¶

type SingleComponentResponseOfDestinyLoadoutsComponent struct {
	Data    *DestinyComponentsLoadoutsDestinyLoadoutsComponent `json:"data,omitempty"`
	Privacy int32                                              `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyMetricsComponent ¶

type SingleComponentResponseOfDestinyMetricsComponent struct {
	Data    *DestinyComponentsMetricsDestinyMetricsComponent `json:"data,omitempty"`
	Privacy int32                                            `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyPlatformSilverComponent ¶

type SingleComponentResponseOfDestinyPlatformSilverComponent struct {
	Data    *DestinyComponentsInventoryDestinyPlatformSilverComponent `json:"data,omitempty"`
	Privacy int32                                                     `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyPlugSetsComponent ¶

type SingleComponentResponseOfDestinyPlugSetsComponent struct {
	Data    *DestinyComponentsPlugSetsDestinyPlugSetsComponent `json:"data,omitempty"`
	Privacy int32                                              `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyPresentationNodesComponent ¶

type SingleComponentResponseOfDestinyPresentationNodesComponent struct {
	Data    *DestinyComponentsPresentationDestinyPresentationNodesComponent `json:"data,omitempty"`
	Privacy int32                                                           `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyProfileCollectiblesComponent ¶

type SingleComponentResponseOfDestinyProfileCollectiblesComponent struct {
	Data    *DestinyComponentsCollectiblesDestinyProfileCollectiblesComponent `json:"data,omitempty"`
	Privacy int32                                                             `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyProfileComponent ¶

type SingleComponentResponseOfDestinyProfileComponent struct {
	Data    *DestinyEntitiesProfilesDestinyProfileComponent `json:"data,omitempty"`
	Privacy int32                                           `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyProfileProgressionComponent ¶

type SingleComponentResponseOfDestinyProfileProgressionComponent struct {
	Data    *DestinyComponentsProfilesDestinyProfileProgressionComponent `json:"data,omitempty"`
	Privacy int32                                                        `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyProfileRecordsComponent ¶

type SingleComponentResponseOfDestinyProfileRecordsComponent struct {
	Data    *DestinyComponentsRecordsDestinyProfileRecordsComponent `json:"data,omitempty"`
	Privacy int32                                                   `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyProfileTransitoryComponent ¶

type SingleComponentResponseOfDestinyProfileTransitoryComponent struct {
	Data    *DestinyComponentsProfilesDestinyProfileTransitoryComponent `json:"data,omitempty"`
	Privacy int32                                                       `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinySocialCommendationsComponent ¶

type SingleComponentResponseOfDestinySocialCommendationsComponent struct {
	Data    *DestinyComponentsSocialDestinySocialCommendationsComponent `json:"data,omitempty"`
	Privacy int32                                                       `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyStringVariablesComponent ¶

type SingleComponentResponseOfDestinyStringVariablesComponent struct {
	Data    *DestinyComponentsStringVariablesDestinyStringVariablesComponent `json:"data,omitempty"`
	Privacy int32                                                            `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyVendorCategoriesComponent ¶

type SingleComponentResponseOfDestinyVendorCategoriesComponent struct {
	Data    *DestinyEntitiesVendorsDestinyVendorCategoriesComponent `json:"data,omitempty"`
	Privacy int32                                                   `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyVendorComponent ¶

type SingleComponentResponseOfDestinyVendorComponent struct {
	Data    *DestinyEntitiesVendorsDestinyVendorComponent `json:"data,omitempty"`
	Privacy int32                                         `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyVendorGroupComponent ¶

type SingleComponentResponseOfDestinyVendorGroupComponent struct {
	Data    *DestinyComponentsVendorsDestinyVendorGroupComponent `json:"data,omitempty"`
	Privacy int32                                                `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SingleComponentResponseOfDestinyVendorReceiptsComponent ¶

type SingleComponentResponseOfDestinyVendorReceiptsComponent struct {
	Data    *DestinyEntitiesProfilesDestinyVendorReceiptsComponent `json:"data,omitempty"`
	Privacy int32                                                  `json:"privacy,omitempty"`
	// If true, this component is disabled.
	Disabled bool `json:"disabled,omitempty"`
}

type SocialApiService ¶

type SocialApiService service

func (*SocialApiService) SocialAcceptFriendRequest ¶

func (a *SocialApiService) SocialAcceptFriendRequest(ctx context.Context, membershipId string) (*http.Response, error)

SocialApiService Accepts a friend relationship with the target user. The user must be on your incoming friend request list, though no error will occur if they are not.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param membershipId The membership id of the user you wish to accept.

func (*SocialApiService) SocialDeclineFriendRequest ¶

func (a *SocialApiService) SocialDeclineFriendRequest(ctx context.Context, membershipId string) (*http.Response, error)

SocialApiService Declines a friend relationship with the target user. The user must be on your incoming friend request list, though no error will occur if they are not.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param membershipId The membership id of the user you wish to decline.

func (*SocialApiService) SocialGetFriendList ¶

func (a *SocialApiService) SocialGetFriendList(ctx context.Context) (*http.Response, error)

SocialApiService Returns your Bungie Friend list

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*SocialApiService) SocialGetFriendRequestList ¶

func (a *SocialApiService) SocialGetFriendRequestList(ctx context.Context) (*http.Response, error)

SocialApiService Returns your friend request queue.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*SocialApiService) SocialGetPlatformFriendList ¶

func (a *SocialApiService) SocialGetPlatformFriendList(ctx context.Context, friendPlatform int32, page string) (*http.Response, error)

SocialApiService Gets the platform friend of the requested type, with additional information if they have Bungie accounts. Must have a recent login session with said platform.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param friendPlatform The platform friend type.
@param page The zero based page to return. Page size is 100.

func (*SocialApiService) SocialIssueFriendRequest ¶

func (a *SocialApiService) SocialIssueFriendRequest(ctx context.Context, membershipId string) (*http.Response, error)

SocialApiService Requests a friend relationship with the target user. Any of the target user's linked membership ids are valid inputs.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param membershipId The membership id of the user you wish to add.

func (*SocialApiService) SocialRemoveFriend ¶

func (a *SocialApiService) SocialRemoveFriend(ctx context.Context, membershipId string) (*http.Response, error)

SocialApiService Remove a friend relationship with the target user. The user must be on your friend list, though no error will occur if they are not.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param membershipId The membership id of the user you wish to remove.

func (*SocialApiService) SocialRemoveFriendRequest ¶

func (a *SocialApiService) SocialRemoveFriendRequest(ctx context.Context, membershipId string) (*http.Response, error)

SocialApiService Remove a friend relationship with the target user. The user must be on your outgoing request friend list, though no error will occur if they are not.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param membershipId The membership id of the user you wish to remove.

type SocialFriendsBungieFriend ¶

type SocialFriendsBungieFriend struct {
	LastSeenAsMembershipId         int64            `json:"lastSeenAsMembershipId,omitempty"`
	LastSeenAsBungieMembershipType int32            `json:"lastSeenAsBungieMembershipType,omitempty"`
	BungieGlobalDisplayName        string           `json:"bungieGlobalDisplayName,omitempty"`
	BungieGlobalDisplayNameCode    int32            `json:"bungieGlobalDisplayNameCode,omitempty"`
	OnlineStatus                   int32            `json:"onlineStatus,omitempty"`
	OnlineTitle                    int32            `json:"onlineTitle,omitempty"`
	Relationship                   int32            `json:"relationship,omitempty"`
	BungieNetUser                  *UserGeneralUser `json:"bungieNetUser,omitempty"`
}

type SocialFriendsBungieFriendListResponse ¶

type SocialFriendsBungieFriendListResponse struct {
	Friends []SocialFriendsBungieFriend `json:"friends,omitempty"`
}

type SocialFriendsBungieFriendRequestListResponse ¶

type SocialFriendsBungieFriendRequestListResponse struct {
	IncomingRequests []SocialFriendsBungieFriend `json:"incomingRequests,omitempty"`
	OutgoingRequests []SocialFriendsBungieFriend `json:"outgoingRequests,omitempty"`
}

type SocialFriendsFriendRelationshipState ¶

type SocialFriendsFriendRelationshipState int32

type SocialFriendsPlatformFriend ¶

type SocialFriendsPlatformFriend struct {
	PlatformDisplayName         string `json:"platformDisplayName,omitempty"`
	FriendPlatform              int32  `json:"friendPlatform,omitempty"`
	DestinyMembershipId         int64  `json:"destinyMembershipId,omitempty"`
	DestinyMembershipType       int32  `json:"destinyMembershipType,omitempty"`
	BungieNetMembershipId       int64  `json:"bungieNetMembershipId,omitempty"`
	BungieGlobalDisplayName     string `json:"bungieGlobalDisplayName,omitempty"`
	BungieGlobalDisplayNameCode int32  `json:"bungieGlobalDisplayNameCode,omitempty"`
}

type SocialFriendsPlatformFriendResponse ¶

type SocialFriendsPlatformFriendResponse struct {
	ItemsPerPage    int32                         `json:"itemsPerPage,omitempty"`
	CurrentPage     int32                         `json:"currentPage,omitempty"`
	HasMore         bool                          `json:"hasMore,omitempty"`
	PlatformFriends []SocialFriendsPlatformFriend `json:"platformFriends,omitempty"`
}

type SocialFriendsPlatformFriendType ¶

type SocialFriendsPlatformFriendType int32

type SocialFriendsPresenceOnlineStateFlags ¶

type SocialFriendsPresenceOnlineStateFlags int32

type SocialFriendsPresenceStatus ¶

type SocialFriendsPresenceStatus int32

type StreamInfo ¶

type StreamInfo struct {
	ChannelName string `json:"ChannelName,omitempty"`
}

type StreamingDropStateEnum ¶

type StreamingDropStateEnum int32

type TagsModelsContractsTagResponse ¶

type TagsModelsContractsTagResponse struct {
	TagText      string                 `json:"tagText,omitempty"`
	IgnoreStatus *IgnoresIgnoreResponse `json:"ignoreStatus,omitempty"`
}

type TokensApiService ¶

type TokensApiService service

func (*TokensApiService) TokensApplyMissingPartnerOffersWithoutClaim ¶

func (a *TokensApiService) TokensApplyMissingPartnerOffersWithoutClaim(ctx context.Context, partnerApplicationId int32, targetBnetMembershipId int64) (*http.Response, error)

TokensApiService Apply a partner offer to the targeted user. This endpoint does not claim a new offer, but any already claimed offers will be applied to the game if not already.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param partnerApplicationId The partner application identifier.
@param targetBnetMembershipId The bungie.net user to apply missing offers to. If not self, elevated permissions are required.

func (*TokensApiService) TokensClaimPartnerOffer ¶

func (a *TokensApiService) TokensClaimPartnerOffer(ctx context.Context, body TokensPartnerOfferClaimRequest) (*http.Response, error)

TokensApiService Claim a partner offer as the authenticated user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*TokensApiService) TokensForceDropsRepair ¶

func (a *TokensApiService) TokensForceDropsRepair(ctx context.Context) (*http.Response, error)

TokensApiService Twitch Drops self-repair function - scans twitch for drops not marked as fulfilled and resyncs them.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*TokensApiService) TokensGetBungieRewardsForPlatformUser ¶

func (a *TokensApiService) TokensGetBungieRewardsForPlatformUser(ctx context.Context, membershipId int64, membershipType int32) (InlineResponse2002, *http.Response, error)

TokensApiService Returns the bungie rewards for the targeted user when a platform membership Id and Type are used.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param membershipId users platform membershipId for requested user rewards. If not self, elevated permissions are required.
@param membershipType The target Destiny 2 membership type.

@return InlineResponse2002

func (*TokensApiService) TokensGetBungieRewardsForUser ¶

func (a *TokensApiService) TokensGetBungieRewardsForUser(ctx context.Context, membershipId int64) (InlineResponse2002, *http.Response, error)

TokensApiService Returns the bungie rewards for the targeted user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param membershipId bungie.net user membershipId for requested user rewards. If not self, elevated permissions are required.

@return InlineResponse2002

func (*TokensApiService) TokensGetBungieRewardsList ¶

func (a *TokensApiService) TokensGetBungieRewardsList(ctx context.Context) (InlineResponse2002, *http.Response, error)

TokensApiService Returns a list of the current bungie rewards

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return InlineResponse2002

func (*TokensApiService) TokensGetPartnerOfferSkuHistory ¶

func (a *TokensApiService) TokensGetPartnerOfferSkuHistory(ctx context.Context, partnerApplicationId int32, targetBnetMembershipId int64) (*http.Response, error)

TokensApiService Returns the partner sku and offer history of the targeted user. Elevated permissions are required to see users that are not yourself.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param partnerApplicationId The partner application identifier.
@param targetBnetMembershipId The bungie.net user to apply missing offers to. If not self, elevated permissions are required.

func (*TokensApiService) TokensGetPartnerRewardHistory ¶

func (a *TokensApiService) TokensGetPartnerRewardHistory(ctx context.Context, partnerApplicationId int32, targetBnetMembershipId int64) (*http.Response, error)

TokensApiService Returns the partner rewards history of the targeted user, both partner offers and Twitch drops.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param partnerApplicationId The partner application identifier.
@param targetBnetMembershipId The bungie.net user to return reward history for.

type TokensBungieRewardDisplay ¶

type TokensBungieRewardDisplay struct {
	UserRewardAvailabilityModel *TokensUserRewardAvailabilityModel `json:"UserRewardAvailabilityModel,omitempty"`
	ObjectiveDisplayProperties  *TokensRewardDisplayProperties     `json:"ObjectiveDisplayProperties,omitempty"`
	RewardDisplayProperties     *TokensRewardDisplayProperties     `json:"RewardDisplayProperties,omitempty"`
}

type TokensCollectibleDefinitions ¶

type TokensCollectibleDefinitions struct {
	CollectibleDefinition          *DestinyDefinitionsCollectiblesDestinyCollectibleDefinition `json:"CollectibleDefinition,omitempty"`
	DestinyInventoryItemDefinition *DestinyDefinitionsDestinyInventoryItemDefinition           `json:"DestinyInventoryItemDefinition,omitempty"`
}

type TokensPartnerOfferClaimRequest ¶

type TokensPartnerOfferClaimRequest struct {
	PartnerOfferId        string `json:"PartnerOfferId,omitempty"`
	BungieNetMembershipId int64  `json:"BungieNetMembershipId,omitempty"`
	TransactionId         string `json:"TransactionId,omitempty"`
}

type TokensPartnerOfferHistoryResponse ¶

type TokensPartnerOfferHistoryResponse struct {
	PartnerOfferKey      string    `json:"PartnerOfferKey,omitempty"`
	MembershipId         int64     `json:"MembershipId,omitempty"`
	MembershipType       int32     `json:"MembershipType,omitempty"`
	LocalizedName        string    `json:"LocalizedName,omitempty"`
	LocalizedDescription string    `json:"LocalizedDescription,omitempty"`
	IsConsumable         bool      `json:"IsConsumable,omitempty"`
	QuantityApplied      int32     `json:"QuantityApplied,omitempty"`
	ApplyDate            time.Time `json:"ApplyDate,omitempty"`
}

type TokensPartnerOfferSkuHistoryResponse ¶

type TokensPartnerOfferSkuHistoryResponse struct {
	SkuIdentifier        string                              `json:"SkuIdentifier,omitempty"`
	LocalizedName        string                              `json:"LocalizedName,omitempty"`
	LocalizedDescription string                              `json:"LocalizedDescription,omitempty"`
	ClaimDate            time.Time                           `json:"ClaimDate,omitempty"`
	AllOffersApplied     bool                                `json:"AllOffersApplied,omitempty"`
	TransactionId        string                              `json:"TransactionId,omitempty"`
	SkuOffers            []TokensPartnerOfferHistoryResponse `json:"SkuOffers,omitempty"`
}

type TokensPartnerRewardHistoryResponse ¶

type TokensPartnerRewardHistoryResponse struct {
	PartnerOffers []TokensPartnerOfferSkuHistoryResponse `json:"PartnerOffers,omitempty"`
	TwitchDrops   []TokensTwitchDropHistoryResponse      `json:"TwitchDrops,omitempty"`
}

type TokensRewardAvailabilityModel ¶

type TokensRewardAvailabilityModel struct {
	HasExistingCode        bool                                               `json:"HasExistingCode,omitempty"`
	RecordDefinitions      []DestinyDefinitionsRecordsDestinyRecordDefinition `json:"RecordDefinitions,omitempty"`
	CollectibleDefinitions []TokensCollectibleDefinitions                     `json:"CollectibleDefinitions,omitempty"`
	IsOffer                bool                                               `json:"IsOffer,omitempty"`
	HasOffer               bool                                               `json:"HasOffer,omitempty"`
	OfferApplied           bool                                               `json:"OfferApplied,omitempty"`
	DecryptedToken         string                                             `json:"DecryptedToken,omitempty"`
	IsLoyaltyReward        bool                                               `json:"IsLoyaltyReward,omitempty"`
	ShopifyEndDate         time.Time                                          `json:"ShopifyEndDate,omitempty"`
	GameEarnByDate         time.Time                                          `json:"GameEarnByDate,omitempty"`
	RedemptionEndDate      time.Time                                          `json:"RedemptionEndDate,omitempty"`
}

type TokensRewardDisplayProperties ¶

type TokensRewardDisplayProperties struct {
	Name        string `json:"Name,omitempty"`
	Description string `json:"Description,omitempty"`
	ImagePath   string `json:"ImagePath,omitempty"`
}

type TokensTwitchDropHistoryResponse ¶

type TokensTwitchDropHistoryResponse struct {
	Title       string    `json:"Title,omitempty"`
	Description string    `json:"Description,omitempty"`
	CreatedAt   time.Time `json:"CreatedAt,omitempty"`
	ClaimState  int32     `json:"ClaimState,omitempty"`
}

type TokensUserRewardAvailabilityModel ¶

type TokensUserRewardAvailabilityModel struct {
	AvailabilityModel  *TokensRewardAvailabilityModel `json:"AvailabilityModel,omitempty"`
	IsAvailableForUser bool                           `json:"IsAvailableForUser,omitempty"`
	IsUnlockedForUser  bool                           `json:"IsUnlockedForUser,omitempty"`
}

type TrendingApiService ¶

type TrendingApiService service

func (*TrendingApiService) TrendingGetTrendingCategories ¶

func (a *TrendingApiService) TrendingGetTrendingCategories(ctx context.Context) (*http.Response, error)

TrendingApiService Returns trending items for Bungie.net, collapsed into the first page of items per category. For pagination within a category, call GetTrendingCategory.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*TrendingApiService) TrendingGetTrendingCategory ¶

func (a *TrendingApiService) TrendingGetTrendingCategory(ctx context.Context, categoryId string, pageNumber int32) (*http.Response, error)

TrendingApiService Returns paginated lists of trending items for a category.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param categoryId The ID of the category for whom you want additional results.
@param pageNumber The page # of results to return.

func (*TrendingApiService) TrendingGetTrendingEntryDetail ¶

func (a *TrendingApiService) TrendingGetTrendingEntryDetail(ctx context.Context, identifier string, trendingEntryType int32) (*http.Response, error)

TrendingApiService Returns the detailed results for a specific trending entry. Note that trending entries are uniquely identified by a combination of *both* the TrendingEntryType *and* the identifier: the identifier alone is not guaranteed to be globally unique.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param identifier The identifier for the entity to be returned.
@param trendingEntryType The type of entity to be returned.

type TrendingTrendingCategories ¶

type TrendingTrendingCategories struct {
	Categories []TrendingTrendingCategory `json:"categories,omitempty"`
}

type TrendingTrendingCategory ¶

type TrendingTrendingCategory struct {
	CategoryName string                       `json:"categoryName,omitempty"`
	Entries      *SearchResultOfTrendingEntry `json:"entries,omitempty"`
	CategoryId   string                       `json:"categoryId,omitempty"`
}

type TrendingTrendingDetail ¶

type TrendingTrendingDetail struct {
	Identifier      string                                  `json:"identifier,omitempty"`
	EntityType      int32                                   `json:"entityType,omitempty"`
	News            *TrendingTrendingEntryNews              `json:"news,omitempty"`
	Support         *TrendingTrendingEntrySupportArticle    `json:"support,omitempty"`
	DestinyItem     *TrendingTrendingEntryDestinyItem       `json:"destinyItem,omitempty"`
	DestinyActivity *TrendingTrendingEntryDestinyActivity   `json:"destinyActivity,omitempty"`
	DestinyRitual   *TrendingTrendingEntryDestinyRitual     `json:"destinyRitual,omitempty"`
	Creation        *TrendingTrendingEntryCommunityCreation `json:"creation,omitempty"`
}

type TrendingTrendingEntry ¶

type TrendingTrendingEntry struct {
	// The weighted score of this trending item.
	Weight     float64 `json:"weight,omitempty"`
	IsFeatured bool    `json:"isFeatured,omitempty"`
	// We don't know whether the identifier will be a string, a uint, or a long... so we're going to cast it all to a string. But either way, we need any trending item created to have a single unique identifier for its type.
	Identifier string `json:"identifier,omitempty"`
	// An enum - unfortunately - dictating all of the possible kinds of trending items that you might get in your result set, in case you want to do custom rendering or call to get the details of the item.
	EntityType int32 `json:"entityType,omitempty"`
	// The localized \"display name/article title/'primary localized identifier'\" of the entity.
	DisplayName string `json:"displayName,omitempty"`
	// If the entity has a localized tagline/subtitle/motto/whatever, that is found here.
	Tagline   string    `json:"tagline,omitempty"`
	Image     string    `json:"image,omitempty"`
	StartDate time.Time `json:"startDate,omitempty"`
	EndDate   time.Time `json:"endDate,omitempty"`
	Link      string    `json:"link,omitempty"`
	// If this is populated, the entry has a related WebM video to show. I am 100% certain I am going to regret putting this directly on TrendingEntry, but it will work so yolo
	WebmVideo string `json:"webmVideo,omitempty"`
	// If this is populated, the entry has a related MP4 video to show. I am 100% certain I am going to regret putting this directly on TrendingEntry, but it will work so yolo
	Mp4Video string `json:"mp4Video,omitempty"`
	// If isFeatured, this image will be populated with whatever the featured image is. Note that this will likely be a very large image, so don't use it all the time.
	FeatureImage string `json:"featureImage,omitempty"`
	// If the item is of entityType TrendingEntryType.Container, it may have items - also Trending Entries - contained within it. This is the ordered list of those to display under the Container's header.
	Items []TrendingTrendingEntry `json:"items,omitempty"`
	// If the entry has a date at which it was created, this is that date.
	CreationDate time.Time `json:"creationDate,omitempty"`
}

The list entry view for trending items. Returns just enough to show the item on the trending page.

type TrendingTrendingEntryCommunityCreation ¶

type TrendingTrendingEntryCommunityCreation struct {
	Media              string `json:"media,omitempty"`
	Title              string `json:"title,omitempty"`
	Author             string `json:"author,omitempty"`
	AuthorMembershipId int64  `json:"authorMembershipId,omitempty"`
	PostId             int64  `json:"postId,omitempty"`
	Body               string `json:"body,omitempty"`
	Upvotes            int32  `json:"upvotes,omitempty"`
}

type TrendingTrendingEntryDestinyActivity ¶

type TrendingTrendingEntryDestinyActivity struct {
	ActivityHash int32                                         `json:"activityHash,omitempty"`
	Status       *DestinyActivitiesDestinyPublicActivityStatus `json:"status,omitempty"`
}

type TrendingTrendingEntryDestinyItem ¶

type TrendingTrendingEntryDestinyItem struct {
	ItemHash int32 `json:"itemHash,omitempty"`
}

type TrendingTrendingEntryDestinyRitual ¶

type TrendingTrendingEntryDestinyRitual struct {
	Image     string    `json:"image,omitempty"`
	Icon      string    `json:"icon,omitempty"`
	Title     string    `json:"title,omitempty"`
	Subtitle  string    `json:"subtitle,omitempty"`
	DateStart time.Time `json:"dateStart,omitempty"`
	DateEnd   time.Time `json:"dateEnd,omitempty"`
	// A destiny event does not necessarily have a related Milestone, but if it does the details will be returned here.
	MilestoneDetails *AllOfTrendingTrendingEntryDestinyRitualMilestoneDetails `json:"milestoneDetails,omitempty"`
	// A destiny event will not necessarily have milestone \"custom content\", but if it does the details will be here.
	EventContent *AllOfTrendingTrendingEntryDestinyRitualEventContent `json:"eventContent,omitempty"`
}

type TrendingTrendingEntryNews ¶

type TrendingTrendingEntryNews struct {
	Article *ContentContentItemPublicContract `json:"article,omitempty"`
}

type TrendingTrendingEntrySupportArticle ¶

type TrendingTrendingEntrySupportArticle struct {
	Article *ContentContentItemPublicContract `json:"article,omitempty"`
}

type TrendingTrendingEntryType ¶

type TrendingTrendingEntryType int32

TrendingTrendingEntryType : The known entity types that you can have returned from Trending.

type UserApiService ¶

type UserApiService service

func (*UserApiService) UserGetAvailableThemes ¶

func (a *UserApiService) UserGetAvailableThemes(ctx context.Context) (*http.Response, error)

UserApiService Returns a list of all available user themes.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*UserApiService) UserGetBungieNetUserById ¶

func (a *UserApiService) UserGetBungieNetUserById(ctx context.Context, id int64) (*http.Response, error)

UserApiService Loads a bungienet user by membership id.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id The requested Bungie.net membership id.

func (*UserApiService) UserGetCredentialTypesForTargetAccount ¶

func (a *UserApiService) UserGetCredentialTypesForTargetAccount(ctx context.Context, membershipId int64) (*http.Response, error)

UserApiService Returns a list of credential types attached to the requested account

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param membershipId The user's membership id

func (*UserApiService) UserGetMembershipDataById ¶

func (a *UserApiService) UserGetMembershipDataById(ctx context.Context, membershipId int64, membershipType int32) (*http.Response, error)

UserApiService Returns a list of accounts associated with the supplied membership ID and membership type. This will include all linked accounts (even when hidden) if supplied credentials permit it.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param membershipId The membership ID of the target user.
@param membershipType Type of the supplied membership ID.

func (*UserApiService) UserGetMembershipDataForCurrentUser ¶

func (a *UserApiService) UserGetMembershipDataForCurrentUser(ctx context.Context) (*http.Response, error)

UserApiService Returns a list of accounts associated with signed in user. This is useful for OAuth implementations that do not give you access to the token response.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*UserApiService) UserGetMembershipFromHardLinkedCredential ¶

func (a *UserApiService) UserGetMembershipFromHardLinkedCredential(ctx context.Context, credential string, crType int32) (*http.Response, error)

UserApiService Gets any hard linked membership given a credential. Only works for credentials that are public (just SteamID64 right now). Cross Save aware.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param credential The credential to look up. Must be a valid SteamID64.
@param crType The credential type. 'SteamId' is the only valid value at present.

func (*UserApiService) UserGetSanitizedPlatformDisplayNames ¶

func (a *UserApiService) UserGetSanitizedPlatformDisplayNames(ctx context.Context, membershipId int64) (*http.Response, error)

UserApiService Gets a list of all display names linked to this membership id but sanitized (profanity filtered). Obeys all visibility rules of calling user and is heavily cached.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param membershipId The requested membership id to load.

func (*UserApiService) UserSearchByGlobalNamePost ¶

func (a *UserApiService) UserSearchByGlobalNamePost(ctx context.Context, body UserUserSearchPrefixRequest, page int32) (*http.Response, error)

UserApiService Given the prefix of a global display name, returns all users who share that name.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param page The zero-based page of results you desire.

func (*UserApiService) UserSearchByGlobalNamePrefix ¶

func (a *UserApiService) UserSearchByGlobalNamePrefix(ctx context.Context, displayNamePrefix string, page int32) (*http.Response, error)

UserApiService [OBSOLETE] Do not use this to search users, use SearchByGlobalNamePost instead.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param displayNamePrefix The display name prefix you're looking for.
@param page The zero-based page of results you desire.

type UserCrossSaveUserMembership ¶

type UserCrossSaveUserMembership struct {
	// If there is a cross save override in effect, this value will tell you the type that is overridding this one.
	CrossSaveOverride int32 `json:"crossSaveOverride,omitempty"`
	// 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
	ApplicableMembershipTypes []int32 `json:"applicableMembershipTypes,omitempty"`
	// If True, this is a public user membership.
	IsPublic bool `json:"isPublic,omitempty"`
	// Type of the membership. Not necessarily the native type.
	MembershipType int32 `json:"membershipType,omitempty"`
	// Membership ID as they user is known in the Accounts service
	MembershipId int64 `json:"membershipId,omitempty"`
	// 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.
	DisplayName string `json:"displayName,omitempty"`
	// The bungie global display name, if set.
	BungieGlobalDisplayName string `json:"bungieGlobalDisplayName,omitempty"`
	// The bungie global display name code, if set.
	BungieGlobalDisplayNameCode int32 `json:"bungieGlobalDisplayNameCode,omitempty"`
}

Very basic info about a user as returned by the Account server, but including CrossSave information. Do NOT use as a request contract.

type UserEMailSettingLocalization ¶

type UserEMailSettingLocalization struct {
	Title       string `json:"title,omitempty"`
	Description string `json:"description,omitempty"`
}

Localized text relevant to a given EMail setting in a given localization.

type UserEMailSettingSubscriptionLocalization ¶

type UserEMailSettingSubscriptionLocalization struct {
	UnknownUserDescription      string `json:"unknownUserDescription,omitempty"`
	RegisteredUserDescription   string `json:"registeredUserDescription,omitempty"`
	UnregisteredUserDescription string `json:"unregisteredUserDescription,omitempty"`
	UnknownUserActionText       string `json:"unknownUserActionText,omitempty"`
	KnownUserActionText         string `json:"knownUserActionText,omitempty"`
	Title                       string `json:"title,omitempty"`
	Description                 string `json:"description,omitempty"`
}

Localized text relevant to a given EMail setting in a given localization. Extra settings specifically for subscriptions.

type UserEmailOptInDefinition ¶

type UserEmailOptInDefinition struct {
	// The unique identifier for this opt-in category.
	Name string `json:"name,omitempty"`
	// The flag value for this opt-in category. For historical reasons, this is defined as a flags enum.
	Value int64 `json:"value,omitempty"`
	// If true, this opt-in setting should be set by default in situations where accounts are created without explicit choices about what they're opting into.
	SetByDefault bool `json:"setByDefault,omitempty"`
	// Information about the dependent subscriptions for this opt-in.
	DependentSubscriptions []UserEmailSubscriptionDefinition `json:"dependentSubscriptions,omitempty"`
}

Defines a single opt-in category: a wide-scoped permission to send emails for the subject related to the opt-in.

type UserEmailSettings ¶

type UserEmailSettings struct {
	// Keyed by the name identifier of the opt-in definition.
	OptInDefinitions map[string]UserEmailOptInDefinition `json:"optInDefinitions,omitempty"`
	// Keyed by the name identifier of the Subscription definition.
	SubscriptionDefinitions map[string]UserEmailSubscriptionDefinition `json:"subscriptionDefinitions,omitempty"`
	// Keyed by the name identifier of the View definition.
	Views map[string]UserEmailViewDefinition `json:"views,omitempty"`
}

The set of all email subscription/opt-in settings and definitions.

type UserEmailSubscriptionDefinition ¶

type UserEmailSubscriptionDefinition struct {
	// The unique identifier for this subscription.
	Name string `json:"name,omitempty"`
	// A dictionary of localized text for the EMail Opt-in setting, keyed by the locale.
	Localization map[string]UserEMailSettingSubscriptionLocalization `json:"localization,omitempty"`
	// The bitflag value for this subscription. Should be a unique power of two value.
	Value int64 `json:"value,omitempty"`
}

Defines a single subscription: permission to send emails for a specific, focused subject (generally timeboxed, such as for a specific release of a product or feature).

type UserEmailViewDefinition ¶

type UserEmailViewDefinition struct {
	// The identifier for this view.
	Name string `json:"name,omitempty"`
	// The ordered list of settings to show in this view.
	ViewSettings []UserEmailViewDefinitionSetting `json:"viewSettings,omitempty"`
}

Represents a data-driven view for Email settings. Web/Mobile UI can use this data to show new EMail settings consistently without further manual work.

type UserEmailViewDefinitionSetting ¶

type UserEmailViewDefinitionSetting struct {
	// The identifier for this UI Setting, which can be used to relate it to custom strings or other data as desired.
	Name string `json:"name,omitempty"`
	// A dictionary of localized text for the EMail setting, keyed by the locale.
	Localization map[string]UserEMailSettingLocalization `json:"localization,omitempty"`
	// If true, this setting should be set by default if the user hasn't chosen whether it's set or cleared yet.
	SetByDefault bool `json:"setByDefault,omitempty"`
	// The OptInFlags value to set or clear if this setting is set or cleared in the UI. It is the aggregate of all underlying opt-in flags related to this setting.
	OptInAggregateValue int64 `json:"optInAggregateValue,omitempty"`
	// The subscriptions to show as children of this setting, if any.
	Subscriptions []UserEmailSubscriptionDefinition `json:"subscriptions,omitempty"`
}

type UserExactSearchRequest ¶

type UserExactSearchRequest struct {
	DisplayName     string `json:"displayName,omitempty"`
	DisplayNameCode int32  `json:"displayNameCode,omitempty"`
}

type UserGeneralUser ¶

type UserGeneralUser struct {
	MembershipId                      int64                  `json:"membershipId,omitempty"`
	UniqueName                        string                 `json:"uniqueName,omitempty"`
	NormalizedName                    string                 `json:"normalizedName,omitempty"`
	DisplayName                       string                 `json:"displayName,omitempty"`
	ProfilePicture                    int32                  `json:"profilePicture,omitempty"`
	ProfileTheme                      int32                  `json:"profileTheme,omitempty"`
	UserTitle                         int32                  `json:"userTitle,omitempty"`
	SuccessMessageFlags               int64                  `json:"successMessageFlags,omitempty"`
	IsDeleted                         bool                   `json:"isDeleted,omitempty"`
	About                             string                 `json:"about,omitempty"`
	FirstAccess                       time.Time              `json:"firstAccess,omitempty"`
	LastUpdate                        time.Time              `json:"lastUpdate,omitempty"`
	LegacyPortalUID                   int64                  `json:"legacyPortalUID,omitempty"`
	Context                           *UserUserToUserContext `json:"context,omitempty"`
	PsnDisplayName                    string                 `json:"psnDisplayName,omitempty"`
	XboxDisplayName                   string                 `json:"xboxDisplayName,omitempty"`
	FbDisplayName                     string                 `json:"fbDisplayName,omitempty"`
	ShowActivity                      bool                   `json:"showActivity,omitempty"`
	Locale                            string                 `json:"locale,omitempty"`
	LocaleInheritDefault              bool                   `json:"localeInheritDefault,omitempty"`
	LastBanReportId                   int64                  `json:"lastBanReportId,omitempty"`
	ShowGroupMessaging                bool                   `json:"showGroupMessaging,omitempty"`
	ProfilePicturePath                string                 `json:"profilePicturePath,omitempty"`
	ProfilePictureWidePath            string                 `json:"profilePictureWidePath,omitempty"`
	ProfileThemeName                  string                 `json:"profileThemeName,omitempty"`
	UserTitleDisplay                  string                 `json:"userTitleDisplay,omitempty"`
	StatusText                        string                 `json:"statusText,omitempty"`
	StatusDate                        time.Time              `json:"statusDate,omitempty"`
	ProfileBanExpire                  time.Time              `json:"profileBanExpire,omitempty"`
	BlizzardDisplayName               string                 `json:"blizzardDisplayName,omitempty"`
	SteamDisplayName                  string                 `json:"steamDisplayName,omitempty"`
	StadiaDisplayName                 string                 `json:"stadiaDisplayName,omitempty"`
	TwitchDisplayName                 string                 `json:"twitchDisplayName,omitempty"`
	CachedBungieGlobalDisplayName     string                 `json:"cachedBungieGlobalDisplayName,omitempty"`
	CachedBungieGlobalDisplayNameCode int32                  `json:"cachedBungieGlobalDisplayNameCode,omitempty"`
	EgsDisplayName                    string                 `json:"egsDisplayName,omitempty"`
}

type UserHardLinkedUserMembership ¶

type UserHardLinkedUserMembership struct {
	MembershipType                  int32 `json:"membershipType,omitempty"`
	MembershipId                    int64 `json:"membershipId,omitempty"`
	CrossSaveOverriddenType         int32 `json:"CrossSaveOverriddenType,omitempty"`
	CrossSaveOverriddenMembershipId int64 `json:"CrossSaveOverriddenMembershipId,omitempty"`
}

type UserModelsGetCredentialTypesForAccountResponse ¶

type UserModelsGetCredentialTypesForAccountResponse struct {
	CredentialType        int32  `json:"credentialType,omitempty"`
	CredentialDisplayName string `json:"credentialDisplayName,omitempty"`
	IsPublic              bool   `json:"isPublic,omitempty"`
	CredentialAsString    string `json:"credentialAsString,omitempty"`
}

type UserOptInFlags ¶

type UserOptInFlags int64

type UserUserInfoCard ¶

type UserUserInfoCard struct {
	// A platform specific additional display name - ex: psn Real Name, bnet Unique Name, etc.
	SupplementalDisplayName string `json:"supplementalDisplayName,omitempty"`
	// URL the Icon if available.
	IconPath string `json:"iconPath,omitempty"`
	// If there is a cross save override in effect, this value will tell you the type that is overridding this one.
	CrossSaveOverride int32 `json:"crossSaveOverride,omitempty"`
	// 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
	ApplicableMembershipTypes []int32 `json:"applicableMembershipTypes,omitempty"`
	// If True, this is a public user membership.
	IsPublic bool `json:"isPublic,omitempty"`
	// Type of the membership. Not necessarily the native type.
	MembershipType int32 `json:"membershipType,omitempty"`
	// Membership ID as they user is known in the Accounts service
	MembershipId int64 `json:"membershipId,omitempty"`
	// 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.
	DisplayName string `json:"displayName,omitempty"`
	// The bungie global display name, if set.
	BungieGlobalDisplayName string `json:"bungieGlobalDisplayName,omitempty"`
	// The bungie global display name code, if set.
	BungieGlobalDisplayNameCode int32 `json:"bungieGlobalDisplayNameCode,omitempty"`
}

This contract supplies basic information commonly used to display a minimal amount of information about a user. Take care to not add more properties here unless the property applies in all (or at least the majority) of the situations where UserInfoCard is used. Avoid adding game specific or platform specific details here. In cases where UserInfoCard is a subset of the data needed in a contract, use UserInfoCard as a property of other contracts.

type UserUserMembership ¶

type UserUserMembership struct {
	// Type of the membership. Not necessarily the native type.
	MembershipType int32 `json:"membershipType,omitempty"`
	// Membership ID as they user is known in the Accounts service
	MembershipId int64 `json:"membershipId,omitempty"`
	// 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.
	DisplayName string `json:"displayName,omitempty"`
	// The bungie global display name, if set.
	BungieGlobalDisplayName string `json:"bungieGlobalDisplayName,omitempty"`
	// The bungie global display name code, if set.
	BungieGlobalDisplayNameCode int32 `json:"bungieGlobalDisplayNameCode,omitempty"`
}

Very basic info about a user as returned by the Account server.

type UserUserMembershipData ¶

type UserUserMembershipData struct {
	// this allows you to see destiny memberships that are visible and linked to this account (regardless of whether or not they have characters on the world server)
	DestinyMemberships []GroupsV2GroupUserInfoCard `json:"destinyMemberships,omitempty"`
	// If this property is populated, it will have the membership ID of the account considered to be \"primary\" in this user's cross save relationship.   If null, this user has no cross save relationship, nor primary account.
	PrimaryMembershipId int64            `json:"primaryMembershipId,omitempty"`
	BungieNetUser       *UserGeneralUser `json:"bungieNetUser,omitempty"`
}

type UserUserSearchPrefixRequest ¶

type UserUserSearchPrefixRequest struct {
	DisplayNamePrefix string `json:"displayNamePrefix,omitempty"`
}

type UserUserSearchResponse ¶

type UserUserSearchResponse struct {
	SearchResults []UserUserSearchResponseDetail `json:"searchResults,omitempty"`
	Page          int32                          `json:"page,omitempty"`
	HasMore       bool                           `json:"hasMore,omitempty"`
}

type UserUserSearchResponseDetail ¶

type UserUserSearchResponseDetail struct {
	BungieGlobalDisplayName     string             `json:"bungieGlobalDisplayName,omitempty"`
	BungieGlobalDisplayNameCode int32              `json:"bungieGlobalDisplayNameCode,omitempty"`
	BungieNetMembershipId       int64              `json:"bungieNetMembershipId,omitempty"`
	DestinyMemberships          []UserUserInfoCard `json:"destinyMemberships,omitempty"`
}

type UserUserToUserContext ¶

type UserUserToUserContext struct {
	IsFollowing         bool                   `json:"isFollowing,omitempty"`
	IgnoreStatus        *IgnoresIgnoreResponse `json:"ignoreStatus,omitempty"`
	GlobalIgnoreEndDate time.Time              `json:"globalIgnoreEndDate,omitempty"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL