bungie-net-core/models/User/UserMembership.d.ts

An easy way to interact with the Bungie.net API

/**
 * 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 { BungieMembershipType } from '../BungieMembershipType';
/**
 * Very basic info about a user as returned by the Account server.
 * @see {@link https://bungie-net.github.io/#/components/schemas/User.UserMembership}
 */
export interface UserMembership {
    /** Type of the membership. Not necessarily the native type. */
    readonly membershipType: BungieMembershipType;
    /** Membership ID as they user is known in the Accounts service */
    readonly membershipId: string;
    /**
     * 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.
     */
    readonly displayName: string;
    /** The bungie global display name, if set. */
    readonly bungieGlobalDisplayName: string;
    /** The bungie global display name code, if set. */
    readonly bungieGlobalDisplayNameCode?: number;
}