nodes/generated

Interface DiscourseNodeParameters

Source


interface DiscourseNodeParameters {
    additionalFields?:
        | {
            category?: string;
            reply_to_post_number?: string;
            topic_id?: string;
        }
        | { active?: boolean; approved?: boolean };
    by?: "username" | "externalId";
    categoryId?: string;
    color?: string;
    content?: string;
    email?: string;
    externalId?: string;
    flag?:
        | "new"
        | "blocked"
        | "active"
        | "staff"
        | "suspect"
        | "suspended";
    groupId?: string;
    limit?: number;
    name?: string;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "add"
    | "remove";
    options?: {
        asc?: boolean;
        order?: | "email"
        | "username"
        | "created"
        | "days_visited"
        | "last_emailed"
        | "posts"
        | "posts_read"
        | "read_time"
        | "seen"
        | "topics_viewed"
        | "trust_level";
        showEmails?: boolean;
        stats?: boolean;
    };
    password?: string;
    postId?: string;
    resource?: | "user"
    | "group"
    | "category"
    | "post"
    | "userGroup";
    returnAll?: boolean;
    textColor?: string;
    title?: string;
    updateFields?: | { color?: string; textColor?: string }
    | { cooked?: boolean; edit_reason?: string };
    username?: string;
    usernames?: string;
}

Properties§

§readonly additionalFields?:
    | {
        category?: string;
        reply_to_post_number?: string;
        topic_id?: string;
    }
    | { active?: boolean; approved?: boolean }

Default: {}

§readonly by?: "username" | "externalId"

What to search by Default: "username"

§readonly categoryId?: string

ID of the category

§readonly color?: string

Color of the category Default: "0000FF"

§readonly content?: string

Content of the post

§readonly email?: string

Email of the user to create

§readonly externalId?: string

Discourse SSO external ID

§readonly flag?:
    | "new"
    | "blocked"
    | "active"
    | "staff"
    | "suspect"
    | "suspended"

User flags to search for

§readonly groupId?: string

ID of the group to update

§readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1,"maxValue":100}

§readonly name?: string

Name of the category

§readonly operation?: "create" | "get" | "getAll" | "update" | "add" | "remove"

Choose an operation Default: "create"

§readonly options?: { ... }

Default: {}

§readonly password?: string

The password of the user to create Type options: {"password":true}

§readonly postId?: string

ID of the post

§readonly resource?: "user" | "group" | "category" | "post" | "userGroup"

Default: "post"

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly textColor?: string

Text color of the category Default: "0000FF"

§readonly title?: string

Title of the post

§readonly updateFields?:
    | { color?: string; textColor?: string }
    | { cooked?: boolean; edit_reason?: string }

Default: {}

§readonly username?: string

The username of the user to create

§readonly usernames?: string

Usernames to add to group. Multiples can be defined separated by comma.