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

NodeJS SDK for the Trophy API

import type * as TrophyApi from "../index";
/**
 * A points boost to create. May optionally target a specific user via `userId` or filter by user attributes via `userAttributes`. These two fields are mutually exclusive.
 */
export interface CreatePointsBoostRequestItem {
    /** The ID of the user to create a boost for. Mutually exclusive with `userAttributes` — providing `userAttributes` when `userId` is set will result in an error. Omit for a global boost. */
    userId?: string;
    /** The name of the boost. */
    name: string;
    /** The start date of the boost (YYYY-MM-DD). */
    start: string;
    /** The end date of the boost (YYYY-MM-DD). If null, the boost has no end date. */
    end?: string;
    /** The points multiplier. Must be greater than 0, not equal to 1, and less than 100. */
    multiplier: number;
    /** How to round the boosted points. Defaults to 'down'. */
    rounding?: TrophyApi.CreatePointsBoostRequestItemRounding;
    /** User attribute filters for the boost. Cannot be provided when `userId` is set. */
    userAttributes?: TrophyApi.CreatePointsBoostRequestItemUserAttributesItem[];
}