@devvit/public-api 0.12.0-next-2025-04-10-a27f59c35.0 → 0.12.0-next-2025-04-10-eddbfb660.0

package/apis/reddit/RedditAPIClient.d.ts

@@ -33,8 +33,8 @@ export type MuteUserOptions = {
 
  * // 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({
+ *     const subreddit = await getSubredditById(context.subredditId);
+ *     submitPost({
  *       subredditName: subreddit.name,
  *       title: 'test post',
  *       text: 'test body',
@@ -51,7 +51,7 @@ export declare class _RedditAPIClient {
      *
      * @example
      * ```ts
-     * await reddit.modMail.reply({
+     * await modMail().reply({
      *   body: "Here is my message",
      *   conversationId: "abcd42";
      * })
@@ -66,7 +66,7 @@ export declare class _RedditAPIClient {
      * @returns {Promise<Subreddit>} A Promise that resolves a Subreddit object.
      * @example
      * ```ts
-     * const memes = await reddit.getSubredditById('t5_2qjpg');
+     * const memes = await getSubredditById('t5_2qjpg');
      * ```
      */
     getSubredditById(id: string): Promise<Subreddit | undefined>;
@@ -77,7 +77,7 @@ export declare class _RedditAPIClient {
      * @returns {Promise<SubredditInfo>} A Promise that resolves a SubredditInfo object.
      * @example
      * ```ts
-     * const memes = await reddit.getSubredditInfoById('t5_2qjpg');
+     * const memes = await getSubredditInfoById('t5_2qjpg');
      * ```
      */
     getSubredditInfoById(id: string): Promise<SubredditInfo>;
@@ -89,7 +89,7 @@ export declare class _RedditAPIClient {
      * @returns {Promise<Subreddit>} A Promise that resolves a Subreddit object.
      * @example
      * ```ts
-     * const askReddit = await reddit.getSubredditByName('askReddit');
+     * const askReddit = await getSubredditByName('askReddit');
      * ```
      */
     getSubredditByName(name: string): Promise<Subreddit>;
@@ -100,7 +100,7 @@ export declare class _RedditAPIClient {
      * @returns {Promise<SubredditInfo>} A Promise that resolves a SubredditInfo object.
      * @example
      * ```ts
-     * const askReddit = await reddit.getSubredditInfoByName('askReddit');
+     * const askReddit = await getSubredditInfoByName('askReddit');
      * ```
      */
     getSubredditInfoByName(name: string): Promise<SubredditInfo>;
@@ -113,7 +113,7 @@ export declare class _RedditAPIClient {
      * @param options.message The message associated with the removal reason.
      * @example
      * ```ts
-     * const newReason = await reddit.addSubredditRemovalReasons(
+     * const newReason = await addSubredditRemovalReasons(
      *   'askReddit',
      *   {
      *     title: 'Spam',
@@ -135,7 +135,7 @@ export declare class _RedditAPIClient {
      * @param subredditName
      * @example
      * ```ts
-     * const reasons = await reddit.getSubredditRemovalReasons('askReddit');
+     * const reasons = await getSubredditRemovalReasons('askReddit');
      *
      * for (let reason of reasons) {
      *   console.log(reason.id, reason.message, reason.title)
@@ -151,7 +151,7 @@ export declare class _RedditAPIClient {
      * @returns {Promise<string>} A Promise that resolves a string representing the current subreddit's name.
      * @example
      * ```ts
-     * const currentSubredditName = await reddit.getCurrentSubredditName();
+     * const currentSubredditName = await getCurrentSubredditName();
      * ```
      */
     getCurrentSubredditName(): Promise<string>;
@@ -161,7 +161,7 @@ export declare class _RedditAPIClient {
      * @returns {Promise<Subreddit>} A Promise that resolves a Subreddit object.
      * @example
      * ```ts
-     * const currentSubreddit = await reddit.getCurrentSubreddit();
+     * const currentSubreddit = await getCurrentSubreddit();
      * ```
      */
     getCurrentSubreddit(): Promise<Subreddit>;
@@ -179,7 +179,7 @@ export declare class _RedditAPIClient {
      * @returns A Promise that resolves to a Post object.
      * @example
      * ```ts
-     * const post = await reddit.submitPost({
+     * const post = await submitPost({
      *   subredditName: 'devvit',
      *   title: 'Hello World',
      *   richtext: new RichTextBuilder()
@@ -197,14 +197,14 @@ export declare class _RedditAPIClient {
      * ```ts
      * import { RunAs } from '@devvit/public-api';
      *
-     * const post = await reddit.submitPost({
+     * const post = await submitPost({
      *  title: 'My Devvit Post',
      *  runAs: 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(),
+     *  subredditName: await getCurrentSubredditName(),
      *  textFallback: {
      *    text: 'This is a Devvit post!',
      *  },
@@ -234,7 +234,7 @@ export declare class _RedditAPIClient {
      * @returns A Promise that resolves to a User object.
      * @example
      * ```ts
-     * const user = await reddit.getUserById('t2_1qjpg');
+     * const user = await getUserById('t2_1qjpg');
      * ```
      */
     getUserById(id: string): Promise<User | undefined>;
@@ -246,7 +246,7 @@ export declare class _RedditAPIClient {
      *          not found (user doesn't exist, account suspended, etc).
      * @example
      * ```ts
-     * const user = await reddit.getUserByUsername('devvit');
+     * const user = await getUserByUsername('devvit');
      * if (user) {
      *   console.log(user)
      * }
@@ -260,7 +260,7 @@ export declare class _RedditAPIClient {
      * @returns A Promise that resolves to a string representing the username or undefined
      * @example
      * ```ts
-     * const username = await reddit.getCurrentUsername();
+     * const username = await getCurrentUsername();
      * ```
      */
     getCurrentUsername(): Promise<string | undefined>;
@@ -271,7 +271,7 @@ export declare class _RedditAPIClient {
      * @returns A Promise that resolves to a User object or undefined
      * @example
      * ```ts
-     * const user = await reddit.getCurrentUser();
+     * const user = await getCurrentUser();
      * ```
      */
     getCurrentUser(): Promise<User | undefined>;
@@ -281,7 +281,7 @@ export declare class _RedditAPIClient {
      * @returns A Promise that resolves to a User object.
      * @example
      * ```ts
-     * const user = await reddit.getAppUser(metadata);
+     * const user = await getAppUser(metadata);
      * ```
      */
     getAppUser(): Promise<User>;
@@ -299,7 +299,7 @@ export declare class _RedditAPIClient {
      * @returns A Promise that resolves to a Comment object.
      * @example
      * ```ts
-     * const comment = await reddit.getCommentById('t1_1qjpg');
+     * const comment = await getCommentById('t1_1qjpg');
      * ```
      */
     getCommentById(id: string): Promise<Comment>;
@@ -315,7 +315,7 @@ export declare class _RedditAPIClient {
      * @returns A Listing of Comment objects.
      * @example
      * ```ts
-     * const comments = await reddit.getComments({
+     * const comments = await getComments({
      *   postId: 't3_1qjpg',
      *   limit: 1000,
      *   pageSize: 100
@@ -348,7 +348,7 @@ export declare class _RedditAPIClient {
      * ```ts
      * import { RunAs } from '@devvit/public-api';
      *
-     * const comment = await reddit.submitComment({
+     * const comment = await submitComment({
      *  id: 't1_1qgif',
      *  text: 'Hello world!',
      *  runAs: RunAs.APP,
@@ -369,7 +369,7 @@ export declare class _RedditAPIClient {
      * @returns A Listing of Post objects.
      * @example
      * ```ts
-     * const posts = await reddit.getControversialPosts({
+     * const posts = await getControversialPosts({
      *   subredditName: 'memes',
      *   timeframe: 'day',
      *   limit: 1000,
@@ -389,7 +389,7 @@ export declare class _RedditAPIClient {
      * @returns A Listing of Post objects.
      * @example
      * ```ts
-     * const posts = await reddit.getControversialPosts({
+     * const posts = await getControversialPosts({
      *   subredditName: 'memes',
      *   timeframe: 'day',
      *   limit: 1000,
@@ -409,7 +409,7 @@ export declare class _RedditAPIClient {
      * @returns A Listing of Post objects.
      * @example
      * ```ts
-     * const posts = await reddit.getHotPosts({
+     * const posts = await getHotPosts({
      *   subredditName: 'memes',
      *   timeframe: 'day',
      *   limit: 1000,
@@ -428,7 +428,7 @@ export declare class _RedditAPIClient {
      * @returns A Listing of Post objects.
      * @example
      * ```ts
-     * const posts = await reddit.getNewPosts({
+     * const posts = await getNewPosts({
      *   subredditName: 'memes',
      *   limit: 1000,
      *   pageSize: 100
@@ -447,7 +447,7 @@ export declare class _RedditAPIClient {
      * @returns A Listing of Post objects.
      * @example
      * ```ts
-     * const posts = await reddit.getRisingPosts({
+     * const posts = await getRisingPosts({
      *   subredditName: 'memes',
      *   timeframe: 'day',
      *   limit: 1000,
@@ -492,7 +492,7 @@ export declare class _RedditAPIClient {
      * @returns A Listing of ModAction objects.
      * @example
      * ```ts
-     * const modActions = await reddit.getModerationLog({
+     * const modActions = await getModerationLog({
      *   subredditName: 'memes',
      *   moderatorUsernames: ['spez'],
      *   type: 'banuser',
@@ -741,8 +741,8 @@ export declare class _RedditAPIClient {
      * @param id - The id of the post (t3_) or comment (t1_) to approve.
      * @example
      * ```ts
-     * await reddit.approve('t3_123456');
-     * await reddit.approve('t1_123456');
+     * await approve('t3_123456');
+     * await approve('t1_123456');
      * ```
      */
     approve(id: string): Promise<void>;
@@ -753,8 +753,8 @@ export declare class _RedditAPIClient {
      * @param isSpam - Is the post or comment being removed because it's spam?
      * @example
      * ```ts
-     * await reddit.remove('t3_123456', false);
-     * await reddit.remove('t1_123456', true);
+     * await remove('t3_123456', false);
+     * await remove('t1_123456', true);
      * ```
      */
     remove(id: string, isSpam: boolean): Promise<void>;
@@ -1019,7 +1019,7 @@ export declare class _RedditAPIClient {
      *
      * @example
      * ```ts
-     * await reddit.report(post, {
+     * await report(post, {
      *  reason: 'This is spam!',
      * })
      * ```
@@ -1034,7 +1034,7 @@ export declare class _RedditAPIClient {
      *
      * @example
      * ```ts
-     * const subreddit = await reddit.getSubredditByName("mysubreddit")
+     * const subreddit = await getSubredditByName("mysubreddit")
      * let listing = await subreddit.getModQueue();
      * console.log("Posts and Comments: ",  await listing.all())
      * listing = await subreddit.getModQueue({ type: "post"});
@@ -1051,7 +1051,7 @@ export declare class _RedditAPIClient {
      *
      * @example
      * ```ts
-     * const subreddit = await reddit.getSubredditByName("mysubreddit")
+     * const subreddit = await getSubredditByName("mysubreddit")
      * let listing = await subreddit.getReports();
      * console.log("Posts and Comments: ", await listing.all())
      * listing = await subreddit.getReports({ type: "post"});
@@ -1068,7 +1068,7 @@ export declare class _RedditAPIClient {
      *
      * @example
      * ```ts
-     * const subreddit = await reddit.getSubredditByName("mysubreddit")
+     * const subreddit = await getSubredditByName("mysubreddit")
      * let listing = await subreddit.getSpam();
      * console.log("Posts and Comments: ", await listing.all())
      * listing = await subreddit.getSpam({ type: "post"});
@@ -1085,7 +1085,7 @@ export declare class _RedditAPIClient {
      *
      * @example
      * ```ts
-     * const subreddit = await reddit.getSubredditByName("mysubreddit")
+     * const subreddit = await getSubredditByName("mysubreddit")
      * let listing = await subreddit.getUnmoderated();
      * console.log("Posts and Comments: ", await listing.all())
      * listing = await subreddit.getUnmoderated({ type: "post"});
@@ -1102,7 +1102,7 @@ export declare class _RedditAPIClient {
      *
      * @example
      * ```ts
-     * const subreddit = await reddit.getSubredditByName("mysubreddit")
+     * const subreddit = await getSubredditByName("mysubreddit")
      * let listing = await subreddit.getEdited();
      * console.log("Posts and Comments: ", await listing.all())
      * listing = await subreddit.getEdited({ type: "post"});
@@ -1118,7 +1118,7 @@ export declare class _RedditAPIClient {
      * @param {string} address - The address (starting with 0x) of the Vault.
      * @example
      * ```ts
-     * const vault = await reddit.getVaultByAddress('0x205ee28744456bDBf180A0Fa7De51e0F116d54Ed');
+     * const vault = await getVaultByAddress('0x205ee28744456bDBf180A0Fa7De51e0F116d54Ed');
      * ```
      */
     getVaultByAddress(address: string): Promise<Vault>;
@@ -1128,7 +1128,7 @@ export declare class _RedditAPIClient {
      * @param {string} userId - The ID (starting with t2_) of the Vault owner.
      * @example
      * ```ts
-     * const vault = await reddit.getVaultByUserId('t2_1w72');
+     * const vault = await getVaultByUserId('t2_1w72');
      * ```
      */
     getVaultByUserId(userId: string): Promise<Vault>;

package/apis/reddit/RedditAPIClient.js

@@ -31,8 +31,8 @@ import { getVaultByAddress, getVaultByUserId } from './models/Vault.js';
 
  * // 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({
+ *     const subreddit = await getSubredditById(context.subredditId);
+ *     submitPost({
  *       subredditName: subreddit.name,
  *       title: 'test post',
  *       text: 'test body',
@@ -55,7 +55,7 @@ export class _RedditAPIClient {
      *
      * @example
      * ```ts
-     * await reddit.modMail.reply({
+     * await modMail().reply({
      *   body: "Here is my message",
      *   conversationId: "abcd42";
      * })
@@ -72,7 +72,7 @@ export class _RedditAPIClient {
      * @returns {Promise<Subreddit>} A Promise that resolves a Subreddit object.
      * @example
      * ```ts
-     * const memes = await reddit.getSubredditById('t5_2qjpg');
+     * const memes = await getSubredditById('t5_2qjpg');
      * ```
      */
     getSubredditById(id) {
@@ -85,7 +85,7 @@ export class _RedditAPIClient {
      * @returns {Promise<SubredditInfo>} A Promise that resolves a SubredditInfo object.
      * @example
      * ```ts
-     * const memes = await reddit.getSubredditInfoById('t5_2qjpg');
+     * const memes = await getSubredditInfoById('t5_2qjpg');
      * ```
      */
     getSubredditInfoById(id) {
@@ -99,7 +99,7 @@ export class _RedditAPIClient {
      * @returns {Promise<Subreddit>} A Promise that resolves a Subreddit object.
      * @example
      * ```ts
-     * const askReddit = await reddit.getSubredditByName('askReddit');
+     * const askReddit = await getSubredditByName('askReddit');
      * ```
      */
     getSubredditByName(name) {
@@ -112,7 +112,7 @@ export class _RedditAPIClient {
      * @returns {Promise<SubredditInfo>} A Promise that resolves a SubredditInfo object.
      * @example
      * ```ts
-     * const askReddit = await reddit.getSubredditInfoByName('askReddit');
+     * const askReddit = await getSubredditInfoByName('askReddit');
      * ```
      */
     getSubredditInfoByName(name) {
@@ -127,7 +127,7 @@ export class _RedditAPIClient {
      * @param options.message The message associated with the removal reason.
      * @example
      * ```ts
-     * const newReason = await reddit.addSubredditRemovalReasons(
+     * const newReason = await addSubredditRemovalReasons(
      *   'askReddit',
      *   {
      *     title: 'Spam',
@@ -148,7 +148,7 @@ export class _RedditAPIClient {
      * @param subredditName
      * @example
      * ```ts
-     * const reasons = await reddit.getSubredditRemovalReasons('askReddit');
+     * const reasons = await getSubredditRemovalReasons('askReddit');
      *
      * for (let reason of reasons) {
      *   console.log(reason.id, reason.message, reason.title)
@@ -166,7 +166,7 @@ export class _RedditAPIClient {
      * @returns {Promise<string>} A Promise that resolves a string representing the current subreddit's name.
      * @example
      * ```ts
-     * const currentSubredditName = await reddit.getCurrentSubredditName();
+     * const currentSubredditName = await getCurrentSubredditName();
      * ```
      */
     async getCurrentSubredditName() {
@@ -187,7 +187,7 @@ export class _RedditAPIClient {
      * @returns {Promise<Subreddit>} A Promise that resolves a Subreddit object.
      * @example
      * ```ts
-     * const currentSubreddit = await reddit.getCurrentSubreddit();
+     * const currentSubreddit = await getCurrentSubreddit();
      * ```
      */
     async getCurrentSubreddit() {
@@ -213,7 +213,7 @@ export class _RedditAPIClient {
      * @returns A Promise that resolves to a Post object.
      * @example
      * ```ts
-     * const post = await reddit.submitPost({
+     * const post = await submitPost({
      *   subredditName: 'devvit',
      *   title: 'Hello World',
      *   richtext: new RichTextBuilder()
@@ -231,14 +231,14 @@ export class _RedditAPIClient {
      * ```ts
      * import { RunAs } from '@devvit/public-api';
      *
-     * const post = await reddit.submitPost({
+     * const post = await submitPost({
      *  title: 'My Devvit Post',
      *  runAs: 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(),
+     *  subredditName: await getCurrentSubredditName(),
      *  textFallback: {
      *    text: 'This is a Devvit post!',
      *  },
@@ -272,7 +272,7 @@ export class _RedditAPIClient {
      * @returns A Promise that resolves to a User object.
      * @example
      * ```ts
-     * const user = await reddit.getUserById('t2_1qjpg');
+     * const user = await getUserById('t2_1qjpg');
      * ```
      */
     getUserById(id) {
@@ -286,7 +286,7 @@ export class _RedditAPIClient {
      *          not found (user doesn't exist, account suspended, etc).
      * @example
      * ```ts
-     * const user = await reddit.getUserByUsername('devvit');
+     * const user = await getUserByUsername('devvit');
      * if (user) {
      *   console.log(user)
      * }
@@ -302,7 +302,7 @@ export class _RedditAPIClient {
      * @returns A Promise that resolves to a string representing the username or undefined
      * @example
      * ```ts
-     * const username = await reddit.getCurrentUsername();
+     * const username = await getCurrentUsername();
      * ```
      */
     async getCurrentUsername() {
@@ -316,7 +316,7 @@ export class _RedditAPIClient {
      * @returns A Promise that resolves to a User object or undefined
      * @example
      * ```ts
-     * const user = await reddit.getCurrentUser();
+     * const user = await getCurrentUser();
      * ```
      */
     async getCurrentUser() {
@@ -329,7 +329,7 @@ export class _RedditAPIClient {
      * @returns A Promise that resolves to a User object.
      * @example
      * ```ts
-     * const user = await reddit.getAppUser(metadata);
+     * const user = await getAppUser(metadata);
      * ```
      */
     getAppUser() {
@@ -351,7 +351,7 @@ export class _RedditAPIClient {
      * @returns A Promise that resolves to a Comment object.
      * @example
      * ```ts
-     * const comment = await reddit.getCommentById('t1_1qjpg');
+     * const comment = await getCommentById('t1_1qjpg');
      * ```
      */
     getCommentById(id) {
@@ -369,7 +369,7 @@ export class _RedditAPIClient {
      * @returns A Listing of Comment objects.
      * @example
      * ```ts
-     * const comments = await reddit.getComments({
+     * const comments = await getComments({
      *   postId: 't3_1qjpg',
      *   limit: 1000,
      *   pageSize: 100
@@ -406,7 +406,7 @@ export class _RedditAPIClient {
      * ```ts
      * import { RunAs } from '@devvit/public-api';
      *
-     * const comment = await reddit.submitComment({
+     * const comment = await submitComment({
      *  id: 't1_1qgif',
      *  text: 'Hello world!',
      *  runAs: RunAs.APP,
@@ -430,7 +430,7 @@ export class _RedditAPIClient {
      * @returns A Listing of Post objects.
      * @example
      * ```ts
-     * const posts = await reddit.getControversialPosts({
+     * const posts = await getControversialPosts({
      *   subredditName: 'memes',
      *   timeframe: 'day',
      *   limit: 1000,
@@ -452,7 +452,7 @@ export class _RedditAPIClient {
      * @returns A Listing of Post objects.
      * @example
      * ```ts
-     * const posts = await reddit.getControversialPosts({
+     * const posts = await getControversialPosts({
      *   subredditName: 'memes',
      *   timeframe: 'day',
      *   limit: 1000,
@@ -474,7 +474,7 @@ export class _RedditAPIClient {
      * @returns A Listing of Post objects.
      * @example
      * ```ts
-     * const posts = await reddit.getHotPosts({
+     * const posts = await getHotPosts({
      *   subredditName: 'memes',
      *   timeframe: 'day',
      *   limit: 1000,
@@ -495,7 +495,7 @@ export class _RedditAPIClient {
      * @returns A Listing of Post objects.
      * @example
      * ```ts
-     * const posts = await reddit.getNewPosts({
+     * const posts = await getNewPosts({
      *   subredditName: 'memes',
      *   limit: 1000,
      *   pageSize: 100
@@ -516,7 +516,7 @@ export class _RedditAPIClient {
      * @returns A Listing of Post objects.
      * @example
      * ```ts
-     * const posts = await reddit.getRisingPosts({
+     * const posts = await getRisingPosts({
      *   subredditName: 'memes',
      *   timeframe: 'day',
      *   limit: 1000,
@@ -567,7 +567,7 @@ export class _RedditAPIClient {
      * @returns A Listing of ModAction objects.
      * @example
      * ```ts
-     * const modActions = await reddit.getModerationLog({
+     * const modActions = await getModerationLog({
      *   subredditName: 'memes',
      *   moderatorUsernames: ['spez'],
      *   type: 'banuser',
@@ -948,8 +948,8 @@ export class _RedditAPIClient {
      * @param id - The id of the post (t3_) or comment (t1_) to approve.
      * @example
      * ```ts
-     * await reddit.approve('t3_123456');
-     * await reddit.approve('t1_123456');
+     * await approve('t3_123456');
+     * await approve('t1_123456');
      * ```
      */
     async approve(id) {
@@ -968,8 +968,8 @@ export class _RedditAPIClient {
      * @param isSpam - Is the post or comment being removed because it's spam?
      * @example
      * ```ts
-     * await reddit.remove('t3_123456', false);
-     * await reddit.remove('t1_123456', true);
+     * await remove('t3_123456', false);
+     * await remove('t1_123456', true);
      * ```
      */
     async remove(id, isSpam) {
@@ -1296,7 +1296,7 @@ export class _RedditAPIClient {
      *
      * @example
      * ```ts
-     * await reddit.report(post, {
+     * await report(post, {
      *  reason: 'This is spam!',
      * })
      * ```
@@ -1346,7 +1346,7 @@ export class _RedditAPIClient {
      * @param {string} address - The address (starting with 0x) of the Vault.
      * @example
      * ```ts
-     * const vault = await reddit.getVaultByAddress('0x205ee28744456bDBf180A0Fa7De51e0F116d54Ed');
+     * const vault = await getVaultByAddress('0x205ee28744456bDBf180A0Fa7De51e0F116d54Ed');
      * ```
      */
     getVaultByAddress(address) {
@@ -1358,7 +1358,7 @@ export class _RedditAPIClient {
      * @param {string} userId - The ID (starting with t2_) of the Vault owner.
      * @example
      * ```ts
-     * const vault = await reddit.getVaultByUserId('t2_1w72');
+     * const vault = await getVaultByUserId('t2_1w72');
      * ```
      */
     getVaultByUserId(userId) {

package/apis/reddit/models/Flair.js

@@ -178,7 +178,7 @@ export class Flair {
      *
      * @example
      * ```ts
-     * const response = await reddit.flair.getUserFlairBySubreddit({
+     * const response = await flair.getUserFlairBySubreddit({
      *      subreddit: "EyeBleach",
      *      name: "badapple"
      *   },