@devvit/public-api 0.10.23 → 0.10.24-next-2024-08-08-4d6152bee.0

package/public-api.d.ts

@@ -4768,6 +4768,8 @@ export declare class Comment {
     get stickied(): boolean;
     get removed(): boolean;
     get approved(): boolean;
+    get approvedAtUtc(): number;
+    get bannedAtUtc(): number;
     get spam(): boolean;
     get edited(): boolean;
     get numReports(): number;
@@ -4792,7 +4794,7 @@ export declare class Comment {
     lock(): Promise<void>;
     unlock(): Promise<void>;
     reply(options: ReplyToCommentOptions): Promise<Comment>;
-    getAuthor(): Promise<User>;
+    getAuthor(): Promise<User | undefined>;
     distinguish(makeSticky?: boolean): Promise<void>;
     distinguishAsAdmin(makeSticky?: boolean): Promise<void>;
     undistinguish(): Promise<void>;
@@ -6372,7 +6374,7 @@ export declare type CreateFlairTemplateOptions = {
 };
 
 export declare type CreateModNoteOptions = Prettify<PostNotesRequest & {
-    redditId: T1ID | T3ID;
+    redditId?: T1ID | T3ID;
     label: UserNoteLabel;
 }>;
 
@@ -39639,6 +39641,8 @@ export declare class Post {
     get numberOfComments(): number;
     get numberOfReports(): number;
     get approved(): boolean;
+    get approvedAtUtc(): number;
+    get bannedAtUtc(): number;
     get spam(): boolean;
     get stickied(): boolean;
     get removed(): boolean;
@@ -39708,7 +39712,7 @@ export declare class Post {
     undistinguish(): Promise<void>;
     ignoreReports(): Promise<void>;
     unignoreReports(): Promise<void>;
-    getAuthor(): Promise<User>;
+    getAuthor(): Promise<User | undefined>;
     crosspost(options: Omit<CrosspostOptions, 'postId'>): Promise<Post>;
     /**
      * Add a mod note for why the post was removed
@@ -43541,7 +43545,7 @@ export declare class RedditAPIClient {
      * const user = await reddit.getUserById('t2_1qjpg');
      * ```
      */
-    getUserById(id: string): Promise<User>;
+    getUserById(id: string): Promise<User | undefined>;
     getCollectionById(collectionId: string): Promise<PostCollection>;
     createCollection(options: CreateCollectionInput): Promise<PostCollection>;
     getCollectionsForSubreddit(subredditId: string): Promise<PostCollection[]>;
@@ -43549,13 +43553,17 @@ export declare class RedditAPIClient {
      * Gets a {@link User} object by username
      *
      * @param username - The username of the user omitting the u/. e.g. 'devvit'
-     * @returns A Promise that resolves to a User object.
+     * @returns A Promise that resolves to a User object or undefined if user is
+     *          not found (user doesn't exist, account suspended, etc).
      * @example
      * ```ts
      * const user = await reddit.getUserByUsername('devvit');
+     * if (user) {
+     *   console.log(user)
+     * }
      * ```
      */
-    getUserByUsername(username: string): Promise<User>;
+    getUserByUsername(username: string): Promise<User | undefined>;
     /**
      * Get the current calling user based on the provided metadata.
      * Resolves to undefined for logged-out custom post renders.
@@ -43990,7 +43998,7 @@ export declare class RedditAPIClient {
      * @param options - Options for the request
      * @param options.subreddit - The name of the subreddit to add the mod note to. e.g. 'memes'
      * @param options.user - The username of the user to add the mod note to. e.g. 'spez'
-     * @param options.redditId - The ID of the comment or post to add the mod note to. e.g. 't3_1234'
+     * @param options.redditId - (optional) The ID of the comment or post to add the mod note to. e.g. 't3_1234'
      * @param options.label - The label of the mod note. e.g. 'SPAM_WARNING'
      * @param options.note - The text of the mod note.
      * @returns A Promise that resolves if the mod note was successfully added.
@@ -46288,10 +46296,19 @@ export declare type RedisClient = {
      * Returns the length of the string value stored at key.
      * An error is returned when key holds a non-string value.
      * https://redis.io/commands/strlen/
+     * @deprecated Use {@link RedisClient.strLen} instead.
      * @arg {} key
      * @returns length of the string stored at key
      */
     strlen(key: string): Promise<number>;
+    /**
+     * Returns the length of the string value stored at key.
+     * An error is returned when key holds a non-string value.
+     * https://redis.io/commands/strlen/
+     * @arg {} key
+     * @returns length of the string stored at key
+     */
+    strLen(key: string): Promise<number>;
     /**
      * Increments the number stored at key by increment.
      * https://redis.io/commands/incrby/
@@ -46303,18 +46320,35 @@ export declare type RedisClient = {
     /**
      * Returns the values of all specified keys.
      * https://redis.io/commands/mget/
+     * @deprecated Use {@link RedisClient.mGet} instead.
      * @arg {} keys
      * @returns list of values at the specified keys
      */
     mget(keys: string[]): Promise<(string | null)[]>;
+    /**
+     * Returns the values of all specified keys.
+     * https://redis.io/commands/mget/
+     * @arg {} keys
+     * @returns list of values at the specified keys
+     */
+    mGet(keys: string[]): Promise<(string | null)[]>;
     /**
      * Sets the given keys to their respective values.
      * https://redis.io/commands/mset/
+     * @deprecated Use {@link RedisClient.mSet} instead.
      * @arg {} keyValues
      */
     mset(keyValues: {
         [key: string]: string;
     }): Promise<void>;
+    /**
+     * Sets the given keys to their respective values.
+     * https://redis.io/commands/mset/
+     * @arg {} keyValues
+     */
+    mSet(keyValues: {
+        [key: string]: string;
+    }): Promise<void>;
     /**
      * Set a timeout on key.
      * https://redis.io/commands/expire/
@@ -46429,6 +46463,7 @@ export declare type RedisClient = {
     /**
      * Sets the specified fields to their respective values in the hash stored at key.
      * https://redis.io/commands/hset
+     * @deprecated Use {@link RedisClient.hSet} instead.
      * @arg {} key
      * @arg {} fieldValues
      * @returns number of fields that were added
@@ -46436,42 +46471,93 @@ export declare type RedisClient = {
     hset(key: string, fieldValues: {
         [field: string]: string;
     }): Promise<number>;
+    /**
+     * Sets the specified fields to their respective values in the hash stored at key.
+     * https://redis.io/commands/hset
+     * @arg {} key
+     * @arg {} fieldValues
+     * @returns number of fields that were added
+     */
+    hSet(key: string, fieldValues: {
+        [field: string]: string;
+    }): Promise<number>;
     /**
      * Returns the value associated with field in the hash stored at key.
      * https://redis.io/commands/hget
+     * @deprecated Use {@link RedisClient.hGet} instead.
      * @arg {} key
      * @arg {} field
      * @returns value associated with field
      */
     hget(key: string, field: string): Promise<string | undefined>;
+    /**
+     * Returns the value associated with field in the hash stored at key.
+     * https://redis.io/commands/hget
+     * @arg {} key
+     * @arg {} field
+     * @returns value associated with field
+     */
+    hGet(key: string, field: string): Promise<string | undefined>;
     /**
      * Returns all fields and values of the hash stored at key
      * https://redis.io/commands/hgetall
+     * @deprecated Use {@link RedisClient.hGetAll} instead.
      * @arg {} key
      * @returns a map of fields and their values stored in the hash,
      */
     hgetall(key: string): Promise<Record<string, string> | undefined>;
+    /**
+     * Returns all fields and values of the hash stored at key
+     * https://redis.io/commands/hgetall
+     * @arg {} key
+     * @returns a map of fields and their values stored in the hash,
+     */
+    hGetAll(key: string): Promise<Record<string, string> | undefined>;
     /**
      * Removes the specified fields from the hash stored at key.
      * https://redis.io/commands/hdel/
+     * @deprecated Use {@link RedisClient.hDel} instead.
      * @arg {} key
      * @arg {} fields
      * @returns number of fields that were removed from the hash
      */
     hdel(key: string, fields: string[]): Promise<number>;
+    /**
+     * Removes the specified fields from the hash stored at key.
+     * https://redis.io/commands/hdel/
+     * @arg {} key
+     * @arg {} fields
+     * @returns number of fields that were removed from the hash
+     */
+    hDel(key: string, fields: string[]): Promise<number>;
     /**
      * Iterates fields of Hash types and their associated values.
+     * @deprecated Use {@link RedisClient.hScan} instead.
      * @arg {} key
      * @arg {} cursor
      * @arg {} pattern
      * @arg {} count
      */
     hscan(key: string, cursor: number, pattern?: string | undefined, count?: number | undefined): Promise<HScanResponse>;
+    /**
+     * Iterates fields of Hash types and their associated values.
+     * @arg {} key
+     * @arg {} cursor
+     * @arg {} pattern
+     * @arg {} count
+     */
+    hScan(key: string, cursor: number, pattern?: string | undefined, count?: number | undefined): Promise<HScanResponse>;
     /**
      * Returns all field names in the hash stored at key.
+     * @deprecated Use {@link RedisClient.hKeys} instead.
      * @arg {} key
      */
     hkeys(key: string): Promise<string[]>;
+    /**
+     * Returns all field names in the hash stored at key.
+     * @arg {} key
+     */
+    hKeys(key: string): Promise<string[]>;
     /**
      * Increments the number stored at field in the hash stored at key by increment.
      * https://redis.io/commands/hincrby/
@@ -46481,12 +46567,29 @@ export declare type RedisClient = {
      * @returns value of key after the increment
      */
     hincrby(key: string, field: string, value: number): Promise<number>;
+    /**
+     * Increments the number stored at field in the hash stored at key by increment.
+     * https://redis.io/commands/hincrby/
+     * @deprecated Use {@link RedisClient.hIncrBy} instead.
+     * @arg {} key
+     * @arg {} field
+     * @arg {} value
+     * @returns value of key after the increment
+     */
+    hIncrBy(key: string, field: string, value: number): Promise<number>;
     /**
      * Returns the number of fields contained in the hash stored at key.
+     * @deprecated Use {@link RedisClient.hLen} instead.
      * @arg {} key
      * @returns the number of fields in the hash, or 0 when the key does not exist.
      */
     hlen(key: string): Promise<number>;
+    /**
+     * Returns the number of fields contained in the hash stored at key.
+     * @arg {} key
+     * @returns the number of fields in the hash, or 0 when the key does not exist.
+     */
+    hLen(key: string): Promise<number>;
     /**
      * Allows read/write operations to global keys in Redis
      * Global redis enables apps to persist and access state across subreddit installations
@@ -49259,6 +49362,35 @@ declare const SnoozeReportsRequest: {
     fromPartial(object: DeepPartial_2<SnoozeReportsRequest>): SnoozeReportsRequest;
 };
 
+export declare const enum SocialLinkType {
+    Custom = "CUSTOM",
+    Reddit = "REDDIT",
+    Instagram = "INSTAGRAM",
+    Twitter = "TWITTER",
+    Tiktok = "TIKTOK",
+    Twitch = "TWITCH",
+    Facebook = "FACEBOOK",
+    Youtube = "YOUTUBE",
+    Tumblr = "TUMBLR",
+    Spotify = "SPOTIFY",
+    Soundcloud = "SOUNDCLOUD",
+    Beacons = "BEACONS",
+    Linktree = "LINKTREE",
+    Discord = "DISCORD",
+    Venmo = "VENMO",
+    CashApp = "CASH_APP",
+    Patreon = "PATREON",
+    Kofi = "KOFI",
+    Paypal = "PAYPAL",
+    Cameo = "CAMEO",
+    Onlyfans = "ONLYFANS",
+    Substack = "SUBSTACK",
+    Kickstarter = "KICKSTARTER",
+    Indiegogo = "INDIEGOGO",
+    BuyMeACoffee = "BUY_ME_A_COFFEE",
+    Shopify = "SHOPIFY"
+}
+
 /**
  * Encapsulates information about the original source file from which a
  * FileDescriptorProto was generated.
@@ -66094,6 +66226,11 @@ export declare type TxClientLike = {
      * @arg {} keys - given keys to be watched
      */
     watch(...keys: string[]): Promise<TxClientLike>;
+    /**
+     * Flushes all the previously watched keys for a transaction.
+     * If you call EXEC or DISCARD, there's no need to manually call UNWATCH.
+     * https://redis.io/commands/unwatch/
+     */
     unwatch(): Promise<TxClientLike>;
     /**
      * Get the value of key. If the key does not exist the special value nil is returned.
@@ -66153,25 +66290,51 @@ export declare type TxClientLike = {
      * Returns the length of the string value stored at key.
      * An error is returned when key holds a non-string value.
      * https://redis.io/commands/strlen/
+     * @deprecated Use {@link TxClientLike.strLen} instead.
      * @arg {} key
      * @returns length of the string stored at key
      */
     strlen(key: string): Promise<TxClientLike>;
+    /**
+     * Returns the length of the string value stored at key.
+     * An error is returned when key holds a non-string value.
+     * https://redis.io/commands/strlen/
+     * @arg {} key
+     * @returns length of the string stored at key
+     */
+    strLen(key: string): Promise<TxClientLike>;
     /**
      * Returns the values of all specified keys.
      * https://redis.io/commands/mget/
+     * @deprecated Use {@link TxClientLike.mGet} instead.
      * @arg {} keys
      * @returns list of values at the specified keys
      */
     mget(keys: string[]): Promise<TxClientLike>;
+    /**
+     * Returns the values of all specified keys.
+     * https://redis.io/commands/mget/
+     * @arg {} keys
+     * @returns list of values at the specified keys
+     */
+    mGet(keys: string[]): Promise<TxClientLike>;
     /**
      * Sets the given keys to their respective values.
      * https://redis.io/commands/mset/
+     * @deprecated Use {@link TxClientLike.mSet} instead.
      * @arg {} keyValues
      */
     mset(keyValues: {
         [key: string]: string;
     }): Promise<TxClientLike>;
+    /**
+     * Sets the given keys to their respective values.
+     * https://redis.io/commands/mset/
+     * @arg {} keyValues
+     */
+    mSet(keyValues: {
+        [key: string]: string;
+    }): Promise<TxClientLike>;
     /**
      * Set a timeout on key.
      * https://redis.io/commands/expire/
@@ -66283,6 +66446,7 @@ export declare type TxClientLike = {
     /**
      * Sets the specified fields to their respective values in the hash stored at key.
      * https://redis.io/commands/hset
+     * @deprecated Use {@link TxClientLike.hSet} instead.
      * @arg {} key
      * @arg {} fieldValues
      * @returns number of fields that were added
@@ -66290,57 +66454,125 @@ export declare type TxClientLike = {
     hset(key: string, fieldValues: {
         [field: string]: string;
     }): Promise<TxClientLike>;
+    /**
+     * Sets the specified fields to their respective values in the hash stored at key.
+     * https://redis.io/commands/hset
+     * @arg {} key
+     * @arg {} fieldValues
+     * @returns number of fields that were added
+     */
+    hSet(key: string, fieldValues: {
+        [field: string]: string;
+    }): Promise<TxClientLike>;
     /**
      * Returns the value associated with field in the hash stored at key.
      * https://redis.io/commands/hget
+     * @deprecated Use {@link TxClientLike.hGet} instead.
      * @arg {} key
      * @arg {} field
      * @returns value associated with field
      */
     hget(key: string, field: string): Promise<TxClientLike>;
+    /**
+     * Returns the value associated with field in the hash stored at key.
+     * https://redis.io/commands/hget
+     * @arg {} key
+     * @arg {} field
+     * @returns value associated with field
+     */
+    hGet(key: string, field: string): Promise<TxClientLike>;
     /**
      * Returns all fields and values of the hash stored at key
      * https://redis.io/commands/hgetall
+     * @deprecated Use {@link TxClientLike.hGetAll} instead.
      * @arg {} key
      * @returns a map of fields and their values stored in the hash,
      */
     hgetall(key: string): Promise<TxClientLike>;
+    /**
+     * Returns all fields and values of the hash stored at key
+     * https://redis.io/commands/hgetall
+     * @arg {} key
+     * @returns a map of fields and their values stored in the hash,
+     */
+    hGetAll(key: string): Promise<TxClientLike>;
     /**
      * Removes the specified fields from the hash stored at key.
      * https://redis.io/commands/hdel/
+     * @deprecated Use {@link TxClientLike.hDel} instead.
      * @arg {} key
      * @arg {} fields
      * @returns number of fields that were removed from the hash
      */
     hdel(key: string, fields: string[]): Promise<TxClientLike>;
+    /**
+     * Removes the specified fields from the hash stored at key.
+     * https://redis.io/commands/hdel/
+     * @arg {} key
+     * @arg {} fields
+     * @returns number of fields that were removed from the hash
+     */
+    hDel(key: string, fields: string[]): Promise<TxClientLike>;
     /**
      * Iterates fields of Hash types and their associated values.
+     * @deprecated Use {@link TxClientLike.hScan} instead.
      * @arg {} key
      * @arg {} cursor
      * @arg {} pattern
      * @arg {} count
      */
     hscan(key: string, cursor: number, pattern?: string | undefined, count?: number | undefined): Promise<TxClientLike>;
+    /**
+     * Iterates fields of Hash types and their associated values.
+     * @arg {} key
+     * @arg {} cursor
+     * @arg {} pattern
+     * @arg {} count
+     */
+    hScan(key: string, cursor: number, pattern?: string | undefined, count?: number | undefined): Promise<TxClientLike>;
     /**
      * Returns all field names in the hash stored at key.
+     * @deprecated Use {@link TxClientLike.hKeys} instead.
      * @arg {} key
      */
     hkeys(key: string): Promise<TxClientLike>;
+    /**
+     * Returns all field names in the hash stored at key.
+     * @arg {} key
+     */
+    hKeys(key: string): Promise<TxClientLike>;
     /**
      * Increments the number stored at field in the hash stored at key by increment.
      * https://redis.io/commands/hincrby/
+     * @deprecated Use {@link TxClientLike.hIncrBy} instead.
      * @arg {} key
      * @arg {} field
      * @arg {} value
      * @returns value of key after the increment
      */
     hincrby(key: string, field: string, value: number): Promise<TxClientLike>;
+    /**
+     * Increments the number stored at field in the hash stored at key by increment.
+     * https://redis.io/commands/hincrby/
+     * @arg {} key
+     * @arg {} field
+     * @arg {} value
+     * @returns value of key after the increment
+     */
+    hIncrBy(key: string, field: string, value: number): Promise<TxClientLike>;
     /**
      * Returns the number of fields contained in the hash stored at key.
+     * @deprecated Use {@link TxClientLike.hLen} instead.
      * @arg {} key
      * @returns the number of fields in the hash, or 0 when the key does not exist.
      */
     hlen(key: string): Promise<TxClientLike>;
+    /**
+     * Returns the number of fields contained in the hash stored at key.
+     * @arg {} key
+     * @returns the number of fields in the hash, or 0 when the key does not exist.
+     */
+    hLen(key: string): Promise<TxClientLike>;
 };
 
 /**
@@ -67230,6 +67462,16 @@ export declare class User {
      */
     getUserFlairBySubreddit(subreddit: string): Promise<UserFlair | undefined>;
     getSnoovatarUrl(): Promise<string | undefined>;
+    /**
+     * Gets social links of the user
+     *
+     * @returns A Promise that resolves an Array of UserSocialLink objects
+     * @example
+     * ```ts
+     * const socialLinks = await user.getSocialLinks();
+     * ```
+     */
+    getSocialLinks(): Promise<UserSocialLink[]>;
 }
 
 declare interface User_2 {
@@ -69364,6 +69606,25 @@ declare const UserSearchResponse_AccountData_Subreddit: {
     fromPartial(object: DeepPartial_11<UserSearchResponse_AccountData_Subreddit>): UserSearchResponse_AccountData_Subreddit;
 };
 
+/**
+ * @field id: ID of the social link.
+ *
+ * @field handle: Display name of social media link.
+ *
+ * @field outboundUrl: Outbound url of social media link.
+ *
+ * @field type: Type of social media link i.e. Instagram, YouTube.
+ *
+ * @field title: Title or name of social media link.
+ */
+export declare type UserSocialLink = {
+    id: string;
+    handle?: string;
+    outboundUrl: string;
+    type: SocialLinkType;
+    title: string;
+};
+
 declare interface UsersSearchRequest {
     /** fullname of a thing */
     after?: string | undefined;