bungie-net-core
Version:
An easy way to interact with the Bungie.net API
46 lines (45 loc) • 2.01 kB
TypeScript
/**
* 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.
*
* Contact: support@bungie.com
*
* NOTE: This class is auto generated by the bungie-net-core code generator program
* Repository: {@link https://github.com/owens1127/bungie-net-core}
* Do not edit these files manually.
*/
/**
* 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.
* @see {@link https://bungie-net.github.io/#/components/schemas/Destiny.Definitions.DestinyVendorGroupDefinition}
*/
export interface DestinyVendorGroupDefinition {
/** The recommended order in which to render the groups, Ascending order. */
readonly order: number;
/** For now, a group just has a name. */
readonly categoryName: string;
/**
* 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.
*/
readonly hash: number;
/** The index of the entity as it was found in the investment tables. */
readonly index: number;
/**
* If this is true, then there is an entity with this identifier/type combination,
* but BNet is not yet allowed to show it. Sorry!
*/
readonly redacted: boolean;
}