@trophyso/node/api/types/CreatePointsSystemRequestItem.d.ts

NodeJS SDK for the Trophy API

import type * as TrophyApi from "../index";
/**
 * A points system to create. Optionally include sub-entities.
 */
export interface CreatePointsSystemRequestItem {
    /** The points system name. */
    name: string;
    /** The points system key. Only alphanumeric characters, hyphens, and underscores are permitted. */
    key: string;
    /** A short description of the points system. */
    description?: string;
    /** An optional badge for the points system. */
    badge?: TrophyApi.CreatePointsSystemRequestItemBadge;
    /** Optional maximum points a user can earn. */
    maxPoints?: number;
    /** Optional array of levels to create alongside the system. */
    levels?: TrophyApi.CreatePointsLevelRequestItem[];
    /** Optional array of boosts to create alongside the system. */
    boosts?: TrophyApi.CreatePointsBoostRequestItem[];
    /** Optional array of triggers to create alongside the system. */
    triggers?: TrophyApi.CreatePointsTriggerRequestItem[];
}