bungie-net-core
Version:
An easy way to interact with the Bungie.net API
63 lines (62 loc) • 2.79 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.
*/
import { DestinyProgression } from '../../DestinyProgression';
/**
* This component contains essential/summary information about the vendor.
* @see {@link https://bungie-net.github.io/#/components/schemas/Destiny.Entities.Vendors.DestinyVendorComponent}
*/
export interface DestinyVendorComponent {
/** If True, you can purchase from the Vendor. */
readonly canPurchase: boolean;
/**
* If the Vendor has a related Reputation, this is the Progression data that
* represents the character's Reputation level with this Vendor.
*/
readonly progression: DestinyProgression;
/**
* 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)
*/
readonly vendorLocationIndex: number;
/**
* 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.
*/
readonly seasonalRank?: number;
/**
* The unique identifier for the vendor. Use it to look up their
* DestinyVendorDefinition. Mapped to DestinyVendorDefinition in the manifest.
*/
readonly vendorHash: number;
/**
* 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.
*/
readonly nextRefreshDate: string;
/**
* If True, the Vendor is currently accessible.
*
* If False, they may not actually be visible in the world at the moment.
*/
readonly enabled: boolean;
}