@devvit/reddit 0.11.17-next-2025-05-28-417d95f5a.0

package/models/ModNote.d.ts

@@ -0,0 +1,57 @@
+import type { DeleteNotesRequest, GetNotesRequest, PostNotesRequest, PostRemovalNoteRequest } from '@devvit/protos';
+import type { Prettify } from '@devvit/shared-types/Prettify.js';
+import type { T1ID, T2ID, T3ID, T5ID } from '@devvit/shared-types/tid.js';
+import type { ListingFetchOptions } from './Listing.js';
+import { Listing } from './Listing.js';
+import type { ModAction } from './ModAction.js';
+export type ModNoteType = 'NOTE' | 'APPROVAL' | 'REMOVAL' | 'BAN' | 'MUTE' | 'INVITE' | 'SPAM' | 'CONTENT_CHANGE' | 'MOD_ACTION' | 'ALL';
+export type UserNoteLabel = 'BOT_BAN' | 'PERMA_BAN' | 'BAN' | 'ABUSE_WARNING' | 'SPAM_WARNING' | 'SPAM_WATCH' | 'SOLID_CONTRIBUTOR' | 'HELPFUL_USER';
+export type UserNote = {
+    note?: string | undefined;
+    redditId?: T1ID | T3ID | T5ID | undefined;
+    label?: UserNoteLabel | undefined;
+};
+export interface ModNote {
+    id: string;
+    operator: {
+        id?: T2ID | undefined;
+        name?: string | undefined;
+    };
+    user: {
+        id?: T2ID | undefined;
+        name?: string | undefined;
+    };
+    subreddit: {
+        id?: T5ID | undefined;
+        name?: string | undefined;
+    };
+    type: ModNoteType;
+    createdAt: Date;
+    userNote?: UserNote | undefined;
+    modAction?: ModAction;
+}
+export type GetModNotesOptions = Prettify<Pick<GetNotesRequest, 'subreddit' | 'user'> & {
+    filter?: ModNoteType;
+} & Pick<ListingFetchOptions, 'limit' | 'before'>>;
+export type CreateModNoteOptions = Prettify<PostNotesRequest & {
+    redditId?: T1ID | T3ID;
+    label?: UserNoteLabel;
+}>;
+export type DeleteNotesOptions = Prettify<DeleteNotesRequest>;
+export type AddRemovalNoteOptions = Prettify<PostRemovalNoteRequest>;
+export declare class ModNote {
+    #private;
+    /**
+     * @internal
+     */
+    private constructor();
+    /** @internal */
+    static get(options: GetModNotesOptions): Listing<ModNote>;
+    /** @internal */
+    static delete(options: DeleteNotesOptions): Promise<boolean>;
+    /** @internal */
+    static add(options: CreateModNoteOptions): Promise<ModNote>;
+    /** @internal */
+    static addRemovalNote(options: AddRemovalNoteOptions): Promise<void>;
+}
+//# sourceMappingURL=ModNote.d.ts.map

