From ad1c1af61a080e1d42383a9da6c1a1be9eb834a4 Mon Sep 17 00:00:00 2001 From: Ved <163000251+cedaraspen@users.noreply.github.com> Date: Tue, 21 Apr 2026 16:20:38 -0400 Subject: [PATCH 1/3] docs: align Devvit Web and mod tool documentation --- .../type-aliases/MenuItemUserType.md | 2 +- docs/api/redditapi/README.md | 4 +- docs/api/redditapi/RedditAPIClient/README.md | 2 +- .../classes/RedditAPIClient.md | 94 +++++++++++-------- .../type-aliases/InviteModeratorOptions.md | 2 +- .../type-aliases/MuteUserOptions.md | 2 +- docs/api/redditapi/models/README.md | 2 +- .../models/classes/AuthorFlairSettings.md | 2 +- .../redditapi/models/classes/ButtonWidget.md | 2 +- .../models/classes/CalendarWidget.md | 2 +- docs/api/redditapi/models/classes/Comment.md | 2 +- .../models/classes/CommunityListWidget.md | 2 +- .../redditapi/models/classes/CustomWidget.md | 2 +- docs/api/redditapi/models/classes/Flair.md | 2 +- .../redditapi/models/classes/FlairTemplate.md | 2 +- .../redditapi/models/classes/ImageWidget.md | 2 +- docs/api/redditapi/models/classes/Listing.md | 2 +- .../models/classes/ModMailService.md | 2 +- docs/api/redditapi/models/classes/ModNote.md | 2 +- docs/api/redditapi/models/classes/Post.md | 2 +- .../models/classes/PostFlairSettings.md | 2 +- .../models/classes/PostFlairWidget.md | 2 +- .../models/classes/PrivateMessage.md | 2 +- docs/api/redditapi/models/classes/Rule.md | 2 +- .../api/redditapi/models/classes/Subreddit.md | 2 +- .../models/classes/SubredditDescription.md | 2 +- .../models/classes/SubredditRulesWidget.md | 2 +- .../models/classes/SubredditWikiSettings.md | 2 +- .../models/classes/TextAreaWidget.md | 2 +- docs/api/redditapi/models/classes/User.md | 2 +- docs/api/redditapi/models/classes/Widget.md | 2 +- docs/api/redditapi/models/classes/WikiPage.md | 2 +- .../models/classes/WikiPageRevision.md | 2 +- .../models/classes/WikiPageSettings.md | 2 +- .../models/enumerations/AboutLocations.md | 2 +- .../models/enumerations/FlairType.md | 2 +- .../models/enumerations/ModMailActionType.md | 2 +- .../enumerations/ModMailConversationState.md | 2 +- .../models/enumerations/SocialLinkType.md | 2 +- .../enumerations/WikiPagePermissionLevel.md | 2 +- .../models/functions/getModerationLog.md | 2 +- .../models/functions/getSubredditInfoById.md | 2 +- .../functions/getSubredditInfoByName.md | 2 +- .../functions/getSubredditLeaderboard.md | 2 +- .../models/functions/getSubredditStyles.md | 2 +- .../models/functions/getVaultByAddress.md | 2 +- .../models/functions/getVaultByUserId.md | 2 +- .../redditapi/models/interfaces/ModAction.md | 2 +- .../type-aliases/AboutSubredditTypes.md | 2 +- .../type-aliases/AddRemovalNoteOptions.md | 2 +- .../models/type-aliases/AddWidgetData.md | 2 +- .../type-aliases/AllowableFlairContent.md | 2 +- .../type-aliases/BackgroundImagePosition.md | 2 +- .../models/type-aliases/BanUserOptions.md | 2 +- .../type-aliases/BanWikiContributorOptions.md | 2 +- .../models/type-aliases/BannerHeight.md | 2 +- .../models/type-aliases/CommentMediaTypes.md | 2 +- .../models/type-aliases/CommentSort.md | 2 +- .../type-aliases/CommentSubmissionOptions.md | 4 +- .../models/type-aliases/CommonFlair.md | 2 +- .../type-aliases/CommonSubmitPostOptions.md | 2 +- .../type-aliases/CommunityNameFormat.md | 2 +- .../models/type-aliases/ConversationData.md | 2 +- .../type-aliases/ConversationResponse.md | 2 +- .../type-aliases/ConversationStateFilter.md | 2 +- .../type-aliases/ConversationUserData.md | 2 +- .../CreateFlairTemplateOptions.md | 2 +- .../type-aliases/CreateModNoteOptions.md | 2 +- .../type-aliases/CreateRelationshipOptions.md | 2 +- .../models/type-aliases/CreateRuleOptions.md | 2 +- .../type-aliases/CreateWikiPageOptions.md | 2 +- .../models/type-aliases/CrosspostOptions.md | 2 +- .../models/type-aliases/CrowdControlLevel.md | 2 +- .../CustomPostRichTextFallback.md | 2 +- .../CustomPostTextFallbackOptions.md | 2 +- .../models/type-aliases/CustomizationFlag.md | 2 +- .../models/type-aliases/DeleteNotesOptions.md | 2 +- .../models/type-aliases/EditCommentOptions.md | 2 +- .../type-aliases/EditFlairTemplateOptions.md | 2 +- .../models/type-aliases/EnrichedThumbnail.md | 2 +- .../type-aliases/FlairBackgroundColor.md | 2 +- .../models/type-aliases/FlairSettings.md | 2 +- .../models/type-aliases/FlairTextColor.md | 2 +- .../models/type-aliases/GalleryMedia.md | 2 +- .../models/type-aliases/GalleryMediaStatus.md | 2 +- .../type-aliases/GetBestPostsOptions.md | 2 +- .../type-aliases/GetCommentsByUserOptions.md | 2 +- .../models/type-aliases/GetCommentsOptions.md | 2 +- .../type-aliases/GetConversationResponse.md | 2 +- .../type-aliases/GetConversationsRequest.md | 2 +- .../type-aliases/GetConversationsResponse.md | 2 +- .../type-aliases/GetDuplicatesOptions.md | 2 +- .../models/type-aliases/GetHotPostsOptions.md | 2 +- .../models/type-aliases/GetModNotesOptions.md | 2 +- .../type-aliases/GetModerationLogOptions.md | 2 +- .../type-aliases/GetPageRevisionsOptions.md | 2 +- .../type-aliases/GetPostsByUserOptions.md | 2 +- .../models/type-aliases/GetPostsOptions.md | 2 +- .../GetPostsOptionsWithTimeframe.md | 2 +- .../type-aliases/GetPrivateMessagesOptions.md | 2 +- .../type-aliases/GetSortedPostsOptions.md | 2 +- .../GetSubredditUsersByTypeOptions.md | 2 +- .../GetUserFlairBySubredditOptions.md | 2 +- .../GetUserFlairBySubredditResponse.md | 2 +- .../type-aliases/GetUserFlairOptions.md | 2 +- .../type-aliases/GetUserOverviewOptions.md | 2 +- .../models/type-aliases/ImagePosition.md | 2 +- .../InternalSetPostFlairOptions.md | 2 +- .../models/type-aliases/LinkFlair.md | 2 +- .../type-aliases/ListingFetchOptions.md | 2 +- .../type-aliases/ListingFetchResponse.md | 2 +- .../models/type-aliases/MenuPosition.md | 2 +- .../models/type-aliases/MessageData.md | 2 +- .../models/type-aliases/ModActionData.md | 2 +- .../models/type-aliases/ModActionTarget.md | 2 +- .../models/type-aliases/ModActionType.md | 2 +- .../models/type-aliases/ModLogOptions.md | 2 +- .../models/type-aliases/ModNoteType.md | 2 +- .../type-aliases/ModeratorPermission.md | 2 +- .../models/type-aliases/MoreObject.md | 2 +- .../redditapi/models/type-aliases/OEmbed.md | 2 +- .../models/type-aliases/Participant.md | 2 +- .../redditapi/models/type-aliases/PollData.md | 2 +- .../models/type-aliases/PollOption.md | 2 +- .../type-aliases/PositionedImagePosition.md | 2 +- .../models/type-aliases/PostCapabilities.md | 2 +- .../type-aliases/PostSuggestedCommentSort.md | 2 +- .../models/type-aliases/PostTextOptions.md | 2 +- .../redditapi/models/type-aliases/PostType.md | 2 +- .../models/type-aliases/RedditVideo.md | 2 +- .../models/type-aliases/RelationshipType.md | 2 +- .../models/type-aliases/RemovalReason.md | 2 +- .../type-aliases/RemoveRelationshipOptions.md | 2 +- .../type-aliases/ReplyToCommentOptions.md | 2 +- .../models/type-aliases/SecureMedia.md | 2 +- .../SendPrivateMessageAsSubredditOptions.md | 2 +- .../type-aliases/SendPrivateMessageOptions.md | 2 +- .../models/type-aliases/SetFlairOptions.md | 2 +- .../type-aliases/SetPostFlairOptions.md | 2 +- .../type-aliases/SetUserFlairBatchConfig.md | 2 +- .../type-aliases/SetUserFlairOptions.md | 2 +- .../type-aliases/SubmitCustomPostOptions.md | 6 +- .../SubmitCustomPostTextFallbackOptions.md | 2 +- .../models/type-aliases/SubmitLinkOptions.md | 2 +- .../models/type-aliases/SubmitMediaOptions.md | 2 +- .../models/type-aliases/SubmitPostOptions.md | 2 +- .../type-aliases/SubmitSelfPostOptions.md | 2 +- .../models/type-aliases/SubredditData.md | 2 +- .../models/type-aliases/SubredditInfo.md | 2 +- .../type-aliases/SubredditLeaderboard.md | 2 +- .../SubredditLeaderboardSummary.md | 2 +- .../SubredditLeaderboardSummaryRow.md | 2 +- .../models/type-aliases/SubredditSettings.md | 2 +- .../type-aliases/SubredditSettingsOptions.md | 2 +- .../models/type-aliases/SubredditStyles.md | 2 +- .../models/type-aliases/SubredditType.md | 2 +- .../redditapi/models/type-aliases/Trophy.md | 2 +- .../type-aliases/UnreadCountResponse.md | 2 +- .../type-aliases/UpdatePageSettingsOptions.md | 2 +- .../models/type-aliases/UpdateRuleOptions.md | 2 +- .../models/type-aliases/UpdateWidgetData.md | 2 +- .../type-aliases/UpdateWikiPageOptions.md | 2 +- .../models/type-aliases/UserFlair.md | 2 +- .../type-aliases/UserFlairPageOptions.md | 2 +- .../redditapi/models/type-aliases/UserNote.md | 2 +- .../models/type-aliases/UserNoteLabel.md | 2 +- .../models/type-aliases/UserSocialLink.md | 2 +- .../redditapi/models/type-aliases/Vault.md | 2 +- .../models/type-aliases/Visibility.md | 2 +- .../models/type-aliases/WikiEditMode.md | 2 +- .../models/type-aliases/WikiPageRevisionId.md | 2 +- .../models/type-aliases/WithUserData.md | 2 +- .../models/variables/GalleryMediaStatus.md | 2 +- docs/capabilities/client/menu-actions.mdx | 2 +- docs/capabilities/creating_custom_post.md | 4 +- .../devvit-web/devvit_web_configuration.md | 41 +++++++- .../devvit-web/devvit_web_overview.mdx | 8 +- .../interactive_posts_overview.mdx | 9 +- docs/capabilities/server/http-fetch-policy.md | 2 +- docs/capabilities/server/http-fetch.mdx | 4 +- docs/capabilities/server/overview.md | 2 +- docs/capabilities/server/reddit-api.mdx | 7 +- docs/capabilities/server/triggers.mdx | 4 +- docs/capabilities/server/userActions.mdx | 14 +-- docs/earn-money/payments/payments_test.md | 4 +- docs/examples/tutorials/mod-tool.md | 12 ++- docs/guides/faq.mdx | 4 + docs/guides/tools/devvit_cli.mdx | 40 +++++++- docs/guides/tools/devvit_test.mdx | 6 +- docs/guides/tools/playtest.md | 18 +++- docs/introduction/intro-mod-tools.mdx | 5 +- docs/quickstart/quickstart.md | 2 +- scripts/build-reddit-api-docs.sh | 1 + 193 files changed, 378 insertions(+), 257 deletions(-) diff --git a/docs/api/public-api/type-aliases/MenuItemUserType.md b/docs/api/public-api/type-aliases/MenuItemUserType.md index 57b7789a..f93fe772 100644 --- a/docs/api/public-api/type-aliases/MenuItemUserType.md +++ b/docs/api/public-api/type-aliases/MenuItemUserType.md @@ -4,4 +4,4 @@ # Type Alias: MenuItemUserType -> **MenuItemUserType** = `"loggedOut"` \| `"moderator"` +> **MenuItemUserType** = `"user"` \| `"moderator"` diff --git a/docs/api/redditapi/README.md b/docs/api/redditapi/README.md index cfe2d0c1..360de423 100644 --- a/docs/api/redditapi/README.md +++ b/docs/api/redditapi/README.md @@ -1,8 +1,8 @@ -**@devvit/public-api v0.12.21-dev** +**Reddit API Reference v0.12.21-dev** *** -# @devvit/public-api v0.12.21-dev +# Reddit API Reference v0.12.21-dev ## Modules diff --git a/docs/api/redditapi/RedditAPIClient/README.md b/docs/api/redditapi/RedditAPIClient/README.md index dbf12675..ccdbaaa4 100644 --- a/docs/api/redditapi/RedditAPIClient/README.md +++ b/docs/api/redditapi/RedditAPIClient/README.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../README.md) +[**Reddit API Reference v0.12.21-dev**](../README.md) *** diff --git a/docs/api/redditapi/RedditAPIClient/classes/RedditAPIClient.md b/docs/api/redditapi/RedditAPIClient/classes/RedditAPIClient.md index 39d31248..b74a5d7e 100644 --- a/docs/api/redditapi/RedditAPIClient/classes/RedditAPIClient.md +++ b/docs/api/redditapi/RedditAPIClient/classes/RedditAPIClient.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** @@ -6,27 +6,20 @@ The Reddit API Client -To use the Reddit API Client, add it to the plugin configuration at the top of the file. +To use the Reddit API Client, enable the Reddit capability in `devvit.json` and import the client from `@devvit/web/server`. ## Example ```ts +import { context, reddit } from '@devvit/web/server'; -Devvit.configure({ - redditAPI: true, - // other plugins -}) +const subreddit = await reddit.getSubredditById(context.subredditId); -// use within one of our capability handlers e.g. Menu Actions, Triggers, Scheduled Job Type, etc -async (event, context) => { - const subreddit = await context.reddit.getSubredditById(context.subredditId); - context.reddit.submitPost({ - subredditName: subreddit.name, - title: 'test post', - text: 'test body', - }) - // additional code -} +await reddit.submitPost({ + subredditName: subreddit.name, + title: 'test post', + text: 'test body', +}); ``` ## Constructors @@ -2978,17 +2971,54 @@ A Promise that resolves to a Comment object. #### Example ```ts -import { RunAs } from '@devvit/public-api'; - const comment = await reddit.submitComment({ - id: 't1_1qgif', + id: 't3_123456', text: 'Hello world!', - runAs: RunAs.APP, + runAs: 'APP', }) ``` *** + + +### submitCustomPost() + +> **submitCustomPost**(`options`): `Promise`\<[`Post`](../../models/classes/Post.md)\> + +Submits a custom post that renders one of your configured Devvit Web entrypoints. + +#### Parameters + +##### options + +[`SubmitCustomPostOptions`](../../models/type-aliases/SubmitCustomPostOptions.md) + +#### Returns + +`Promise`\<[`Post`](../../models/classes/Post.md)\> + +A Promise that resolves to a Post object. + +#### Example + +```ts +import { context, reddit } from '@devvit/web/server'; + +const post = await reddit.submitCustomPost({ + subredditName: context.subredditName!, + title: 'Hello World', + entry: 'default', + postData: { + count: 0, + }, +}); +``` + +Unlike older Blocks-based examples, you do not need to provide a separate `preview` element when creating a custom post with Devvit Web. + +*** + ### submitPost() @@ -3027,27 +3057,17 @@ const post = await reddit.submitPost({ ``` By default, `submitPost()` creates a Post on behalf of the App account, but it may be called on behalf of the User making the request by setting the option `runAs: RunAs.USER`. -When using `runAs: RunAs.USER` to create an experience Post, you must specify the `userGeneratedContent` option. For example: +When using `runAs: RunAs.USER`, you must specify the `userGeneratedContent` option. For example: ```ts -import { RunAs } from '@devvit/public-api'; - const post = await reddit.submitPost({ title: 'My Devvit Post', - runAs: RunAs.USER, + runAs: 'USER', userGeneratedContent: { - text: "hello there", - imageUrls: ["https://styles.redditmedia.com/t5_5wa5ww/styles/communityIcon_wyopomb2xb0a1.png", "https://styles.redditmedia.com/t5_49fkib/styles/bannerBackgroundImage_5a4axis7cku61.png"] - }, - subredditName: await reddit.getCurrentSubredditName(), - textFallback: { - text: 'This is a Devvit post!', + text: "hello there", }, - preview: ( - - Loading... - - ), + subredditName: await reddit.getCurrentSubredditName(), + text: 'This is a Devvit post!', }); ``` @@ -3060,8 +3080,8 @@ const post = await reddit.submitPost({ > **subscribeToCurrentSubreddit**(): `Promise`\<`void`\> Subscribes to the subreddit in which the app is installed. No-op if the user is already subscribed. -This method will execute as the app account by default. -To subscribe on behalf of a user, please contact Reddit. +This method does not take a `runAs` parameter. +Manual approval from Reddit is still required before this API can subscribe on behalf of the user. #### Returns diff --git a/docs/api/redditapi/RedditAPIClient/type-aliases/InviteModeratorOptions.md b/docs/api/redditapi/RedditAPIClient/type-aliases/InviteModeratorOptions.md index ea790753..2759d0dd 100644 --- a/docs/api/redditapi/RedditAPIClient/type-aliases/InviteModeratorOptions.md +++ b/docs/api/redditapi/RedditAPIClient/type-aliases/InviteModeratorOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/RedditAPIClient/type-aliases/MuteUserOptions.md b/docs/api/redditapi/RedditAPIClient/type-aliases/MuteUserOptions.md index 965cf099..d0ce9c48 100644 --- a/docs/api/redditapi/RedditAPIClient/type-aliases/MuteUserOptions.md +++ b/docs/api/redditapi/RedditAPIClient/type-aliases/MuteUserOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/README.md b/docs/api/redditapi/models/README.md index 47da76ba..edd30c0d 100644 --- a/docs/api/redditapi/models/README.md +++ b/docs/api/redditapi/models/README.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../README.md) +[**Reddit API Reference v0.12.21-dev**](../README.md) *** diff --git a/docs/api/redditapi/models/classes/AuthorFlairSettings.md b/docs/api/redditapi/models/classes/AuthorFlairSettings.md index 462f24bb..aad4c2bd 100644 --- a/docs/api/redditapi/models/classes/AuthorFlairSettings.md +++ b/docs/api/redditapi/models/classes/AuthorFlairSettings.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/ButtonWidget.md b/docs/api/redditapi/models/classes/ButtonWidget.md index 2f409ee7..fcee1163 100644 --- a/docs/api/redditapi/models/classes/ButtonWidget.md +++ b/docs/api/redditapi/models/classes/ButtonWidget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/CalendarWidget.md b/docs/api/redditapi/models/classes/CalendarWidget.md index 821cc091..c6ff53d7 100644 --- a/docs/api/redditapi/models/classes/CalendarWidget.md +++ b/docs/api/redditapi/models/classes/CalendarWidget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/Comment.md b/docs/api/redditapi/models/classes/Comment.md index 45ddfba6..1e221d07 100644 --- a/docs/api/redditapi/models/classes/Comment.md +++ b/docs/api/redditapi/models/classes/Comment.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/CommunityListWidget.md b/docs/api/redditapi/models/classes/CommunityListWidget.md index 0420c0c8..b7d1344f 100644 --- a/docs/api/redditapi/models/classes/CommunityListWidget.md +++ b/docs/api/redditapi/models/classes/CommunityListWidget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/CustomWidget.md b/docs/api/redditapi/models/classes/CustomWidget.md index 2c15e7d1..bcc3383b 100644 --- a/docs/api/redditapi/models/classes/CustomWidget.md +++ b/docs/api/redditapi/models/classes/CustomWidget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/Flair.md b/docs/api/redditapi/models/classes/Flair.md index 1fe9784e..98b58778 100644 --- a/docs/api/redditapi/models/classes/Flair.md +++ b/docs/api/redditapi/models/classes/Flair.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/FlairTemplate.md b/docs/api/redditapi/models/classes/FlairTemplate.md index 8e3876a7..43ac1096 100644 --- a/docs/api/redditapi/models/classes/FlairTemplate.md +++ b/docs/api/redditapi/models/classes/FlairTemplate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/ImageWidget.md b/docs/api/redditapi/models/classes/ImageWidget.md index 90b5db1c..5b02ab57 100644 --- a/docs/api/redditapi/models/classes/ImageWidget.md +++ b/docs/api/redditapi/models/classes/ImageWidget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/Listing.md b/docs/api/redditapi/models/classes/Listing.md index dc2c7375..4d246cfd 100644 --- a/docs/api/redditapi/models/classes/Listing.md +++ b/docs/api/redditapi/models/classes/Listing.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/ModMailService.md b/docs/api/redditapi/models/classes/ModMailService.md index 6d855c6a..2aaf8356 100644 --- a/docs/api/redditapi/models/classes/ModMailService.md +++ b/docs/api/redditapi/models/classes/ModMailService.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/ModNote.md b/docs/api/redditapi/models/classes/ModNote.md index 0f0b7d49..c692f8e0 100644 --- a/docs/api/redditapi/models/classes/ModNote.md +++ b/docs/api/redditapi/models/classes/ModNote.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/Post.md b/docs/api/redditapi/models/classes/Post.md index 2279ffc8..d819ee0a 100644 --- a/docs/api/redditapi/models/classes/Post.md +++ b/docs/api/redditapi/models/classes/Post.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/PostFlairSettings.md b/docs/api/redditapi/models/classes/PostFlairSettings.md index 456284a8..5c2ba38a 100644 --- a/docs/api/redditapi/models/classes/PostFlairSettings.md +++ b/docs/api/redditapi/models/classes/PostFlairSettings.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/PostFlairWidget.md b/docs/api/redditapi/models/classes/PostFlairWidget.md index c49bfa81..6e51ecd8 100644 --- a/docs/api/redditapi/models/classes/PostFlairWidget.md +++ b/docs/api/redditapi/models/classes/PostFlairWidget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/PrivateMessage.md b/docs/api/redditapi/models/classes/PrivateMessage.md index 86008988..d26e587d 100644 --- a/docs/api/redditapi/models/classes/PrivateMessage.md +++ b/docs/api/redditapi/models/classes/PrivateMessage.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/Rule.md b/docs/api/redditapi/models/classes/Rule.md index ecd4fca8..f3c2976b 100644 --- a/docs/api/redditapi/models/classes/Rule.md +++ b/docs/api/redditapi/models/classes/Rule.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/Subreddit.md b/docs/api/redditapi/models/classes/Subreddit.md index 904c7b83..1d033bb0 100644 --- a/docs/api/redditapi/models/classes/Subreddit.md +++ b/docs/api/redditapi/models/classes/Subreddit.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/SubredditDescription.md b/docs/api/redditapi/models/classes/SubredditDescription.md index 73f369ac..00a302e2 100644 --- a/docs/api/redditapi/models/classes/SubredditDescription.md +++ b/docs/api/redditapi/models/classes/SubredditDescription.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/SubredditRulesWidget.md b/docs/api/redditapi/models/classes/SubredditRulesWidget.md index 14a2f1a3..08d4175b 100644 --- a/docs/api/redditapi/models/classes/SubredditRulesWidget.md +++ b/docs/api/redditapi/models/classes/SubredditRulesWidget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/SubredditWikiSettings.md b/docs/api/redditapi/models/classes/SubredditWikiSettings.md index 9fa86022..caebc51b 100644 --- a/docs/api/redditapi/models/classes/SubredditWikiSettings.md +++ b/docs/api/redditapi/models/classes/SubredditWikiSettings.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/TextAreaWidget.md b/docs/api/redditapi/models/classes/TextAreaWidget.md index 1d4c2cb5..fd94f271 100644 --- a/docs/api/redditapi/models/classes/TextAreaWidget.md +++ b/docs/api/redditapi/models/classes/TextAreaWidget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/User.md b/docs/api/redditapi/models/classes/User.md index 54d4d3ed..acbbc893 100644 --- a/docs/api/redditapi/models/classes/User.md +++ b/docs/api/redditapi/models/classes/User.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/Widget.md b/docs/api/redditapi/models/classes/Widget.md index 0689ca63..dac3c2fc 100644 --- a/docs/api/redditapi/models/classes/Widget.md +++ b/docs/api/redditapi/models/classes/Widget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/WikiPage.md b/docs/api/redditapi/models/classes/WikiPage.md index 99a1cf55..d758be98 100644 --- a/docs/api/redditapi/models/classes/WikiPage.md +++ b/docs/api/redditapi/models/classes/WikiPage.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/WikiPageRevision.md b/docs/api/redditapi/models/classes/WikiPageRevision.md index b486c54f..805da2cd 100644 --- a/docs/api/redditapi/models/classes/WikiPageRevision.md +++ b/docs/api/redditapi/models/classes/WikiPageRevision.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/WikiPageSettings.md b/docs/api/redditapi/models/classes/WikiPageSettings.md index a261d87f..cb40e02a 100644 --- a/docs/api/redditapi/models/classes/WikiPageSettings.md +++ b/docs/api/redditapi/models/classes/WikiPageSettings.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/enumerations/AboutLocations.md b/docs/api/redditapi/models/enumerations/AboutLocations.md index d9a0edff..7d58e3a6 100644 --- a/docs/api/redditapi/models/enumerations/AboutLocations.md +++ b/docs/api/redditapi/models/enumerations/AboutLocations.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/enumerations/FlairType.md b/docs/api/redditapi/models/enumerations/FlairType.md index 3a84f06c..1b51b5f9 100644 --- a/docs/api/redditapi/models/enumerations/FlairType.md +++ b/docs/api/redditapi/models/enumerations/FlairType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/enumerations/ModMailActionType.md b/docs/api/redditapi/models/enumerations/ModMailActionType.md index a0fcb26e..6dfe4685 100644 --- a/docs/api/redditapi/models/enumerations/ModMailActionType.md +++ b/docs/api/redditapi/models/enumerations/ModMailActionType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/enumerations/ModMailConversationState.md b/docs/api/redditapi/models/enumerations/ModMailConversationState.md index 97320590..bfc2ed32 100644 --- a/docs/api/redditapi/models/enumerations/ModMailConversationState.md +++ b/docs/api/redditapi/models/enumerations/ModMailConversationState.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/enumerations/SocialLinkType.md b/docs/api/redditapi/models/enumerations/SocialLinkType.md index c1bb94b6..4e707d73 100644 --- a/docs/api/redditapi/models/enumerations/SocialLinkType.md +++ b/docs/api/redditapi/models/enumerations/SocialLinkType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/enumerations/WikiPagePermissionLevel.md b/docs/api/redditapi/models/enumerations/WikiPagePermissionLevel.md index 476d9280..a9864715 100644 --- a/docs/api/redditapi/models/enumerations/WikiPagePermissionLevel.md +++ b/docs/api/redditapi/models/enumerations/WikiPagePermissionLevel.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/functions/getModerationLog.md b/docs/api/redditapi/models/functions/getModerationLog.md index ac7b7cfb..be2fc41e 100644 --- a/docs/api/redditapi/models/functions/getModerationLog.md +++ b/docs/api/redditapi/models/functions/getModerationLog.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/functions/getSubredditInfoById.md b/docs/api/redditapi/models/functions/getSubredditInfoById.md index 82f07fa6..c4523d05 100644 --- a/docs/api/redditapi/models/functions/getSubredditInfoById.md +++ b/docs/api/redditapi/models/functions/getSubredditInfoById.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/functions/getSubredditInfoByName.md b/docs/api/redditapi/models/functions/getSubredditInfoByName.md index d5d4dbc1..c7f6c5ec 100644 --- a/docs/api/redditapi/models/functions/getSubredditInfoByName.md +++ b/docs/api/redditapi/models/functions/getSubredditInfoByName.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/functions/getSubredditLeaderboard.md b/docs/api/redditapi/models/functions/getSubredditLeaderboard.md index 1f46cf90..741474a0 100644 --- a/docs/api/redditapi/models/functions/getSubredditLeaderboard.md +++ b/docs/api/redditapi/models/functions/getSubredditLeaderboard.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/functions/getSubredditStyles.md b/docs/api/redditapi/models/functions/getSubredditStyles.md index 6433e75b..0303c63f 100644 --- a/docs/api/redditapi/models/functions/getSubredditStyles.md +++ b/docs/api/redditapi/models/functions/getSubredditStyles.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/functions/getVaultByAddress.md b/docs/api/redditapi/models/functions/getVaultByAddress.md index 765d79cc..93d13cdc 100644 --- a/docs/api/redditapi/models/functions/getVaultByAddress.md +++ b/docs/api/redditapi/models/functions/getVaultByAddress.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/functions/getVaultByUserId.md b/docs/api/redditapi/models/functions/getVaultByUserId.md index bf8e8792..fa581753 100644 --- a/docs/api/redditapi/models/functions/getVaultByUserId.md +++ b/docs/api/redditapi/models/functions/getVaultByUserId.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/interfaces/ModAction.md b/docs/api/redditapi/models/interfaces/ModAction.md index e4e56ca7..b82b4147 100644 --- a/docs/api/redditapi/models/interfaces/ModAction.md +++ b/docs/api/redditapi/models/interfaces/ModAction.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/AboutSubredditTypes.md b/docs/api/redditapi/models/type-aliases/AboutSubredditTypes.md index 228ce5c0..2a8bd069 100644 --- a/docs/api/redditapi/models/type-aliases/AboutSubredditTypes.md +++ b/docs/api/redditapi/models/type-aliases/AboutSubredditTypes.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/AddRemovalNoteOptions.md b/docs/api/redditapi/models/type-aliases/AddRemovalNoteOptions.md index 484f84bc..eaccc224 100644 --- a/docs/api/redditapi/models/type-aliases/AddRemovalNoteOptions.md +++ b/docs/api/redditapi/models/type-aliases/AddRemovalNoteOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/AddWidgetData.md b/docs/api/redditapi/models/type-aliases/AddWidgetData.md index 06ddd78e..a3ff1f93 100644 --- a/docs/api/redditapi/models/type-aliases/AddWidgetData.md +++ b/docs/api/redditapi/models/type-aliases/AddWidgetData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/AllowableFlairContent.md b/docs/api/redditapi/models/type-aliases/AllowableFlairContent.md index 14ac105f..60b65b8a 100644 --- a/docs/api/redditapi/models/type-aliases/AllowableFlairContent.md +++ b/docs/api/redditapi/models/type-aliases/AllowableFlairContent.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/BackgroundImagePosition.md b/docs/api/redditapi/models/type-aliases/BackgroundImagePosition.md index 83216573..4a927bc0 100644 --- a/docs/api/redditapi/models/type-aliases/BackgroundImagePosition.md +++ b/docs/api/redditapi/models/type-aliases/BackgroundImagePosition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/BanUserOptions.md b/docs/api/redditapi/models/type-aliases/BanUserOptions.md index 006dd81d..d48995dd 100644 --- a/docs/api/redditapi/models/type-aliases/BanUserOptions.md +++ b/docs/api/redditapi/models/type-aliases/BanUserOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/BanWikiContributorOptions.md b/docs/api/redditapi/models/type-aliases/BanWikiContributorOptions.md index b44f7f90..93531bbd 100644 --- a/docs/api/redditapi/models/type-aliases/BanWikiContributorOptions.md +++ b/docs/api/redditapi/models/type-aliases/BanWikiContributorOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/BannerHeight.md b/docs/api/redditapi/models/type-aliases/BannerHeight.md index 21b785a6..ede6419d 100644 --- a/docs/api/redditapi/models/type-aliases/BannerHeight.md +++ b/docs/api/redditapi/models/type-aliases/BannerHeight.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CommentMediaTypes.md b/docs/api/redditapi/models/type-aliases/CommentMediaTypes.md index f0348d37..14f0aaaf 100644 --- a/docs/api/redditapi/models/type-aliases/CommentMediaTypes.md +++ b/docs/api/redditapi/models/type-aliases/CommentMediaTypes.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CommentSort.md b/docs/api/redditapi/models/type-aliases/CommentSort.md index f8c41079..92407d40 100644 --- a/docs/api/redditapi/models/type-aliases/CommentSort.md +++ b/docs/api/redditapi/models/type-aliases/CommentSort.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CommentSubmissionOptions.md b/docs/api/redditapi/models/type-aliases/CommentSubmissionOptions.md index 2f9f20f7..accb67ee 100644 --- a/docs/api/redditapi/models/type-aliases/CommentSubmissionOptions.md +++ b/docs/api/redditapi/models/type-aliases/CommentSubmissionOptions.md @@ -1,7 +1,7 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** # Type Alias: CommentSubmissionOptions -> **CommentSubmissionOptions** = \{ `runAs`: `"USER"` \| `"APP"`; `text`: `string`; \} \| \{ `richtext`: `object` \| `RichTextBuilder`; `runAs`: `"USER"` \| `"APP"`; \} +> **CommentSubmissionOptions** = \{ `id`: `string`; `runAs`: `"USER"` \| `"APP"`; `text`: `string`; \} \| \{ `id`: `string`; `richtext`: `object` \| `RichTextBuilder`; `runAs`: `"USER"` \| `"APP"`; \} diff --git a/docs/api/redditapi/models/type-aliases/CommonFlair.md b/docs/api/redditapi/models/type-aliases/CommonFlair.md index 381c1e41..3f6e712b 100644 --- a/docs/api/redditapi/models/type-aliases/CommonFlair.md +++ b/docs/api/redditapi/models/type-aliases/CommonFlair.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CommonSubmitPostOptions.md b/docs/api/redditapi/models/type-aliases/CommonSubmitPostOptions.md index a021a32d..13ac49c5 100644 --- a/docs/api/redditapi/models/type-aliases/CommonSubmitPostOptions.md +++ b/docs/api/redditapi/models/type-aliases/CommonSubmitPostOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CommunityNameFormat.md b/docs/api/redditapi/models/type-aliases/CommunityNameFormat.md index bef4b7f1..9fb086cc 100644 --- a/docs/api/redditapi/models/type-aliases/CommunityNameFormat.md +++ b/docs/api/redditapi/models/type-aliases/CommunityNameFormat.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ConversationData.md b/docs/api/redditapi/models/type-aliases/ConversationData.md index 15d0092e..80a5e822 100644 --- a/docs/api/redditapi/models/type-aliases/ConversationData.md +++ b/docs/api/redditapi/models/type-aliases/ConversationData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ConversationResponse.md b/docs/api/redditapi/models/type-aliases/ConversationResponse.md index bb0dfcef..e7196f5e 100644 --- a/docs/api/redditapi/models/type-aliases/ConversationResponse.md +++ b/docs/api/redditapi/models/type-aliases/ConversationResponse.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ConversationStateFilter.md b/docs/api/redditapi/models/type-aliases/ConversationStateFilter.md index 190a2f3e..4e268e8f 100644 --- a/docs/api/redditapi/models/type-aliases/ConversationStateFilter.md +++ b/docs/api/redditapi/models/type-aliases/ConversationStateFilter.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ConversationUserData.md b/docs/api/redditapi/models/type-aliases/ConversationUserData.md index f8856254..71a1fa93 100644 --- a/docs/api/redditapi/models/type-aliases/ConversationUserData.md +++ b/docs/api/redditapi/models/type-aliases/ConversationUserData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CreateFlairTemplateOptions.md b/docs/api/redditapi/models/type-aliases/CreateFlairTemplateOptions.md index 76adc366..ed14ff18 100644 --- a/docs/api/redditapi/models/type-aliases/CreateFlairTemplateOptions.md +++ b/docs/api/redditapi/models/type-aliases/CreateFlairTemplateOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CreateModNoteOptions.md b/docs/api/redditapi/models/type-aliases/CreateModNoteOptions.md index 17ffd3e2..1c3edb3a 100644 --- a/docs/api/redditapi/models/type-aliases/CreateModNoteOptions.md +++ b/docs/api/redditapi/models/type-aliases/CreateModNoteOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CreateRelationshipOptions.md b/docs/api/redditapi/models/type-aliases/CreateRelationshipOptions.md index 6c8cb97e..c2313b8f 100644 --- a/docs/api/redditapi/models/type-aliases/CreateRelationshipOptions.md +++ b/docs/api/redditapi/models/type-aliases/CreateRelationshipOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CreateRuleOptions.md b/docs/api/redditapi/models/type-aliases/CreateRuleOptions.md index d687a65c..db5a9596 100644 --- a/docs/api/redditapi/models/type-aliases/CreateRuleOptions.md +++ b/docs/api/redditapi/models/type-aliases/CreateRuleOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CreateWikiPageOptions.md b/docs/api/redditapi/models/type-aliases/CreateWikiPageOptions.md index 0102e1f9..30b3d161 100644 --- a/docs/api/redditapi/models/type-aliases/CreateWikiPageOptions.md +++ b/docs/api/redditapi/models/type-aliases/CreateWikiPageOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CrosspostOptions.md b/docs/api/redditapi/models/type-aliases/CrosspostOptions.md index eb4e6950..a4bfc504 100644 --- a/docs/api/redditapi/models/type-aliases/CrosspostOptions.md +++ b/docs/api/redditapi/models/type-aliases/CrosspostOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CrowdControlLevel.md b/docs/api/redditapi/models/type-aliases/CrowdControlLevel.md index da35f33a..a7ae2811 100644 --- a/docs/api/redditapi/models/type-aliases/CrowdControlLevel.md +++ b/docs/api/redditapi/models/type-aliases/CrowdControlLevel.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CustomPostRichTextFallback.md b/docs/api/redditapi/models/type-aliases/CustomPostRichTextFallback.md index bbc03dc4..2a917ef0 100644 --- a/docs/api/redditapi/models/type-aliases/CustomPostRichTextFallback.md +++ b/docs/api/redditapi/models/type-aliases/CustomPostRichTextFallback.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CustomPostTextFallbackOptions.md b/docs/api/redditapi/models/type-aliases/CustomPostTextFallbackOptions.md index 30addfd8..8c73efd1 100644 --- a/docs/api/redditapi/models/type-aliases/CustomPostTextFallbackOptions.md +++ b/docs/api/redditapi/models/type-aliases/CustomPostTextFallbackOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CustomizationFlag.md b/docs/api/redditapi/models/type-aliases/CustomizationFlag.md index e85fac63..99107d05 100644 --- a/docs/api/redditapi/models/type-aliases/CustomizationFlag.md +++ b/docs/api/redditapi/models/type-aliases/CustomizationFlag.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/DeleteNotesOptions.md b/docs/api/redditapi/models/type-aliases/DeleteNotesOptions.md index 531a0765..91279620 100644 --- a/docs/api/redditapi/models/type-aliases/DeleteNotesOptions.md +++ b/docs/api/redditapi/models/type-aliases/DeleteNotesOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/EditCommentOptions.md b/docs/api/redditapi/models/type-aliases/EditCommentOptions.md index d529a942..fa0beed4 100644 --- a/docs/api/redditapi/models/type-aliases/EditCommentOptions.md +++ b/docs/api/redditapi/models/type-aliases/EditCommentOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/EditFlairTemplateOptions.md b/docs/api/redditapi/models/type-aliases/EditFlairTemplateOptions.md index d23b71be..940ab8da 100644 --- a/docs/api/redditapi/models/type-aliases/EditFlairTemplateOptions.md +++ b/docs/api/redditapi/models/type-aliases/EditFlairTemplateOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/EnrichedThumbnail.md b/docs/api/redditapi/models/type-aliases/EnrichedThumbnail.md index 042e8ef3..fac64548 100644 --- a/docs/api/redditapi/models/type-aliases/EnrichedThumbnail.md +++ b/docs/api/redditapi/models/type-aliases/EnrichedThumbnail.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/FlairBackgroundColor.md b/docs/api/redditapi/models/type-aliases/FlairBackgroundColor.md index 3dae73c1..ff80429b 100644 --- a/docs/api/redditapi/models/type-aliases/FlairBackgroundColor.md +++ b/docs/api/redditapi/models/type-aliases/FlairBackgroundColor.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/FlairSettings.md b/docs/api/redditapi/models/type-aliases/FlairSettings.md index ec194603..a3591dcd 100644 --- a/docs/api/redditapi/models/type-aliases/FlairSettings.md +++ b/docs/api/redditapi/models/type-aliases/FlairSettings.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/FlairTextColor.md b/docs/api/redditapi/models/type-aliases/FlairTextColor.md index b5ae259d..4806c8ec 100644 --- a/docs/api/redditapi/models/type-aliases/FlairTextColor.md +++ b/docs/api/redditapi/models/type-aliases/FlairTextColor.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GalleryMedia.md b/docs/api/redditapi/models/type-aliases/GalleryMedia.md index 00e67052..02f63a53 100644 --- a/docs/api/redditapi/models/type-aliases/GalleryMedia.md +++ b/docs/api/redditapi/models/type-aliases/GalleryMedia.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GalleryMediaStatus.md b/docs/api/redditapi/models/type-aliases/GalleryMediaStatus.md index 66697586..977dd623 100644 --- a/docs/api/redditapi/models/type-aliases/GalleryMediaStatus.md +++ b/docs/api/redditapi/models/type-aliases/GalleryMediaStatus.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetBestPostsOptions.md b/docs/api/redditapi/models/type-aliases/GetBestPostsOptions.md index ebaed77c..6777c6ab 100644 --- a/docs/api/redditapi/models/type-aliases/GetBestPostsOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetBestPostsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetCommentsByUserOptions.md b/docs/api/redditapi/models/type-aliases/GetCommentsByUserOptions.md index 67029ba0..e04100ee 100644 --- a/docs/api/redditapi/models/type-aliases/GetCommentsByUserOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetCommentsByUserOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetCommentsOptions.md b/docs/api/redditapi/models/type-aliases/GetCommentsOptions.md index 476dcc6a..e7c3b6c9 100644 --- a/docs/api/redditapi/models/type-aliases/GetCommentsOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetCommentsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetConversationResponse.md b/docs/api/redditapi/models/type-aliases/GetConversationResponse.md index de34141d..bdeead51 100644 --- a/docs/api/redditapi/models/type-aliases/GetConversationResponse.md +++ b/docs/api/redditapi/models/type-aliases/GetConversationResponse.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetConversationsRequest.md b/docs/api/redditapi/models/type-aliases/GetConversationsRequest.md index 07a4ae2c..d799c782 100644 --- a/docs/api/redditapi/models/type-aliases/GetConversationsRequest.md +++ b/docs/api/redditapi/models/type-aliases/GetConversationsRequest.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetConversationsResponse.md b/docs/api/redditapi/models/type-aliases/GetConversationsResponse.md index 05d35493..e601f3a4 100644 --- a/docs/api/redditapi/models/type-aliases/GetConversationsResponse.md +++ b/docs/api/redditapi/models/type-aliases/GetConversationsResponse.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetDuplicatesOptions.md b/docs/api/redditapi/models/type-aliases/GetDuplicatesOptions.md index 1542ed63..3767575f 100644 --- a/docs/api/redditapi/models/type-aliases/GetDuplicatesOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetDuplicatesOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetHotPostsOptions.md b/docs/api/redditapi/models/type-aliases/GetHotPostsOptions.md index bc577646..37e8c237 100644 --- a/docs/api/redditapi/models/type-aliases/GetHotPostsOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetHotPostsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetModNotesOptions.md b/docs/api/redditapi/models/type-aliases/GetModNotesOptions.md index f9accf0e..da5c6ad2 100644 --- a/docs/api/redditapi/models/type-aliases/GetModNotesOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetModNotesOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetModerationLogOptions.md b/docs/api/redditapi/models/type-aliases/GetModerationLogOptions.md index de834a07..89d12b07 100644 --- a/docs/api/redditapi/models/type-aliases/GetModerationLogOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetModerationLogOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetPageRevisionsOptions.md b/docs/api/redditapi/models/type-aliases/GetPageRevisionsOptions.md index 96d02148..59aebba4 100644 --- a/docs/api/redditapi/models/type-aliases/GetPageRevisionsOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetPageRevisionsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetPostsByUserOptions.md b/docs/api/redditapi/models/type-aliases/GetPostsByUserOptions.md index f44d7d40..1c029136 100644 --- a/docs/api/redditapi/models/type-aliases/GetPostsByUserOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetPostsByUserOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetPostsOptions.md b/docs/api/redditapi/models/type-aliases/GetPostsOptions.md index 9caf2f2b..4bab72f7 100644 --- a/docs/api/redditapi/models/type-aliases/GetPostsOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetPostsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetPostsOptionsWithTimeframe.md b/docs/api/redditapi/models/type-aliases/GetPostsOptionsWithTimeframe.md index b71b2b65..d046c991 100644 --- a/docs/api/redditapi/models/type-aliases/GetPostsOptionsWithTimeframe.md +++ b/docs/api/redditapi/models/type-aliases/GetPostsOptionsWithTimeframe.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetPrivateMessagesOptions.md b/docs/api/redditapi/models/type-aliases/GetPrivateMessagesOptions.md index 8ea90c66..e13ea70c 100644 --- a/docs/api/redditapi/models/type-aliases/GetPrivateMessagesOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetPrivateMessagesOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetSortedPostsOptions.md b/docs/api/redditapi/models/type-aliases/GetSortedPostsOptions.md index ab86520a..34fe677a 100644 --- a/docs/api/redditapi/models/type-aliases/GetSortedPostsOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetSortedPostsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetSubredditUsersByTypeOptions.md b/docs/api/redditapi/models/type-aliases/GetSubredditUsersByTypeOptions.md index 04a631db..00c817da 100644 --- a/docs/api/redditapi/models/type-aliases/GetSubredditUsersByTypeOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetSubredditUsersByTypeOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetUserFlairBySubredditOptions.md b/docs/api/redditapi/models/type-aliases/GetUserFlairBySubredditOptions.md index 75d8623f..dfd2f965 100644 --- a/docs/api/redditapi/models/type-aliases/GetUserFlairBySubredditOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetUserFlairBySubredditOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetUserFlairBySubredditResponse.md b/docs/api/redditapi/models/type-aliases/GetUserFlairBySubredditResponse.md index cd423f23..34a1a937 100644 --- a/docs/api/redditapi/models/type-aliases/GetUserFlairBySubredditResponse.md +++ b/docs/api/redditapi/models/type-aliases/GetUserFlairBySubredditResponse.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetUserFlairOptions.md b/docs/api/redditapi/models/type-aliases/GetUserFlairOptions.md index 33d21b6a..27d7aa8a 100644 --- a/docs/api/redditapi/models/type-aliases/GetUserFlairOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetUserFlairOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetUserOverviewOptions.md b/docs/api/redditapi/models/type-aliases/GetUserOverviewOptions.md index ac282562..e60cd97b 100644 --- a/docs/api/redditapi/models/type-aliases/GetUserOverviewOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetUserOverviewOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ImagePosition.md b/docs/api/redditapi/models/type-aliases/ImagePosition.md index a4dbab24..6d076ce0 100644 --- a/docs/api/redditapi/models/type-aliases/ImagePosition.md +++ b/docs/api/redditapi/models/type-aliases/ImagePosition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/InternalSetPostFlairOptions.md b/docs/api/redditapi/models/type-aliases/InternalSetPostFlairOptions.md index cce9c122..59924714 100644 --- a/docs/api/redditapi/models/type-aliases/InternalSetPostFlairOptions.md +++ b/docs/api/redditapi/models/type-aliases/InternalSetPostFlairOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/LinkFlair.md b/docs/api/redditapi/models/type-aliases/LinkFlair.md index cb8b06cb..fdd2dd1c 100644 --- a/docs/api/redditapi/models/type-aliases/LinkFlair.md +++ b/docs/api/redditapi/models/type-aliases/LinkFlair.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ListingFetchOptions.md b/docs/api/redditapi/models/type-aliases/ListingFetchOptions.md index a5ed1fdc..39751f7e 100644 --- a/docs/api/redditapi/models/type-aliases/ListingFetchOptions.md +++ b/docs/api/redditapi/models/type-aliases/ListingFetchOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ListingFetchResponse.md b/docs/api/redditapi/models/type-aliases/ListingFetchResponse.md index ed576a9a..dc942eb2 100644 --- a/docs/api/redditapi/models/type-aliases/ListingFetchResponse.md +++ b/docs/api/redditapi/models/type-aliases/ListingFetchResponse.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/MenuPosition.md b/docs/api/redditapi/models/type-aliases/MenuPosition.md index df258859..d2f35b3d 100644 --- a/docs/api/redditapi/models/type-aliases/MenuPosition.md +++ b/docs/api/redditapi/models/type-aliases/MenuPosition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/MessageData.md b/docs/api/redditapi/models/type-aliases/MessageData.md index 607010a9..c3da7b46 100644 --- a/docs/api/redditapi/models/type-aliases/MessageData.md +++ b/docs/api/redditapi/models/type-aliases/MessageData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ModActionData.md b/docs/api/redditapi/models/type-aliases/ModActionData.md index f25fcff5..868f8bf3 100644 --- a/docs/api/redditapi/models/type-aliases/ModActionData.md +++ b/docs/api/redditapi/models/type-aliases/ModActionData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ModActionTarget.md b/docs/api/redditapi/models/type-aliases/ModActionTarget.md index c2aa055c..0cb023ac 100644 --- a/docs/api/redditapi/models/type-aliases/ModActionTarget.md +++ b/docs/api/redditapi/models/type-aliases/ModActionTarget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ModActionType.md b/docs/api/redditapi/models/type-aliases/ModActionType.md index b24af12e..fa4bf132 100644 --- a/docs/api/redditapi/models/type-aliases/ModActionType.md +++ b/docs/api/redditapi/models/type-aliases/ModActionType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ModLogOptions.md b/docs/api/redditapi/models/type-aliases/ModLogOptions.md index 4089cd92..bf286983 100644 --- a/docs/api/redditapi/models/type-aliases/ModLogOptions.md +++ b/docs/api/redditapi/models/type-aliases/ModLogOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ModNoteType.md b/docs/api/redditapi/models/type-aliases/ModNoteType.md index 161945ca..5397b8ce 100644 --- a/docs/api/redditapi/models/type-aliases/ModNoteType.md +++ b/docs/api/redditapi/models/type-aliases/ModNoteType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ModeratorPermission.md b/docs/api/redditapi/models/type-aliases/ModeratorPermission.md index 13354fbc..7246fdb1 100644 --- a/docs/api/redditapi/models/type-aliases/ModeratorPermission.md +++ b/docs/api/redditapi/models/type-aliases/ModeratorPermission.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/MoreObject.md b/docs/api/redditapi/models/type-aliases/MoreObject.md index c4de1c2a..f3c4b324 100644 --- a/docs/api/redditapi/models/type-aliases/MoreObject.md +++ b/docs/api/redditapi/models/type-aliases/MoreObject.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/OEmbed.md b/docs/api/redditapi/models/type-aliases/OEmbed.md index 689104cf..a899f620 100644 --- a/docs/api/redditapi/models/type-aliases/OEmbed.md +++ b/docs/api/redditapi/models/type-aliases/OEmbed.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/Participant.md b/docs/api/redditapi/models/type-aliases/Participant.md index e78e055f..c312dd73 100644 --- a/docs/api/redditapi/models/type-aliases/Participant.md +++ b/docs/api/redditapi/models/type-aliases/Participant.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/PollData.md b/docs/api/redditapi/models/type-aliases/PollData.md index 0a26288b..f1abe921 100644 --- a/docs/api/redditapi/models/type-aliases/PollData.md +++ b/docs/api/redditapi/models/type-aliases/PollData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/PollOption.md b/docs/api/redditapi/models/type-aliases/PollOption.md index 58eebb01..2d81773b 100644 --- a/docs/api/redditapi/models/type-aliases/PollOption.md +++ b/docs/api/redditapi/models/type-aliases/PollOption.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/PositionedImagePosition.md b/docs/api/redditapi/models/type-aliases/PositionedImagePosition.md index 6cc029cc..23702322 100644 --- a/docs/api/redditapi/models/type-aliases/PositionedImagePosition.md +++ b/docs/api/redditapi/models/type-aliases/PositionedImagePosition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/PostCapabilities.md b/docs/api/redditapi/models/type-aliases/PostCapabilities.md index fda85d20..21bd5144 100644 --- a/docs/api/redditapi/models/type-aliases/PostCapabilities.md +++ b/docs/api/redditapi/models/type-aliases/PostCapabilities.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/PostSuggestedCommentSort.md b/docs/api/redditapi/models/type-aliases/PostSuggestedCommentSort.md index 3aee8129..d7a6479e 100644 --- a/docs/api/redditapi/models/type-aliases/PostSuggestedCommentSort.md +++ b/docs/api/redditapi/models/type-aliases/PostSuggestedCommentSort.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/PostTextOptions.md b/docs/api/redditapi/models/type-aliases/PostTextOptions.md index 2a1ea852..03ce4801 100644 --- a/docs/api/redditapi/models/type-aliases/PostTextOptions.md +++ b/docs/api/redditapi/models/type-aliases/PostTextOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/PostType.md b/docs/api/redditapi/models/type-aliases/PostType.md index d3c25042..6fbce99f 100644 --- a/docs/api/redditapi/models/type-aliases/PostType.md +++ b/docs/api/redditapi/models/type-aliases/PostType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/RedditVideo.md b/docs/api/redditapi/models/type-aliases/RedditVideo.md index 09e338a6..57e2af4a 100644 --- a/docs/api/redditapi/models/type-aliases/RedditVideo.md +++ b/docs/api/redditapi/models/type-aliases/RedditVideo.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/RelationshipType.md b/docs/api/redditapi/models/type-aliases/RelationshipType.md index 0eeb649a..3912be01 100644 --- a/docs/api/redditapi/models/type-aliases/RelationshipType.md +++ b/docs/api/redditapi/models/type-aliases/RelationshipType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/RemovalReason.md b/docs/api/redditapi/models/type-aliases/RemovalReason.md index 709ae91e..ae6a34c7 100644 --- a/docs/api/redditapi/models/type-aliases/RemovalReason.md +++ b/docs/api/redditapi/models/type-aliases/RemovalReason.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/RemoveRelationshipOptions.md b/docs/api/redditapi/models/type-aliases/RemoveRelationshipOptions.md index 05a784e3..088bed63 100644 --- a/docs/api/redditapi/models/type-aliases/RemoveRelationshipOptions.md +++ b/docs/api/redditapi/models/type-aliases/RemoveRelationshipOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ReplyToCommentOptions.md b/docs/api/redditapi/models/type-aliases/ReplyToCommentOptions.md index 31ecb4ad..277fb7fe 100644 --- a/docs/api/redditapi/models/type-aliases/ReplyToCommentOptions.md +++ b/docs/api/redditapi/models/type-aliases/ReplyToCommentOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SecureMedia.md b/docs/api/redditapi/models/type-aliases/SecureMedia.md index f0d0513a..4c473051 100644 --- a/docs/api/redditapi/models/type-aliases/SecureMedia.md +++ b/docs/api/redditapi/models/type-aliases/SecureMedia.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SendPrivateMessageAsSubredditOptions.md b/docs/api/redditapi/models/type-aliases/SendPrivateMessageAsSubredditOptions.md index 3ca2ac99..ddac1f69 100644 --- a/docs/api/redditapi/models/type-aliases/SendPrivateMessageAsSubredditOptions.md +++ b/docs/api/redditapi/models/type-aliases/SendPrivateMessageAsSubredditOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SendPrivateMessageOptions.md b/docs/api/redditapi/models/type-aliases/SendPrivateMessageOptions.md index ee92f83a..c91e8b5a 100644 --- a/docs/api/redditapi/models/type-aliases/SendPrivateMessageOptions.md +++ b/docs/api/redditapi/models/type-aliases/SendPrivateMessageOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SetFlairOptions.md b/docs/api/redditapi/models/type-aliases/SetFlairOptions.md index 5815058d..02182aa5 100644 --- a/docs/api/redditapi/models/type-aliases/SetFlairOptions.md +++ b/docs/api/redditapi/models/type-aliases/SetFlairOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SetPostFlairOptions.md b/docs/api/redditapi/models/type-aliases/SetPostFlairOptions.md index 7b551182..5b2c6507 100644 --- a/docs/api/redditapi/models/type-aliases/SetPostFlairOptions.md +++ b/docs/api/redditapi/models/type-aliases/SetPostFlairOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SetUserFlairBatchConfig.md b/docs/api/redditapi/models/type-aliases/SetUserFlairBatchConfig.md index e3451f57..78b743a8 100644 --- a/docs/api/redditapi/models/type-aliases/SetUserFlairBatchConfig.md +++ b/docs/api/redditapi/models/type-aliases/SetUserFlairBatchConfig.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SetUserFlairOptions.md b/docs/api/redditapi/models/type-aliases/SetUserFlairOptions.md index 158dcacf..52633a3b 100644 --- a/docs/api/redditapi/models/type-aliases/SetUserFlairOptions.md +++ b/docs/api/redditapi/models/type-aliases/SetUserFlairOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubmitCustomPostOptions.md b/docs/api/redditapi/models/type-aliases/SubmitCustomPostOptions.md index d8d91d90..b7d8a8d2 100644 --- a/docs/api/redditapi/models/type-aliases/SubmitCustomPostOptions.md +++ b/docs/api/redditapi/models/type-aliases/SubmitCustomPostOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** @@ -12,9 +12,9 @@ > `optional` **postData**: `PostData` -### preview +### preview? -> **preview**: `JSX.Element` +> `optional` **preview**: `JSX.Element` ### userGeneratedContent? diff --git a/docs/api/redditapi/models/type-aliases/SubmitCustomPostTextFallbackOptions.md b/docs/api/redditapi/models/type-aliases/SubmitCustomPostTextFallbackOptions.md index 9ce01f8f..5a8eea2f 100644 --- a/docs/api/redditapi/models/type-aliases/SubmitCustomPostTextFallbackOptions.md +++ b/docs/api/redditapi/models/type-aliases/SubmitCustomPostTextFallbackOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubmitLinkOptions.md b/docs/api/redditapi/models/type-aliases/SubmitLinkOptions.md index 1216cdc9..292984a4 100644 --- a/docs/api/redditapi/models/type-aliases/SubmitLinkOptions.md +++ b/docs/api/redditapi/models/type-aliases/SubmitLinkOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubmitMediaOptions.md b/docs/api/redditapi/models/type-aliases/SubmitMediaOptions.md index d6399eda..928b503a 100644 --- a/docs/api/redditapi/models/type-aliases/SubmitMediaOptions.md +++ b/docs/api/redditapi/models/type-aliases/SubmitMediaOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubmitPostOptions.md b/docs/api/redditapi/models/type-aliases/SubmitPostOptions.md index 5251d2b3..13d8bb9b 100644 --- a/docs/api/redditapi/models/type-aliases/SubmitPostOptions.md +++ b/docs/api/redditapi/models/type-aliases/SubmitPostOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubmitSelfPostOptions.md b/docs/api/redditapi/models/type-aliases/SubmitSelfPostOptions.md index 7f50ef4c..aef1d12e 100644 --- a/docs/api/redditapi/models/type-aliases/SubmitSelfPostOptions.md +++ b/docs/api/redditapi/models/type-aliases/SubmitSelfPostOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditData.md b/docs/api/redditapi/models/type-aliases/SubredditData.md index 5cfeab60..cf4a1a0c 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditData.md +++ b/docs/api/redditapi/models/type-aliases/SubredditData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditInfo.md b/docs/api/redditapi/models/type-aliases/SubredditInfo.md index eab0335d..e0597095 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditInfo.md +++ b/docs/api/redditapi/models/type-aliases/SubredditInfo.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditLeaderboard.md b/docs/api/redditapi/models/type-aliases/SubredditLeaderboard.md index 576daf8e..9ed12d7b 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditLeaderboard.md +++ b/docs/api/redditapi/models/type-aliases/SubredditLeaderboard.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditLeaderboardSummary.md b/docs/api/redditapi/models/type-aliases/SubredditLeaderboardSummary.md index 3426aa78..51c66143 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditLeaderboardSummary.md +++ b/docs/api/redditapi/models/type-aliases/SubredditLeaderboardSummary.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditLeaderboardSummaryRow.md b/docs/api/redditapi/models/type-aliases/SubredditLeaderboardSummaryRow.md index 511a6560..d9ad2269 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditLeaderboardSummaryRow.md +++ b/docs/api/redditapi/models/type-aliases/SubredditLeaderboardSummaryRow.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditSettings.md b/docs/api/redditapi/models/type-aliases/SubredditSettings.md index 3d927190..670c7211 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditSettings.md +++ b/docs/api/redditapi/models/type-aliases/SubredditSettings.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditSettingsOptions.md b/docs/api/redditapi/models/type-aliases/SubredditSettingsOptions.md index 6fc44f02..11166786 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditSettingsOptions.md +++ b/docs/api/redditapi/models/type-aliases/SubredditSettingsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditStyles.md b/docs/api/redditapi/models/type-aliases/SubredditStyles.md index 77357e38..ad5b483f 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditStyles.md +++ b/docs/api/redditapi/models/type-aliases/SubredditStyles.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditType.md b/docs/api/redditapi/models/type-aliases/SubredditType.md index 56e9c896..0b47eace 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditType.md +++ b/docs/api/redditapi/models/type-aliases/SubredditType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/Trophy.md b/docs/api/redditapi/models/type-aliases/Trophy.md index e4dc11f0..a3f97e9e 100644 --- a/docs/api/redditapi/models/type-aliases/Trophy.md +++ b/docs/api/redditapi/models/type-aliases/Trophy.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UnreadCountResponse.md b/docs/api/redditapi/models/type-aliases/UnreadCountResponse.md index d8564eb3..d831f062 100644 --- a/docs/api/redditapi/models/type-aliases/UnreadCountResponse.md +++ b/docs/api/redditapi/models/type-aliases/UnreadCountResponse.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UpdatePageSettingsOptions.md b/docs/api/redditapi/models/type-aliases/UpdatePageSettingsOptions.md index 4b7a846f..b9969a82 100644 --- a/docs/api/redditapi/models/type-aliases/UpdatePageSettingsOptions.md +++ b/docs/api/redditapi/models/type-aliases/UpdatePageSettingsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UpdateRuleOptions.md b/docs/api/redditapi/models/type-aliases/UpdateRuleOptions.md index 277210f2..8115899c 100644 --- a/docs/api/redditapi/models/type-aliases/UpdateRuleOptions.md +++ b/docs/api/redditapi/models/type-aliases/UpdateRuleOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UpdateWidgetData.md b/docs/api/redditapi/models/type-aliases/UpdateWidgetData.md index 4ca6899b..15a16b1e 100644 --- a/docs/api/redditapi/models/type-aliases/UpdateWidgetData.md +++ b/docs/api/redditapi/models/type-aliases/UpdateWidgetData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UpdateWikiPageOptions.md b/docs/api/redditapi/models/type-aliases/UpdateWikiPageOptions.md index c0fa1420..db63fe8b 100644 --- a/docs/api/redditapi/models/type-aliases/UpdateWikiPageOptions.md +++ b/docs/api/redditapi/models/type-aliases/UpdateWikiPageOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UserFlair.md b/docs/api/redditapi/models/type-aliases/UserFlair.md index acfbac61..94c9be2a 100644 --- a/docs/api/redditapi/models/type-aliases/UserFlair.md +++ b/docs/api/redditapi/models/type-aliases/UserFlair.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UserFlairPageOptions.md b/docs/api/redditapi/models/type-aliases/UserFlairPageOptions.md index 1bc8380e..f06b42a3 100644 --- a/docs/api/redditapi/models/type-aliases/UserFlairPageOptions.md +++ b/docs/api/redditapi/models/type-aliases/UserFlairPageOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UserNote.md b/docs/api/redditapi/models/type-aliases/UserNote.md index 7b6a93f9..07881e98 100644 --- a/docs/api/redditapi/models/type-aliases/UserNote.md +++ b/docs/api/redditapi/models/type-aliases/UserNote.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UserNoteLabel.md b/docs/api/redditapi/models/type-aliases/UserNoteLabel.md index a40aaba6..82eb0ae0 100644 --- a/docs/api/redditapi/models/type-aliases/UserNoteLabel.md +++ b/docs/api/redditapi/models/type-aliases/UserNoteLabel.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UserSocialLink.md b/docs/api/redditapi/models/type-aliases/UserSocialLink.md index 2db03fae..4608c3cc 100644 --- a/docs/api/redditapi/models/type-aliases/UserSocialLink.md +++ b/docs/api/redditapi/models/type-aliases/UserSocialLink.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/Vault.md b/docs/api/redditapi/models/type-aliases/Vault.md index 3cfba8da..0ba99658 100644 --- a/docs/api/redditapi/models/type-aliases/Vault.md +++ b/docs/api/redditapi/models/type-aliases/Vault.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/Visibility.md b/docs/api/redditapi/models/type-aliases/Visibility.md index 962b659d..d52143bb 100644 --- a/docs/api/redditapi/models/type-aliases/Visibility.md +++ b/docs/api/redditapi/models/type-aliases/Visibility.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/WikiEditMode.md b/docs/api/redditapi/models/type-aliases/WikiEditMode.md index 044719ba..4fb57f56 100644 --- a/docs/api/redditapi/models/type-aliases/WikiEditMode.md +++ b/docs/api/redditapi/models/type-aliases/WikiEditMode.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/WikiPageRevisionId.md b/docs/api/redditapi/models/type-aliases/WikiPageRevisionId.md index dbee602a..deccc842 100644 --- a/docs/api/redditapi/models/type-aliases/WikiPageRevisionId.md +++ b/docs/api/redditapi/models/type-aliases/WikiPageRevisionId.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/WithUserData.md b/docs/api/redditapi/models/type-aliases/WithUserData.md index 49642c02..fdf3bf4d 100644 --- a/docs/api/redditapi/models/type-aliases/WithUserData.md +++ b/docs/api/redditapi/models/type-aliases/WithUserData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/variables/GalleryMediaStatus.md b/docs/api/redditapi/models/variables/GalleryMediaStatus.md index 82f7185b..06abb195 100644 --- a/docs/api/redditapi/models/variables/GalleryMediaStatus.md +++ b/docs/api/redditapi/models/variables/GalleryMediaStatus.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.21-dev**](../../README.md) +[**Reddit API Reference v0.12.21-dev**](../../README.md) *** diff --git a/docs/capabilities/client/menu-actions.mdx b/docs/capabilities/client/menu-actions.mdx index 348944e8..278e4bd2 100644 --- a/docs/capabilities/client/menu-actions.mdx +++ b/docs/capabilities/client/menu-actions.mdx @@ -79,7 +79,7 @@ You can decide where the menu action shows up by specifying the location propert | ---------------------- | ------------------------------ | ------------------------------------------------------------------------------- | | location (required) | `comment`, `post`, `subreddit` | Determines where the menu action appears. | | postFilter (optional) | `currentApp` | Shows the action created by your app. The default is no filtering. | -| forUserType (optional) | `moderator` | Specifies the user types that can see the menu action. The default is everyone. | +| forUserType (optional) | `moderator`, `user` | Specifies the user types that can see the menu action. The default is `moderator`. | :::note For moderator permission security, when opening a form from a menu action with `forUserType: moderator`, the user initiating the action must complete all actions within 10 minutes. diff --git a/docs/capabilities/creating_custom_post.md b/docs/capabilities/creating_custom_post.md index 66ef675b..3a996538 100644 --- a/docs/capabilities/creating_custom_post.md +++ b/docs/capabilities/creating_custom_post.md @@ -1,6 +1,6 @@ # Creating a Custom Post -Redditors interact with your app through custom posts. To create a custom post, you’ll define the entry points in `devvit.json,` then use `submitCustomPost` to create a post that references one of those entry points. +Redditors interact with your app through custom posts. To create a custom post, define the entry points in `devvit.json`, then use `submitCustomPost` to create a post that references one of those entry points. ## **How it Works** @@ -46,6 +46,8 @@ export const createPost = async () => { | `userGeneratedContent` | [Enables user-generated content](../capabilities/server/userActions) | | `styles` | Controls post appearance in the Reddit UI. See [Custom Post Styles](#custom-post-styles) | +You do not need to provide a separate `preview` element when creating a custom post with Devvit Web. + ## **Custom Post Styles** Custom post styles let you control how a custom post looks in the Reddit UI, separate from the content inside your webview. You can: diff --git a/docs/capabilities/devvit-web/devvit_web_configuration.md b/docs/capabilities/devvit-web/devvit_web_configuration.md index 57d71804..9e5337a5 100644 --- a/docs/capabilities/devvit-web/devvit_web_configuration.md +++ b/docs/capabilities/devvit-web/devvit_web_configuration.md @@ -27,6 +27,11 @@ Additionally, you must include at least one of: ## Configuration sections +### Endpoint conventions + +- Use `/api/` for client-facing endpoints that your webview calls with `fetch()`. +- Use `/internal/` for handlers declared in `devvit.json`, such as menu actions, forms, triggers, scheduler tasks, settings validation, and payments endpoints. + ### Core properties | Property | Type | Description | Required | @@ -46,6 +51,7 @@ Additionally, you must include at least one of: | Property | Type | Description | Required | | ----------------- | ------ | ------------------------------ | -------- | | `permissions` | object | What your app is allowed to do | No | +| `settings` | object | Global and subreddit settings | No | | `media` | object | Static asset configuration | No | | `marketingAssets` | object | Assets for featuring your app | No | @@ -258,12 +264,39 @@ Map form identifiers to submission endpoints: ```json { "forms": { - "contact_form": "/internal/forms/contact", - "feedback_form": "/internal/forms/feedback" + "contact_form": "/internal/form/contact", + "feedback_form": "/internal/form/feedback" } } ``` +### Settings configuration + +Define settings that can be managed globally by developers or per-installation by moderators: + +```json +{ + "settings": { + "global": { + "apiKey": { + "type": "string", + "label": "API Key", + "isSecret": true + } + }, + "subreddit": { + "mopEnabled": { + "type": "boolean", + "label": "Enable Comment Mop", + "defaultValue": true + } + } + } +} +``` + +See [Settings and Secrets](../server/settings-and-secrets.mdx) for the full settings schema, supported field types, and validation endpoints. + ### Marketing assets Configure app presentation: @@ -296,7 +329,7 @@ Configure build commands run by the Devvit CLI. These commands run relative to t **Properties:** - `dev` (string): Command run by `devvit playtest` to build or watch your client/server artifacts -- `build` (string): Command run by `devvit upload` to build your client/server artifacts +- `build` (string): Command run when Devvit needs a production build, such as `devvit upload` or `devvit publish` ### Development configuration @@ -331,7 +364,7 @@ The `devvit.json` configuration is validated against the JSON Schema at build ti 1. **Always include the `$schema` property** for IDE autocompletion and validation. 2. **Use specific permission scopes.** Only request permissions your app actually uses. 3. **Set appropriate menu scopes.** Consider whether features should be available to all users or just moderators. -4. **Validate endpoints.** Ensure all internal endpoints start with `/internal/`. +4. **Validate endpoints.** Use `/api/` for client-facing fetch routes and `/internal/` for `devvit.json` handlers. 5. **Use meaningful names.** Choose descriptive names for entrypoints, tasks, and forms. 6. **Test configurations.** Validate your config with `devvit build` before deployment. diff --git a/docs/capabilities/devvit-web/devvit_web_overview.mdx b/docs/capabilities/devvit-web/devvit_web_overview.mdx index b208d4e6..ba81c7f4 100644 --- a/docs/capabilities/devvit-web/devvit_web_overview.mdx +++ b/docs/capabilities/devvit-web/devvit_web_overview.mdx @@ -12,8 +12,8 @@ Devvit Web allows developers to build Devvit apps just like you would for the we - **Server endpoints** that you define to communicate between the webview client and the Devvit server, using industry-standard frameworks and technologies (like Express.js, Hono, Koa, etc.). - **Devvit configuration** with a traditional client/server split. Devvit capabilities are now in one of three places: - A configuration file in devvit.json for defining app metadata, permissions, and capabilities - - Client capabilities in the @devvit/client SDK - - Server capabilities, like Redis and Reddit API with the @devvit/server SDK + - Client capabilities in the `@devvit/web/client` SDK + - Server capabilities, like Redis and Reddit API, in the `@devvit/web/server` SDK With Devvit Web, you have continued access to our hosting services, key capabilities like Redis and Reddit API, standard web technologies, and a typical client/server pattern to build your apps. @@ -81,7 +81,9 @@ This folder includes server-side code. We provide a node server, and you can use We also provide an authentication middleware so you don’t have to worry about authentication. :::note -All server endpoints must start with `/api/` (e.g. `/api/get-something` or `/api/widgets/42`). +Use `/api/` for client-facing endpoints that your webview calls with `fetch()`. + +Use `/internal/` for Devvit-managed handlers declared in `devvit.json`, such as menu actions, forms, triggers, scheduler tasks, settings validation, and payments endpoints. ::: { // Incorrect: cannot fetch external domains from client-side // const response = await fetch('https://external-api.com/data'); -// Incorrect: endpoint must end with /api +// Incorrect: client-side fetches should target your own /api/... endpoints // const response = await fetch('/user-data'); ``` diff --git a/docs/capabilities/server/overview.md b/docs/capabilities/server/overview.md index fdd17182..5968cd49 100644 --- a/docs/capabilities/server/overview.md +++ b/docs/capabilities/server/overview.md @@ -14,7 +14,7 @@ Allows you to build apps where the end user can upload custom images to Reddit's ## [Reddit API](./reddit-api.mdx) -Allows you to query information from Reddit such as comments, posts and upvotes. Limited to installation scope of the application. +Allows you to query information from Reddit such as comments, posts, moderation state, and other community data. Limited to the installation scope of the application. ## [Data storage (Redis)](./redis.mdx) diff --git a/docs/capabilities/server/reddit-api.mdx b/docs/capabilities/server/reddit-api.mdx index a2b32781..fc867ccd 100644 --- a/docs/capabilities/server/reddit-api.mdx +++ b/docs/capabilities/server/reddit-api.mdx @@ -1,6 +1,6 @@ # Reddit API Overview -The Reddit API allows you to read and write Reddit content such as posts / comments / upvotes, in order to integrate your app's behavior with the content of the community it's installed in. +The Reddit API allows you to read and write Reddit content such as posts, comments, and moderation actions so your app can integrate with the community where it is installed. :::note Unlike traditional Reddit API usage, you don't need to create an app at [reddit.com/prefs/apps](https://www.reddit.com/prefs/apps) or manage API keys. Devvit handles authentication automatically when you enable the `reddit` permission in your app. @@ -30,7 +30,7 @@ Here's how to obtain a reference to the Reddit client ``` ```ts title="server/index.ts" -import { reddit } from '@devvit/reddit'; +import { reddit } from '@devvit/web/server'; ``` ## Reddit Thing IDs @@ -62,7 +62,6 @@ const parentId = comment.parentId; // 't3_abc123' or 't1_def456' ### Submitting a post ```ts -import { Devvit } from '@devvit/public-api'; import { context, reddit } from '@devvit/web/server'; export const createPost = async () => { @@ -99,7 +98,7 @@ export const createComment = async () => { } reddit.submitComment({ - postId: 't3_123456', // Replace with the actual post ID + id: 't3_123456', // Replace with the actual post or comment ID text: 'This is a comment from a Devvit app', runAs: 'USER' // Optional: specify the user to run as }); diff --git a/docs/capabilities/server/triggers.mdx b/docs/capabilities/server/triggers.mdx index 409a6d18..3f7d5671 100644 --- a/docs/capabilities/server/triggers.mdx +++ b/docs/capabilities/server/triggers.mdx @@ -28,12 +28,12 @@ Event triggers let your app automatically respond to a user's or moderator's act - `onPostSpoilerUpdate` - `onAppInstall` - `onAppUpgrade` -- `onModActions` +- `onModAction` - `onModMail` - `onAutomoderatorFilterPost` - `onAutomoderatorFilterComment` -A full list of events and their payloads can be found in the [EventTypes documentation](../../api/public-api/@devvit/namespaces/EventTypes/). For more details on Mod specific actions, see [ModActions](../../api/redditapi/models/interfaces/ModAction) and [ModMail](../../api/public-api/type-aliases/ModMailDefinition). +A full list of events and their payloads can be found in the [EventTypes documentation](../../api/public-api/@devvit/namespaces/EventTypes/). In `devvit.json`, use the trigger key `onModAction`; the underlying trigger event type is documented as `ModAction`. For more details on mod-specific actions, see [ModActions](../../api/redditapi/models/interfaces/ModAction) and [ModMail](../../api/public-api/type-aliases/ModMailDefinition). ## Setting up triggers diff --git a/docs/capabilities/server/userActions.mdx b/docs/capabilities/server/userActions.mdx index 580e2818..9fcdd529 100644 --- a/docs/capabilities/server/userActions.mdx +++ b/docs/capabilities/server/userActions.mdx @@ -3,7 +3,7 @@ import TabItem from '@theme/TabItem'; # User Actions -User actions allow your app to submit posts, submit comments, and subscribe to the current subreddit on behalf of the logged in user. These actions occur on the logged in user's account instead of the app account. This enables stronger user engagement while ensuring user control and transparency. +User actions allow your app to submit posts, submit comments, and, with manual Reddit approval, subscribe to the current subreddit on behalf of the logged in user. These actions occur on the logged in user's account instead of the app account. This enables stronger user engagement while ensuring user control and transparency. --- @@ -12,7 +12,7 @@ User actions allow your app to submit posts, submit comments, and subscribe to t By default, apps make posts or comments using their associated app account. With user actions enabled, your app can: - Create posts or comments on behalf of the user (from the post UI, a form, or a menu action) -- Subscribe the user to the current subreddit +- Subscribe the user to the current subreddit after manual Reddit approval Some actions are not available to apps to prevent abuse and maintain platform integrity: @@ -73,7 +73,7 @@ To enable user actions, add the required permissions to your `devvit.json`: After enabling, you can call certain Reddit APIs on behalf of the user by passing the option `runAs: 'USER'`. The following APIs support this option: - [submitPost()](../../api/redditapi/RedditAPIClient/classes/RedditAPIClient.md#submitpost) -- [submitCustomPost()](../../api/redditapi/RedditAPIClient/classes/RedditAPIClient.md) +- [submitCustomPost()](../../api/redditapi/RedditAPIClient/classes/RedditAPIClient.md#submitcustompost) - [submitComment()](../../api/redditapi/RedditAPIClient/classes/RedditAPIClient.md#submitcomment) If `runAs` is not specified, the API will use `runAs: 'APP'` by default. @@ -110,7 +110,7 @@ Your app version needs to be approved in order for user actions to be enabled fo ```tsx title="server/index.ts" -import { reddit } from '@devvit/web/server'; +import { context, reddit } from '@devvit/web/server'; // ... @@ -138,7 +138,7 @@ app.post('/internal/post-create', async (c) => { ```tsx title="server/index.ts" -import { reddit } from '@devvit/web/server'; +import { context, reddit } from '@devvit/web/server'; // ... @@ -170,7 +170,7 @@ router.post('/internal/post-create', async (_req, res) => { ## Example: Subscribe to current subreddit -The [subscribeToCurrentSubreddit()](../../api/redditapi/RedditAPIClient/classes/RedditAPIClient.md#subscribetocurrentsubreddit) API does not take a `runAs` parameter; it subscribes as the user by default (if specified in `devvit.json` and approved). +The [subscribeToCurrentSubreddit()](../../api/redditapi/RedditAPIClient/classes/RedditAPIClient.md#subscribetocurrentsubreddit) API does not take a `runAs` parameter. This API still requires manual approval from Reddit before it can subscribe on behalf of the user. . +1. Run `devvit playtest `. +2. If your app does not already have a playtest subreddit, Devvit will automatically create one for you. Once you start a playtest session, a new pre-release version of your app is automatically created and installed on your test subreddit. The pre-release version has a fourth decimal place, so if your current app is 0.0.1, the first pre-release version will be 0.0.1.1. diff --git a/docs/examples/tutorials/mod-tool.md b/docs/examples/tutorials/mod-tool.md index 63ad5dc3..c3ee53ab 100644 --- a/docs/examples/tutorials/mod-tool.md +++ b/docs/examples/tutorials/mod-tool.md @@ -2,4 +2,14 @@ slug: /examples/tutorials/mod-tool --- -# Build a Mod Tool - Three Strikes +# Build a Mod Tool + +The older Three Strikes tutorial has been replaced by the current Devvit Web mod-tool path. + +If you're building a new moderator workflow today, start with: + +- [Quickstart for Mod Tools](../../quickstart/quickstart-mod-tool.md) +- [Template library](../template-library.md) +- [Mod Resources](../../guides/best-practices/mod_resources.md) + +The current mod-tool quickstart walks through building Comment Mop, a moderator-only menu action that removes or locks a full comment tree. diff --git a/docs/guides/faq.mdx b/docs/guides/faq.mdx index bacc0cd9..1adb4da2 100644 --- a/docs/guides/faq.mdx +++ b/docs/guides/faq.mdx @@ -26,6 +26,8 @@ If you are building an external script, bot, or website outside Devvit, that is The fastest path is the [App quickstart](../quickstart/quickstart.md), which walks you through creating a project, connecting your Reddit account, and starting a playtest environment. +If you already know you are building a moderator workflow, start with [Quickstart for Mod Tools](../quickstart/quickstart-mod-tool.md) instead of the general app quickstart. + If you already know which kind of app you want to build, you can also start with: - [Quickstart for Games](../quickstart/quickstart.md) @@ -67,6 +69,8 @@ Not completely. Devvit apps run against Reddit, so the normal development flow u The quickstart uses `npm run dev`, which starts a Devvit playtest session for you. If you need more control over that flow, see [Playtest](./tools/playtest.md). +You do not need to run `upload` before starting a normal playtest session. + If you are wondering why a purely local setup is not enough, the quickstart calls this out directly: backend calls do not work when you test the app only locally. diff --git a/docs/guides/tools/devvit_cli.mdx b/docs/guides/tools/devvit_cli.mdx index fe985951..4f8baf94 100644 --- a/docs/guides/tools/devvit_cli.mdx +++ b/docs/guides/tools/devvit_cli.mdx @@ -248,6 +248,8 @@ $ npx devvit new --here Installs your app to your test subreddit and starts a playtest session. A new version of your app is installed whenever you save changes to your app code, and logs are continuously streamed. Press `ctrl+c` to end the playtest session. Once ended, the latest installed version will remain unless you revert to a previous version using [`devvit install`](#devvit-install). For more information, see the [playtest page](playtest.md). +You do not need to run `devvit upload` before using `devvit playtest`. + #### Usage ```bash @@ -335,7 +337,7 @@ $ npx devvit update app ### devvit upload -Upload an app to the App directory. By default the app is private and visible only to you. +Upload an app to the App directory as a private build. By default the app is private and visible only to you. This command is not required for playtest. #### Usage @@ -353,6 +355,42 @@ $ npx devvit upload [--bump major|minor|patch|prerelease] [--copyPaste] Copy-paste the auth code instead of opening a browser +### devvit publish + +Submit an app version for Reddit review. Use this when you are ready to launch an app beyond your private development flow. + +#### Usage + +```bash +$ npx devvit publish [--bump major|minor|patch] [--version ] [--public] +``` + +#### Optional arguments + +- `--bump