battlenet-api-types/src/profile/character-soulbinds.ts

Typescript interfaces for Blizzard's Battle.net API

/**
 * @categoryDescription Character Soulbinds API
 * Character Soulbinds API
 * @module
 */

import { linksStruct, characterRef, refStruct } from "../shared";

/**
 * Character Soulbinds
 * 
 * /profile/wow/character/{realmSlug}/{characterName}/soulbinds 
 * @category Character Soulbinds API
 */
export interface APICharacterSoulbinds {
    _links: linksStruct;
    character: characterRef;
    chosen_covenant: refStruct;
    renown_level: number;
    soulbinds: characterSoulbind[]
}

export interface characterSoulbind {
    soulbind: refStruct;
    traits: (characterSoulbindTrait | characterSoulbindConduitSocket)[]
}

/**
 * @category Character Soulbinds API
 */
export interface characterSoulbindTrait {
    trait: refStruct;
    tier: number;
    display_order: number;
}

/**
 * @category Character Soulbinds API
 */
export interface characterSoulbindConduitSocket {
    conduit_socket: {
        type: {
            name: string;
            type: string;
        }
        socket: {
            conduit: refStruct;
        }
        rank: number;
    }
    tier: number;
    display_order: number;
}