package/models/ModNote.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModNote.d.ts","sourceRoot":"","sources":["../../src/models/ModNote.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAClB,eAAe,EAGf,gBAAgB,EAChB,sBAAsB,EACvB,MAAM,gBAAgB,CAAC;AAGxB,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,6BAA6B,CAAC;AAI1E,OAAO,KAAK,EAAE,mBAAmB,EAAwB,MAAM,cAAc,CAAC;AAC9E,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD,MAAM,MAAM,WAAW,GACnB,MAAM,GACN,UAAU,GACV,SAAS,GACT,KAAK,GACL,MAAM,GACN,QAAQ,GACR,MAAM,GACN,gBAAgB,GAChB,YAAY,GACZ,KAAK,CAAC;AAEV,MAAM,MAAM,aAAa,GACrB,SAAS,GACT,WAAW,GACX,KAAK,GACL,eAAe,GACf,cAAc,GACd,YAAY,GACZ,mBAAmB,GACnB,cAAc,CAAC;AAEnB,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,QAAQ,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,SAAS,CAAC;IAC1C,KAAK,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;CACnC,CAAC;AAEF,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE;QACR,EAAE,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;QACtB,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;KAC3B,CAAC;IACF,IAAI,EAAE;QACJ,EAAE,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;QACtB,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;KAC3B,CAAC;IACF,SAAS,EAAE;QACT,EAAE,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;QACtB,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;KAC3B,CAAC;IACF,IAAI,EAAE,WAAW,CAAC;IAClB,SAAS,EAAE,IAAI,CAAC;IAChB,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAChC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAED,MAAM,MAAM,kBAAkB,GAAG,QAAQ,CACvC,IAAI,CAAC,eAAe,EAAE,WAAW,GAAG,MAAM,CAAC,GAAG;IAC5C,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,GAAG,IAAI,CAAC,mBAAmB,EAAE,OAAO,GAAG,QAAQ,CAAC,CAClD,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,QAAQ,CACzC,gBAAgB,GAAG;IACjB,QAAQ,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACvB,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB,CACF,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,QAAQ,CAAC,kBAAkB,CAAC,CAAC;AAE9D,MAAM,MAAM,qBAAqB,GAAG,QAAQ,CAAC,sBAAsB,CAAC,CAAC;AAErE,qBAAa,OAAO;;IAClB;;OAEG;IACH,OAAO;IA0CP,gBAAgB;IAChB,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,OAAO,CAAC;IA+BzD,gBAAgB;WACH,MAAM,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,OAAO,CAAC;IAMlE,gBAAgB;WACH,GAAG,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IASjE,gBAAgB;WACH,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;CAS3E"}

package/models/ModNote.js

@@ -0,0 +1,103 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _a, _ModNote_fromProto, _ModNote_metadata_get;
+import { getContext } from '@devvit/server';
+import { assertNonNull } from '@devvit/shared-types/NonNull.js';
+import { asT2ID, asT5ID, asTID } from '@devvit/shared-types/tid.js';
+import { getRedditApiPlugins } from '../getRedditApiPlugins.js';
+import { Listing } from './Listing.js';
+export class ModNote {
+    /**
+     * @internal
+     */
+    constructor() { }
+    /** @internal */
+    static get(options) {
+        const client = getRedditApiPlugins().ModNote;
+        return new Listing({
+            hasMore: true,
+            before: options.before,
+            limit: options.limit,
+            pageSize: options.limit,
+            fetch: async (fetchOptions) => {
+                const protoRes = await client.GetNotes({
+                    subreddit: options.subreddit,
+                    user: options.user,
+                    filter: options.filter,
+                    before: fetchOptions.before,
+                    limit: fetchOptions.limit,
+                }, __classPrivateFieldGet(this, _a, "a", _ModNote_metadata_get));
+                return {
+                    children: protoRes.modNotes?.map((protoModNote) => __classPrivateFieldGet(this, _a, "m", _ModNote_fromProto).call(this, protoModNote)) || [],
+                    // if the response says that there are no more pages, then we should set before to undefined
+                    // to prevent more requests from being made
+                    before: protoRes.hasNextPage ? protoRes.endCursor : undefined,
+                    hasMore: protoRes.hasNextPage,
+                };
+            },
+        });
+    }
+    /** @internal */
+    static async delete(options) {
+        const client = getRedditApiPlugins().ModNote;
+        const { deleted } = await client.DeleteNotes(options, __classPrivateFieldGet(this, _a, "a", _ModNote_metadata_get));
+        return !!deleted;
+    }
+    /** @internal */
+    static async add(options) {
+        const client = getRedditApiPlugins().ModNote;
+        const res = await client.PostNotes(options, __classPrivateFieldGet(this, _a, "a", _ModNote_metadata_get));
+        if (!res?.created) {
+            throw new Error('Failed to create mod note');
+        }
+        return __classPrivateFieldGet(this, _a, "m", _ModNote_fromProto).call(this, res.created);
+    }
+    /** @internal */
+    static async addRemovalNote(options) {
+        const client = getRedditApiPlugins().ModNote;
+        await client.PostRemovalNote(options, __classPrivateFieldGet(this, _a, "a", _ModNote_metadata_get));
+    }
+}
+_a = ModNote, _ModNote_fromProto = function _ModNote_fromProto(protoModNote) {
+    // check that all required fields of protoModNote needed to create a ModNote are present
+    assertNonNull(protoModNote.id, 'Mod note ID is null or undefined');
+    assertNonNull(protoModNote.createdAt, 'Mod note createdAt is null or undefined');
+    assertNonNull(protoModNote.type, 'Mod note type is null or undefined');
+    assertNonNull(protoModNote.subreddit, 'Mod note subreddit is null or undefined');
+    assertNonNull(protoModNote.subredditId, 'Mod note subredditId is null or undefined');
+    assertNonNull(protoModNote.operator, 'Mod note operator is null or undefined');
+    assertNonNull(protoModNote.operatorId, 'Mod note operatorId is null or undefined');
+    assertNonNull(protoModNote.user, 'Mod note user is null or undefined');
+    assertNonNull(protoModNote.userId, 'Mod note userId is null or undefined');
+    assertNonNull(protoModNote.userNoteData, 'Mod note userNote is null or undefined');
+    assertNonNull(protoModNote.modActionData, 'Mod note modAction is null or undefined');
+    return {
+        id: protoModNote.id,
+        user: {
+            id: asT2ID(protoModNote.userId ?? ''),
+            name: protoModNote.user,
+        },
+        subreddit: {
+            id: asT5ID(protoModNote.subredditId ?? ''),
+            name: protoModNote.subreddit,
+        },
+        operator: {
+            id: asT2ID(protoModNote.operatorId ?? ''),
+            name: protoModNote.operator,
+        },
+        createdAt: new Date(protoModNote.createdAt * 1000), // convert to ms
+        userNote: {
+            note: protoModNote.userNoteData?.note,
+            redditId: protoModNote.userNoteData?.redditId
+                ? asTID(protoModNote.userNoteData?.redditId)
+                : undefined,
+            label: protoModNote.userNoteData?.label,
+        },
+        type: protoModNote.type,
+    };
+}, _ModNote_metadata_get = function _ModNote_metadata_get() {
+    return getContext().debug.metadata;
+};

