bungie-api-sdk/src/types.ts

Integrate the Bungie API with TypeScript

/** User Membership Types */
type User = {
    UserMemberShip: {
        /** Type of the membership. Not necessarily the native type. (int32) */
        memershipType: number,
        /** Membership ID as they user is known in the Accounts service (int64) */
        membershipId: number,
        /** 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,
        /** The bungie global display name, if set. */
        bungieGlobalDisplayName: string,
        /** The bungie global display name code, if set. (int16) */
        bungieGlobalDisplayNameCode: number
    },

    /** Very basic info about a user as returned by the Account server, but including CrossSave information. Do NOT use as a request contract. */
    CrossSaveUserMembership: {
        /** If there is a cross save override in effect, this value will tell you the type that is overridding this one. (int32) */
        crossSaveOverride: number,
        /** 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 (int32[]) */
        applicableMembershipTypes: number[],
        /** If True, this is a public user membership. */
        isPublic: boolean,
        /** Type of the membership. Not necessarily the native type. (int32) */
        membershipType: number
        /** Membership ID as they user is known in the Accounts service (int64) */
        membershipId: number
        /** 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
        /** The bungie global display name, if set. */
        bungieGlobalDisplayName: string,
        /** The bungie global display name code, if set. (int16) */
        bungieGlobalDisplayNameCode: number | null
    }
};

let cat: User["UserMemberShip"]["displayName"];