Class APIAdminFeedback

The feedback board - the staff side. Post moderation, tags and bans are staff + developers; boards (and rewriting a post's title / body) are developers only (403 otherwise). None is behind the feedback flag, so boards can be set up before launch. Every change is written to the audit log (getFeedbackAudits).

Constructors

constructor

new APIAdminFeedback(web): APIAdminFeedback
Parameters
- web: WebDataManager
Returns APIAdminFeedback
- Defined in src/classes/adminFeedback.ts:12

Methods

createAdminFeedbackComment

createAdminFeedbackComment(__namedParameters): Promise<WebResponse<FeedbackThread>>
Comment as staff: internal for a staff-only note (a reply under a note is a note too), official for the pinned answer (replaces the current one; never a note, never a reply). Returns the full thread incl. notes.
Parameters
- __namedParameters: {
      auth: string;
      comment: {
          body: string;
          internal?: boolean;
          official?: boolean;
          parentId?: string;
          uploadIds?: string[];
      };
      number: number;
  }
  - auth: string
  - comment: {
        body: string;
        internal?: boolean;
        official?: boolean;
        parentId?: string;
        uploadIds?: string[];
    }
    - body: string
    - Optionalinternal?: boolean
    - Optionalofficial?: boolean
    - OptionalparentId?: string
    - OptionaluploadIds?: string[]
  - number: number
Returns Promise<WebResponse<FeedbackThread>>
- Defined in src/classes/adminFeedback.ts:149

createFeedbackBan

createFeedbackBan(__namedParameters): Promise<WebResponse<{
banId: string;
}>>
Ban a user from posting, commenting (and reacting), voting, or all of it. Survives their data deletion.
Parameters
- __namedParameters: {
      auth: string;
      ban: {
          reason: string;
          scope:
              | "post"
              | "all"
              | "vote"
              | "comment";
          until?: null | string;
          userId: string;
      };
  }
  - auth: string
  - ban: {
        reason: string;
        scope:
            | "post"
            | "all"
            | "vote"
            | "comment";
        until?: null | string;
        userId: string;
    }
    - reason: string
    - scope:
          | "post"
          | "all"
          | "vote"
          | "comment"
    - Optionaluntil?: null | string
    - userId: string
Returns Promise<WebResponse<{
banId: string;
}>>
- Defined in src/classes/adminFeedback.ts:130

createFeedbackBoard

createFeedbackBoard(__namedParameters): Promise<WebResponse<{
boardId: string;
}>>
Developers only. minTierId needs audience: 'premium' and a paid guild plan.
Parameters
- __namedParameters: {
  auth: string;
  board: FeedbackBoardInput;
  }
  - auth: string
  - board: FeedbackBoardInput
Returns Promise<WebResponse<{
boardId: string;
}>>
- Defined in src/classes/adminFeedback.ts:72

createFeedbackMerge

createFeedbackMerge(__namedParameters): Promise<WebResponse<{
movedVotes: number;
post: null | AdminFeedbackPost;
}>>
Merge post number into intoNumber: votes move (one per user), comments and follows move, the old number redirects. There is no unmerge. Refusals: same_post, not_found, already_merged, target_merged, deleted, busy.
Parameters
- __namedParameters: {
      auth: string;
      intoNumber: number;
      number: number;
  }
  - auth: string
  - intoNumber: number
  - number: number
Returns Promise<WebResponse<{
movedVotes: number;
post: null | AdminFeedbackPost;
}>>
- Defined in src/classes/adminFeedback.ts:56

createFeedbackTag

createFeedbackTag(__namedParameters): Promise<WebResponse<{
tagId: string;
}>>
Parameters
- __namedParameters: {
      auth: string;
      tag: {
          color: string;
          hidden?: boolean;
          name: string;
          slug: string;
      };
  }
  - auth: string
  - tag: {
        color: string;
        hidden?: boolean;
        name: string;
        slug: string;
    }
    - color: string
    - Optionalhidden?: boolean
    - name: string
    - slug: string
Returns Promise<WebResponse<{
tagId: string;
}>>
- Defined in src/classes/adminFeedback.ts:104

createFeedbackUserHide

createFeedbackUserHide(__namedParameters): Promise<WebResponse<{
comments: number;
posts: number;
}>>
Hide everything one user wrote: scope posts, comments or all. reason is shown to them on each hidden post. Deleted posts / comments are left alone. Their posts' staff-channel messages are removed. busy (409) while another bulk hide for them runs.
Parameters
- __namedParameters: {
      auth: string;
      reason?: null | string;
      scope: "all" | "posts" | "comments";
      userId: string;
  }
  - auth: string
  - Optionalreason?: null | string
  - scope: "all" | "posts" | "comments"
  - userId: string
Returns Promise<WebResponse<{
comments: number;
posts: number;
}>>
- Defined in src/classes/adminFeedback.ts:186

deleteAdminFeedbackPost

deleteAdminFeedbackPost(__namedParameters): Promise<WebResponse<{
post: null | AdminFeedbackPost;
}>>
A SOFT delete, the same as updateAdminFeedbackPost({ post: { deleted: true } }): restore with deleted: false. There is no permanent delete.
Parameters
- __namedParameters: {
  auth: string;
  number: number;
  }
  - auth: string
  - number: number
Returns Promise<WebResponse<{
post: null | AdminFeedbackPost;
}>>
- Defined in src/classes/adminFeedback.ts:44

deleteFeedbackBan

deleteFeedbackBan(__namedParameters): Promise<WebResponse<{
deleted: true;
}>>
Parameters
- __namedParameters: {
  auth: string;
  banId: string;
  }
  - auth: string
  - banId: string
Returns Promise<WebResponse<{
deleted: true;
}>>
- Defined in src/classes/adminFeedback.ts:138

deleteFeedbackBoard

deleteFeedbackBoard(__namedParameters): Promise<WebResponse<{
deleted: true;
}>>
Only an empty board (board_has_posts otherwise - archive it instead).
Parameters
- __namedParameters: {
  auth: string;
  boardId: string;
  }
  - auth: string
  - boardId: string
Returns Promise<WebResponse<{
deleted: true;
}>>
- Defined in src/classes/adminFeedback.ts:89

deleteFeedbackUserHide

deleteFeedbackUserHide(__namedParameters): Promise<WebResponse<{
comments: number;
posts: number;
}>>
Show again: un-hides ALL of their hidden posts / comments in scope, including ones hidden one by one earlier.
Parameters
- __namedParameters: {
      auth: string;
      scope: "all" | "posts" | "comments";
      userId: string;
  }
  - auth: string
  - scope: "all" | "posts" | "comments"
  - userId: string
Returns Promise<WebResponse<{
comments: number;
posts: number;
}>>
- Defined in src/classes/adminFeedback.ts:195

getAdminFeedbackBoards

getAdminFeedbackBoards(__namedParameters): Promise<WebResponse<{
boards: AdminFeedbackBoard[];
}>>
Parameters
- __namedParameters: {
  auth: string;
  }
  - auth: string
Returns Promise<WebResponse<{
boards: AdminFeedbackBoard[];
}>>
- Defined in src/classes/adminFeedback.ts:64

getAdminFeedbackPost

getAdminFeedbackPost(__namedParameters): Promise<WebResponse<{
breakdown: FeedbackVoteBreakdown;
post: AdminFeedbackPost;
}>>
One post with who wants it: votes by plan, voters' server reach, share from accounts under 30 days.
Parameters
- __namedParameters: {
  auth: string;
  number: number;
  }
  - auth: string
  - number: number
Returns Promise<WebResponse<{
breakdown: FeedbackVoteBreakdown;
post: AdminFeedbackPost;
}>>
- Defined in src/classes/adminFeedback.ts:23

getAdminFeedbackPosts

getAdminFeedbackPosts(__namedParameters): Promise<WebResponse<{
    limit: number;
    offset: number;
    posts: AdminFeedbackPost[];
    total: number;
}>>
Every post incl. hidden / private. deleted: true lists deleted ones instead; merged: true includes merged ones.
Parameters
- __namedParameters: {
      auth: string;
      boardId?: string;
      deleted?: boolean;
      hidden?: boolean;
      limit?: number;
      merged?: boolean;
      offset?: number;
      q?: string;
      sort?: "top" | "new";
      status?:
          | "done"
          | "open"
          | "underReview"
          | "planned"
          | "inProgress"
          | "declined";
  }
  - auth: string
  - OptionalboardId?: string
  - Optionaldeleted?: boolean
  - Optionalhidden?: boolean
  - Optionallimit?: number
  - Optionalmerged?: boolean
  - Optionaloffset?: number
  - Optionalq?: string
  - Optionalsort?: "top" | "new"
  - Optionalstatus?:
        | "done"
        | "open"
        | "underReview"
        | "planned"
        | "inProgress"
        | "declined"
Returns Promise<WebResponse<{
    limit: number;
    offset: number;
    posts: AdminFeedbackPost[];
    total: number;
}>>
- Defined in src/classes/adminFeedback.ts:15

getAdminFeedbackTags

getAdminFeedbackTags(__namedParameters): Promise<WebResponse<{
    tags: {
        color: string;
        hidden: boolean;
        name: string;
        slug: string;
        tagId: string;
    }[];
}>>
Every tag, hidden ones included.
Parameters
- __namedParameters: {
  auth: string;
  }
  - auth: string
Returns Promise<WebResponse<{
    tags: {
        color: string;
        hidden: boolean;
        name: string;
        slug: string;
        tagId: string;
    }[];
}>>
- Defined in src/classes/adminFeedback.ts:97

getAdminFeedbackUser

getAdminFeedbackUser(__namedParameters): Promise<WebResponse<AdminFeedbackUser>>
A user's feedback profile for staff: who they are (display name, avatar, account age), counts, their newest 100 posts and comments - hidden and deleted included - and their bans. 404 when they have no feedback at all. Reach it from a post's authorId or a comment's authorId.
Parameters
- __namedParameters: {
  auth: string;
  userId: string;
  }
  - auth: string
  - userId: string
Returns Promise<WebResponse<AdminFeedbackUser>>
- Defined in src/classes/adminFeedback.ts:174

getFeedbackAudits

getFeedbackAudits(__namedParameters): Promise<WebResponse<{
    audits: FeedbackAudit[];
    limit: number;
    offset: number;
}>>
The staff action log, newest first. target filters, e.g. post:42, board:<id>, user:<discordId>.
Parameters
- __namedParameters: {
      auth: string;
      limit?: number;
      offset?: number;
      target?: string;
  }
  - auth: string
  - Optionallimit?: number
  - Optionaloffset?: number
  - Optionaltarget?: string
Returns Promise<WebResponse<{
    audits: FeedbackAudit[];
    limit: number;
    offset: number;
}>>
- Defined in src/classes/adminFeedback.ts:203

getFeedbackBans

getFeedbackBans(__namedParameters): Promise<WebResponse<{
bans: FeedbackBan[];
}>>
Active bans (all: true includes expired), optionally for one userId.
Parameters
- __namedParameters: {
      all?: boolean;
      auth: string;
      userId?: string;
  }
  - Optionalall?: boolean
  - auth: string
  - OptionaluserId?: string
Returns Promise<WebResponse<{
bans: FeedbackBan[];
}>>
- Defined in src/classes/adminFeedback.ts:122

updateAdminFeedbackComment

updateAdminFeedbackComment(__namedParameters): Promise<WebResponse<FeedbackThread>>
Rewrite a comment (body: markdown, same rules and limits as a member comment; sets editedAt), hide / unhide it, or make it (or stop it being) the official answer. Audit-logged. A deleted comment's body answers 403 not_editable.
Parameters
- __namedParameters: {
      auth: string;
      comment: {
          body?: string;
          hidden?: boolean;
          official?: boolean;
      };
      commentId: string;
  }
  - auth: string
  - comment: {
        body?: string;
        hidden?: boolean;
        official?: boolean;
    }
    - Optionalbody?: string
    - Optionalhidden?: boolean
    - Optionalofficial?: boolean
  - commentId: string
Returns Promise<WebResponse<FeedbackThread>>
- Defined in src/classes/adminFeedback.ts:161

updateAdminFeedbackPost

updateAdminFeedbackPost(__namedParameters): Promise<WebResponse<{
post: null | AdminFeedbackPost;
}>>
Moderate a post; send only what changes. status: 'done' sets shippedAt. audienceOverride may only narrow the board (audience_widens_board). featured puts it on the main page (until featuredUntil). deleted soft-deletes / restores. title / body are developers only.
Parameters
- __namedParameters: {
      auth: string;
      number: number;
      post: AdminFeedbackPostUpdate;
  }
  - auth: string
  - number: number
  - post: AdminFeedbackPostUpdate
Returns Promise<WebResponse<{
post: null | AdminFeedbackPost;
}>>
- Defined in src/classes/adminFeedback.ts:35

updateFeedbackBoard

updateFeedbackBoard(__namedParameters): Promise<WebResponse<{
boardId: string;
}>>
Parameters
- __namedParameters: {
      auth: string;
      board: Partial<FeedbackBoardInput>;
      boardId: string;
  }
  - auth: string
  - board: Partial<FeedbackBoardInput>
  - boardId: string
Returns Promise<WebResponse<{
boardId: string;
}>>
- Defined in src/classes/adminFeedback.ts:80

updateFeedbackTag

updateFeedbackTag(__namedParameters): Promise<WebResponse<{
tagId: string;
}>>
Tags are hidden, never deleted.
Parameters
- __namedParameters: {
      auth: string;
      tag: {
          color?: string;
          hidden?: boolean;
          name?: string;
          slug?: string;
      };
      tagId: string;
  }
  - auth: string
  - tag: {
        color?: string;
        hidden?: boolean;
        name?: string;
        slug?: string;
    }
    - Optionalcolor?: string
    - Optionalhidden?: boolean
    - Optionalname?: string
    - Optionalslug?: string
  - tagId: string
Returns Promise<WebResponse<{
tagId: string;
}>>
- Defined in src/classes/adminFeedback.ts:113

Class APIAdminFeedback

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns APIAdminFeedback

Methods

createAdminFeedbackComment

Parameters

auth: string

comment: { body: string; internal?: boolean; official?: boolean; parentId?: string; uploadIds?: string[]; }

body: string

Optionalinternal?: boolean

Optionalofficial?: boolean

OptionalparentId?: string

OptionaluploadIds?: string[]

number: number

Returns Promise<WebResponse<FeedbackThread>>

createFeedbackBan

Parameters

auth: string

ban: { reason: string; scope: | "post" | "all" | "vote" | "comment"; until?: null | string; userId: string; }

reason: string

scope: | "post" | "all" | "vote" | "comment"

Optionaluntil?: null | string

userId: string

Returns Promise<WebResponse<{ banId: string; }>>

createFeedbackBoard

Parameters

auth: string

board: FeedbackBoardInput

Returns Promise<WebResponse<{ boardId: string; }>>

createFeedbackMerge

Parameters

auth: string

intoNumber: number

number: number

Returns Promise<WebResponse<{ movedVotes: number; post: null | AdminFeedbackPost; }>>

createFeedbackTag

Parameters

auth: string

tag: { color: string; hidden?: boolean; name: string; slug: string; }

color: string

Optionalhidden?: boolean

name: string

slug: string

Returns Promise<WebResponse<{ tagId: string; }>>

createFeedbackUserHide

Parameters

auth: string

Optionalreason?: null | string

scope: "all" | "posts" | "comments"

userId: string

Returns Promise<WebResponse<{ comments: number; posts: number; }>>

deleteAdminFeedbackPost

Parameters

auth: string

number: number

Returns Promise<WebResponse<{ post: null | AdminFeedbackPost; }>>

deleteFeedbackBan

Parameters

auth: string

banId: string

Returns Promise<WebResponse<{ deleted: true; }>>

deleteFeedbackBoard

Parameters

auth: string

boardId: string

Returns Promise<WebResponse<{ deleted: true; }>>

deleteFeedbackUserHide

Parameters

auth: string

scope: "all" | "posts" | "comments"

userId: string

Returns Promise<WebResponse<{ comments: number; posts: number; }>>

getAdminFeedbackBoards

Parameters

auth: string

comment: {
body: string;
internal?: boolean;
official?: boolean;
parentId?: string;
uploadIds?: string[];
}

`Optional`internal?: boolean

`Optional`official?: boolean

`Optional`parentId?: string

`Optional`uploadIds?: string[]

ban: {
reason: string;
scope:
| "post"
| "all"
| "vote"
| "comment";
until?: null | string;
userId: string;
}

scope:
| "post"
| "all"
| "vote"
| "comment"

`Optional`until?: null | string

Returns Promise<WebResponse<{
banId: string;
}>>

Returns Promise<WebResponse<{
boardId: string;
}>>

Returns Promise<WebResponse<{
movedVotes: number;
post: null | AdminFeedbackPost;
}>>

tag: {
color: string;
hidden?: boolean;
name: string;
slug: string;
}

`Optional`hidden?: boolean

Returns Promise<WebResponse<{
tagId: string;
}>>

`Optional`reason?: null | string

Returns Promise<WebResponse<{
comments: number;
posts: number;
}>>

Returns Promise<WebResponse<{
post: null | AdminFeedbackPost;
}>>

Returns Promise<WebResponse<{
deleted: true;
}>>

Returns Promise<WebResponse<{
deleted: true;
}>>

Returns Promise<WebResponse<{
comments: number;
posts: number;
}>>

Returns Promise<WebResponse<{
boards: AdminFeedbackBoard[];
}>>

Returns Promise<WebResponse<{
breakdown: FeedbackVoteBreakdown;
post: AdminFeedbackPost;
}>>

`Optional`boardId?: string

`Optional`deleted?: boolean

`Optional`hidden?: boolean

`Optional`limit?: number

`Optional`merged?: boolean

`Optional`offset?: number

`Optional`q?: string

`Optional`sort?: "top" | "new"

`Optional`status?:
| "done"
| "open"
| "underReview"
| "planned"
| "inProgress"
| "declined"

Returns Promise<WebResponse<{
limit: number;
offset: number;
posts: AdminFeedbackPost[];
total: number;
}>>

Returns Promise<WebResponse<{
tags: {
color: string;
hidden: boolean;
name: string;
slug: string;
tagId: string;
}[];
}>>

`Optional`limit?: number

`Optional`offset?: number

`Optional`target?: string

Returns Promise<WebResponse<{
audits: FeedbackAudit[];
limit: number;
offset: number;
}>>

`Optional`all?: boolean

`Optional`userId?: string

Returns Promise<WebResponse<{
bans: FeedbackBan[];
}>>

comment: {
body?: string;
hidden?: boolean;
official?: boolean;
}

`Optional`body?: string

`Optional`hidden?: boolean

`Optional`official?: boolean

Returns Promise<WebResponse<{
post: null | AdminFeedbackPost;
}>>

Returns Promise<WebResponse<{
boardId: string;
}>>

tag: {
color?: string;
hidden?: boolean;
name?: string;
slug?: string;
}

`Optional`color?: string

`Optional`hidden?: boolean

`Optional`name?: string

`Optional`slug?: string