package/models/Post.d.ts

@@ -0,0 +1,491 @@
+import type { RedditObject } from '@devvit/protos';
+import type { GalleryMediaStatus as GalleryMediaStatusProto } from '@devvit/protos';
+import { RichTextBuilder } from '@devvit/shared-types/richtext/RichTextBuilder.js';
+import type { T2ID, T3ID, T5ID } from '@devvit/shared-types/tid.js';
+import { type UserGeneratedContent } from '../common.js';
+import type { CommentSubmissionOptions } from './Comment.js';
+import { Comment } from './Comment.js';
+import type { ListingFetchOptions } from './Listing.js';
+import { Listing } from './Listing.js';
+import { User } from './User.js';
+export type GetPostsOptions = ListingFetchOptions & {
+    subredditName?: string;
+};
+export type GetPostsOptionsWithTimeframe = GetPostsOptions & {
+    timeframe?: 'hour' | 'day' | 'week' | 'month' | 'year' | 'all';
+};
+export type GetSortedPostsOptions = GetPostsOptionsWithTimeframe & {
+    sort: 'top' | 'controversial';
+};
+export type GetHotPostsOptions = GetPostsOptions & {
+    location?: 'GLOBAL' | 'US' | 'AR' | 'AU' | 'BG' | 'CA' | 'CL' | 'CO' | 'HR' | 'CZ' | 'FI' | 'FR' | 'DE' | 'GR' | 'HU' | 'IS' | 'IN' | 'IE' | 'IT' | 'JP' | 'MY' | 'MX' | 'NZ' | 'PH' | 'PL' | 'PT' | 'PR' | 'RO' | 'RS' | 'SG' | 'ES' | 'SE' | 'TW' | 'TH' | 'TR' | 'GB' | 'US_WA' | 'US_DE' | 'US_DC' | 'US_WI' | 'US_WV' | 'US_HI' | 'US_FL' | 'US_WY' | 'US_NH' | 'US_NJ' | 'US_NM' | 'US_TX' | 'US_LA' | 'US_NC' | 'US_ND' | 'US_NE' | 'US_TN' | 'US_NY' | 'US_PA' | 'US_CA' | 'US_NV' | 'US_VA' | 'US_CO' | 'US_AK' | 'US_AL' | 'US_AR' | 'US_VT' | 'US_IL' | 'US_GA' | 'US_IN' | 'US_IA' | 'US_OK' | 'US_AZ' | 'US_ID' | 'US_CT' | 'US_ME' | 'US_MD' | 'US_MA' | 'US_OH' | 'US_UT' | 'US_MO' | 'US_MN' | 'US_MI' | 'US_RI' | 'US_KS' | 'US_MT' | 'US_MS' | 'US_SC' | 'US_KY' | 'US_OR' | 'US_SD';
+};
+export type GetPostsByUserOptions = {
+    username: string;
+    sort?: 'hot' | 'new' | 'top' | 'controversial';
+    timeframe?: 'hour' | 'day' | 'week' | 'month' | 'year' | 'all';
+    pageSize?: number;
+    limit?: number;
+    after?: string;
+    before?: string;
+};
+export type PostSuggestedCommentSort = 'BLANK'
+/** "Best" sort. */
+ | 'CONFIDENCE' | 'CONTROVERSIAL' | 'LIVE'
+/** Sort comments by creation time. */
+ | 'NEW' | 'OLD'
+/** Similar to the "best" (confidence) sort, but specially designed for
+  Q&A-type threads to highlight good question/answer pairs. */
+ | 'QA' | 'RANDOM'
+/** Sort by top upvoted comments. */
+ | 'TOP';
+export type PostTextOptions = {
+    text: string;
+} | {
+    richtext: object | RichTextBuilder;
+};
+export type CustomPostRichTextFallback = RichTextBuilder | string;
+export type CustomPostTextFallbackOptions = {
+    /**
+     * May also include markdown. See https://www.reddit.com/r/reddit.com/wiki/markdown/
+     */
+    text: string;
+} | {
+    richtext: CustomPostRichTextFallback;
+};
+export type SubmitLinkOptions = CommonSubmitPostOptions & {
+    url: string;
+    /**
+     * @deprecated Unsupported. This property is for backwards compatibility and
+     * has no effect. It will removed in a future version. New code should not
+     * use it.
+     */
+    resubmit?: boolean;
+};
+export type SubmitMediaOptions = CommonSubmitPostOptions & {
+    kind: 'image' | 'video' | 'videogif';
+    videoPosterUrl?: string;
+    imageUrls?: [string];
+};
+export type SubmitSelfPostOptions = PostTextOptions & CommonSubmitPostOptions;
+export type SubmitCustomPostTextFallbackOptions = {
+    textFallback?: CustomPostTextFallbackOptions;
+};
+export type SubmitCustomPostOptions = CommonSubmitPostOptions & SubmitCustomPostTextFallbackOptions & {
+    preview: JSX.Element;
+    userGeneratedContent?: UserGeneratedContent;
+};
+export type CommonSubmitPostOptions = {
+    title: string;
+    sendreplies?: boolean;
+    nsfw?: boolean;
+    spoiler?: boolean;
+    flairId?: string;
+    flairText?: string;
+    runAs?: 'USER' | 'APP';
+};
+export type SubmitPostOptions = (SubmitLinkOptions | SubmitSelfPostOptions | SubmitCustomPostOptions | SubmitMediaOptions) & {
+    subredditName: string;
+};
+export type CrosspostOptions = CommonSubmitPostOptions & {
+    subredditName: string;
+    postId: string;
+};
+export type LinkFlair = {
+    /**
+     * One of: "text", "richtext"
+     */
+    type?: string | undefined;
+    /**
+     * Flair template ID to use when rendering this flair
+     */
+    templateId?: string | undefined;
+    /**
+     * Plain text representation of the flair
+     */
+    text?: string | undefined;
+    /**
+     * RichText object representation of the flair
+     */
+    richtext: {
+        /**
+         * Enum of element types.  e.g. emoji or text
+         */
+        elementType?: string | undefined;
+        /**
+         * Text to show up in the flair, e.g. "Need Advice"
+         */
+        text?: string | undefined;
+        /**
+         * Emoji references, e.g. ":rainbow:"
+         */
+        emojiRef?: string | undefined;
+        /**
+         * url string, e.g. "https://reddit.com/"
+         */
+        url?: string | undefined;
+    }[];
+    /**
+     * Custom CSS classes from the subreddit's stylesheet to apply to the flair if rendered as HTML
+     */
+    cssClass?: string | undefined;
+    /**
+     * One of: "light", "dark"
+     */
+    textColor?: string | undefined;
+    /**
+     * Flair background color as a hex color string (# prefixed)
+     * @example "#FF4500"
+     */
+    backgroundColor?: string | undefined;
+};
+/**
+ * oEmbed is a format for allowing an embedded representation of a URL on third party sites.
+ * The simple API allows a website to display embedded content (such as photos or videos)
+ * when a user posts a link to that resource, without having to parse the resource directly.
+ * See: https://oembed.com/
+ */
+export type OEmbed = {
+    /** The resource type. Valid values, along with value-specific parameters, are described below. E.g. "video" */
+    type: string;
+    /** A text title, describing the resource. */
+    title?: string | undefined;
+    /** A URL for the author/owner of the resource. E.g. "YouTube" */
+    providerName?: string | undefined;
+    /** The name of the resource provider. E.g "https://www.youtube.com/" */
+    providerUrl?: string | undefined;
+    /** The oEmbed version number. This must be 1.0. */
+    version: string;
+    /** The width of the optional thumbnail in pixels */
+    thumbnailWidth?: number | undefined;
+    /** The height of the optional thumbnail in pixels */
+    thumbnailHeight?: number | undefined;
+    /** A URL to a thumbnail image representing the resource. */
+    thumbnailUrl?: string | undefined;
+    /** The HTML required to embed a video player. The HTML should have no padding or margins. Consumers may wish to load the HTML in an off-domain iframe to avoid XSS vulnerabilities. */
+    html: string;
+    /** The width in pixels required to display the HTML. */
+    height?: number | undefined;
+    /** The height in pixels required to display the HTML. */
+    width?: number | undefined;
+    /** A URL for the author/owner of the resource. E.g. "https://www.youtube.com/@Reddit" */
+    authorUrl?: string | undefined;
+    /** The name of the author/owner of the resource. E.g. "Reddit" */
+    authorName?: string | undefined;
+};
+/**
+ * Contains the data for a video hosted on Reddit that is in a post
+ */
+export type RedditVideo = {
+    /** The bitrate of the video in kilobits per second. E.g. 450 */
+    bitrateKbps?: number | undefined;
+    /** The URL to the DASH playlist file. E.g. "https://v.redd.it/abc123/DASHPlaylist.mpd" */
+    dashUrl?: string | undefined;
+    /** The duration of the video in seconds. E.g. 30 */
+    duration?: number | undefined;
+    /** The direct URL to the video. E.g. "https://v.redd.it/abc123/DASH_1080.mp4?source=fallback" */
+    fallbackUrl?: string | undefined;
+    /** The height of the video in pixels. E.g. 1080 */
+    height?: number | undefined;
+    /** The URL to the HLS playlist file. E.g. "https://v.redd.it/abc123/HLSPlaylist.m3u8" */
+    hlsUrl?: string | undefined;
+    /** If `true`, the video is a GIF */
+    isGif?: boolean | undefined;
+    /** The URL to the scrubber media file. E.g. "https://v.redd.it/abc123/DASH_96.mp4" */
+    scrubberMediaUrl?: string | undefined;
+    /** The status of the transcoding process. E.g. "completed" */
+    transcodingStatus?: string | undefined;
+    /** The width of the video in pixels. E.g. 1920 */
+    width?: number | undefined;
+};
+export type SecureMedia = {
+    /** The type of the OEmbed media, if present (e.g. "youtube.com") */
+    type?: string | undefined;
+    oembed?: OEmbed | undefined;
+    redditVideo?: RedditVideo | undefined;
+};
+/**
+ * Contains data about a post's thumbnail. Also contains a blurred version if the thumbnail is NSFW.
+ */
+export type EnrichedThumbnail = {
+    /** Attribution text for the thumbnail */
+    attribution?: string;
+    /** The image used for the thumbnail. May have different resolution from Post.thumbnail */
+    image: {
+        url: string;
+        height: number;
+        width: number;
+    };
+    /** Whether this thumbnail appears blurred by default */
+    isObfuscatedDefault: boolean;
+    /** The blurred image for NSFW thumbnails */
+    obfuscatedImage?: {
+        url: string;
+        height: number;
+        width: number;
+    };
+};
+export declare const GalleryMediaStatus: {
+    readonly UNKNOWN: 0;
+    readonly VALID: 1;
+    readonly FAILED: 2;
+};
+export type GalleryMediaStatus = (typeof GalleryMediaStatusProto)[keyof typeof GalleryMediaStatusProto];
+/**
+ * Represents media that the post may contain.
+ */
+export type GalleryMedia = {
+    /** Status of the media. Media that were successfully uplaoded will have GalleryMediaStatus.VALID status */
+    status: GalleryMediaStatus;
+    url: string;
+    height: number;
+    width: number;
+};
+export declare class Post {
+    #private;
+    /**
+     * @internal
+     */
+    constructor(data: RedditObject);
+    get id(): T3ID;
+    get authorId(): T2ID | undefined;
+    get authorName(): string;
+    get subredditId(): T5ID;
+    get subredditName(): string;
+    get permalink(): string;
+    get title(): string;
+    get body(): string | undefined;
+    get bodyHtml(): string | undefined;
+    get url(): string;
+    get thumbnail(): {
+        url: string;
+        height: number;
+        width: number;
+    } | undefined;
+    get createdAt(): Date;
+    get score(): number;
+    get numberOfComments(): number;
+    get numberOfReports(): number;
+    get approved(): boolean;
+    get approvedAtUtc(): number;
+    get bannedAtUtc(): number;
+    get spam(): boolean;
+    get stickied(): boolean;
+    get removed(): boolean;
+    /**
+     * Who removed this object (username)
+     */
+    get removedBy(): string | undefined;
+    /**
+     * who/what removed this object. It will return one of the following:
+     * - "anti_evil_ops": object is removed by a aeops member
+     * - "author": object is removed by author of the post
+     * - "automod_filtered": object is filtered by automod
+     * - "community_ops": object is removed by a community team member
+     * - "content_takedown": object is removed due to content violation
+     * - "copyright_takedown": object is removed due to copyright violation
+     * - "deleted": object is deleted
+     * - "moderator": object is removed by a mod of the sub
+     * - "reddit": object is removed by anyone else
+     * - undefined: object is not removed
+     */
+    get removedByCategory(): string | undefined;
+    get archived(): boolean;
+    get edited(): boolean;
+    get locked(): boolean;
+    get nsfw(): boolean;
+    get quarantined(): boolean;
+    get spoiler(): boolean;
+    get hidden(): boolean;
+    get ignoringReports(): boolean;
+    get distinguishedBy(): string | undefined;
+    get comments(): Listing<Comment>;
+    get flair(): LinkFlair | undefined;
+    get secureMedia(): SecureMedia | undefined;
+    get userReportReasons(): string[];
+    get modReportReasons(): string[];
+    /**
+     * Get the media in the post. Empty if the post doesn't have any media.
+     */
+    get gallery(): GalleryMedia[];
+    toJSON(): Pick<Post, 'id' | 'authorId' | 'authorName' | 'subredditId' | 'subredditName' | 'permalink' | 'title' | 'body' | 'bodyHtml' | 'url' | 'thumbnail' | 'score' | 'numberOfComments' | 'numberOfReports' | 'createdAt' | 'approved' | 'spam' | 'stickied' | 'removed' | 'removedBy' | 'removedByCategory' | 'archived' | 'edited' | 'locked' | 'nsfw' | 'quarantined' | 'spoiler' | 'hidden' | 'ignoringReports' | 'distinguishedBy' | 'flair' | 'secureMedia' | 'userReportReasons' | 'modReportReasons'>;
+    isApproved(): boolean;
+    isSpam(): boolean;
+    isStickied(): boolean;
+    isRemoved(): boolean;
+    isArchived(): boolean;
+    isEdited(): boolean;
+    isLocked(): boolean;
+    isNsfw(): boolean;
+    isQuarantined(): boolean;
+    isSpoiler(): boolean;
+    isHidden(): boolean;
+    isIgnoringReports(): boolean;
+    isDistinguishedBy(): string | undefined;
+    edit(options: PostTextOptions): Promise<void>;
+    /**
+     * Set the suggested sort for comments on a Post.
+     *
+     * @throws {Error} Throws an error if the suggested sort could not be set.
+     * @example
+     * ```ts
+     * const post = await reddit.getPostById(context.postId);
+     * await post.setSuggestedCommentSort("NEW");
+     * ```
+     */
+    setSuggestedCommentSort(suggestedSort: PostSuggestedCommentSort): Promise<void>;
+    /**
+     * Set a lightweight UI that shows while the custom post renders
+     *
+     * @param {JSX.ComponentFunction} ui - A JSX component function that returns a simple ui to be rendered.
+     * @throws {Error} Throws an error if the preview could not be set.
+     * @example
+     * ```ts
+     * const preview = (
+     *   <vstack height="100%" width="100%" alignment="middle center">
+     *     <text size="large">An updated preview!</text>
+     *   </vstack>
+     * );
+     * const post = await reddit.getPostById(context.postId);
+     * await post.setCustomPostPreview(() => preview);
+     * ```
+     */
+    setCustomPostPreview(ui: JSX.ComponentFunction): Promise<void>;
+    /**
+     * Set a text fallback for the custom post
+     *
+     * @param {CustomPostTextFallbackOptions} options - A text or a richtext to render in a fallback
+     * @throws {Error} Throws an error if the fallback could not be set.
+     * @example
+     * ```ts
+     * // from a menu action, form, scheduler, trigger, custom post click event, etc
+     * const newTextFallback = { text: 'This is an updated text fallback' };
+     * const post = await context.reddit.getPostById(context.postId);
+     * await post.setTextFallback(newTextFallback);
+     * ```
+     */
+    setTextFallback(options: CustomPostTextFallbackOptions): Promise<void>;
+    addComment(options: CommentSubmissionOptions): Promise<Comment>;
+    delete(): Promise<void>;
+    approve(): Promise<void>;
+    remove(isSpam?: boolean): Promise<void>;
+    lock(): Promise<void>;
+    unlock(): Promise<void>;
+    hide(): Promise<void>;
+    unhide(): Promise<void>;
+    markAsNsfw(): Promise<void>;
+    unmarkAsNsfw(): Promise<void>;
+    markAsSpoiler(): Promise<void>;
+    unmarkAsSpoiler(): Promise<void>;
+    sticky(position?: 1 | 2 | 3 | 4): Promise<void>;
+    unsticky(): Promise<void>;
+    distinguish(): Promise<void>;
+    distinguishAsAdmin(): Promise<void>;
+    undistinguish(): Promise<void>;
+    ignoreReports(): Promise<void>;
+    unignoreReports(): Promise<void>;
+    getAuthor(): Promise<User | undefined>;
+    crosspost(options: Omit<CrosspostOptions, 'postId'>): Promise<Post>;
+    /**
+     * Add a mod note for why the post was removed
+     *
+     * @param options.reasonId id of a Removal Reason - you can leave this as an empty string if you don't have one
+     * @param options.modNote the reason for removal (maximum 100 characters) (optional)
+     * @returns
+     */
+    addRemovalNote(options: {
+        reasonId: string;
+        modNote?: string;
+    }): Promise<void>;
+    /**
+     * Get a thumbnail that contains a preview image and also contains a blurred preview for
+     * NSFW images. The thumbnail returned has higher resolution than Post.thumbnail.
+     * Returns undefined if the post doesn't have a thumbnail
+     *
+     * @returns {EnrichedThumbnail | undefined}
+     * @throws {Error} Throws an error if the thumbnail could not be fetched
+     * @example
+     * ```ts
+     * // from a menu action, form, scheduler, trigger, custom post click event, etc
+     * const post = await context.reddit.getPostById(context.postId);
+     * const enrichedThumbnail = await post.getEnrichedThumbnail();
+     * ```
+     */
+    getEnrichedThumbnail(): Promise<EnrichedThumbnail | undefined>;
+    /** @internal */
+    static getById(id: T3ID): Promise<Post>;
+    /** @internal */
+    static submit(options: SubmitPostOptions): Promise<Post>;
+    /** @internal */
+    static crosspost(options: CrosspostOptions): Promise<Post>;
+    /** @internal */
+    static edit(options: PostTextOptions & {
+        id: T3ID;
+    }): Promise<Post>;
+    /** @internal */
+    static setSuggestedCommentSort(options: {
+        suggestedSort: PostSuggestedCommentSort;
+        id: T3ID;
+        subredditId: T5ID;
+    }): Promise<void>;
+    /** @internal */
+    static setCustomPostPreview(options: {
+        id: T3ID;
+        ui: JSX.ComponentFunction;
+    }): Promise<void>;
+    /** @internal */
+    static setTextFallback(options: CustomPostTextFallbackOptions, postId: T3ID): Promise<Post>;
+    /** @internal */
+    static delete(id: T3ID): Promise<void>;
+    /** @internal */
+    static approve(id: T3ID): Promise<void>;
+    /** @internal */
+    static remove(id: T3ID, isSpam?: boolean): Promise<void>;
+    /** @internal */
+    static hide(id: T3ID): Promise<void>;
+    /** @internal */
+    static unhide(id: T3ID): Promise<void>;
+    /** @internal */
+    static markAsNsfw(id: T3ID): Promise<void>;
+    /** @internal */
+    static unmarkAsNsfw(id: T3ID): Promise<void>;
+    /** @internal */
+    static markAsSpoiler(id: T3ID): Promise<void>;
+    /** @internal */
+    static unmarkAsSpoiler(id: T3ID): Promise<void>;
+    /** @internal */
+    static sticky(id: T3ID, position: 1 | 2 | 3 | 4 | undefined): Promise<void>;
+    /** @internal */
+    static unsticky(id: T3ID): Promise<void>;
+    /** @internal */
+    static lock(id: T3ID): Promise<void>;
+    /** @internal */
+    static unlock(id: T3ID): Promise<void>;
+    /** @internal */
+    static distinguish(id: T3ID, asAdmin: boolean): Promise<{
+        distinguishedBy: string | undefined;
+    }>;
+    /** @internal */
+    static undistinguish(id: T3ID): Promise<{
+        distinguishedBy: string | undefined;
+    }>;
+    /** @internal */
+    static ignoreReports(id: T3ID): Promise<void>;
+    /** @internal */
+    static unignoreReports(id: T3ID): Promise<void>;
+    /** @internal */
+    static getControversialPosts(options?: GetPostsOptionsWithTimeframe): Listing<Post>;
+    /** @internal */
+    static getTopPosts(options?: GetPostsOptionsWithTimeframe): Listing<Post>;
+    /** @internal */
+    static getSortedPosts(options: GetSortedPostsOptions): Listing<Post>;
+    /** @internal */
+    static getHotPosts(options?: GetHotPostsOptions): Listing<Post>;
+    /** @internal */
+    static getNewPosts(options: GetPostsOptions): Listing<Post>;
+    /** @internal */
+    static getRisingPosts(options: GetPostsOptions): Listing<Post>;
+    /** @internal */
+    static getPostsByUser(options: GetPostsByUserOptions): Listing<Post>;
+}
+//# sourceMappingURL=Post.d.ts.map