@devvit/public-api 0.11.10 → 0.11.11-next-2025-03-18-8a91fd0df.0

package/public-api.d.ts

@@ -39,6 +39,7 @@ import _m0 from 'protobufjs/minimal.js';
 import { Observable } from 'rxjs';
 import { OrderResultStatus as OrderResultStatus_2 } from '../../../../../payments.js';
 import { RealtimeSubscriptionStatus as RealtimeSubscriptionStatus_2 } from '../../../../../index.js';
+import { RunAs as RunAs_2 } from '../common/common_msg.js';
 import { SetCustomPostPreviewRequest_BodyType as SetCustomPostPreviewRequest_BodyType_2 } from './linksandcomments_msg.js';
 import { SubredditRating as SubredditRating_2 } from '../../../reddit/v2alpha/subredditv2.js';
 import { SubredditType as SubredditType_3 } from '../../../reddit/v2alpha/subredditv2.js';
@@ -3425,6 +3426,8 @@ declare interface CommentRequest {
      * @example "t3_abc123"
      */
     thingId: string;
+    /** Indicates who the Comment should be created as */
+    runAs: RunAs;
 }
 
 declare const CommentRequest: {
@@ -13702,11 +13705,13 @@ declare const LinksAndCommentsDefinition: {
                     richtextJson?: string | undefined;
                     text?: string;
                     thingId?: string;
+                    runAs?: RunAs_2;
                 } | undefined): CommentRequest;
                 fromPartial(object: {
                     richtextJson?: string | undefined;
                     text?: string;
                     thingId?: string;
+                    runAs?: RunAs_2;
                 }): CommentRequest;
             };
             readonly requestStream: false;
@@ -14092,11 +14097,13 @@ declare const LinksAndCommentsDefinition: {
                     richtextJson?: string | undefined;
                     text?: string;
                     thingId?: string;
+                    runAs?: RunAs_2;
                 } | undefined): CommentRequest;
                 fromPartial(object: {
                     richtextJson?: string | undefined;
                     text?: string;
                     thingId?: string;
+                    runAs?: RunAs_2;
                 }): CommentRequest;
             };
             readonly requestStream: false;
@@ -15329,7 +15336,13 @@ declare const LinksAndCommentsDefinition: {
                 encode(message: ReportRequest, writer?: _m0.Writer): _m0.Writer;
                 decode(input: _m0.Reader | Uint8Array, length?: number | undefined): ReportRequest;
                 fromJSON(object: any): ReportRequest;
-                toJSON(message: ReportRequest): unknown;
+                toJSON(message: ReportRequest): unknown; /**
+                * Toggle Contest Mode for a Post's comments
+                *
+                * Contest Mode randomizes the sort order and hides the vote score for comments
+                *
+                * @see {@link https://www.reddit.com/dev/api#POST_api_set_contest_mode}
+                */
                 create(base?: {
                     additionalInfo?: string | undefined;
                     customText?: string | undefined;
@@ -16135,6 +16148,11 @@ declare const LinksAndCommentsDefinition: {
                     crosspostFullname?: string | undefined;
                     richtextFallback?: string | undefined;
                     imageUrls?: any[] | undefined;
+                    runAs?: RunAs_2;
+                    userGeneratedContent?: {
+                        text?: string;
+                        imageUrls?: string[];
+                    } | undefined;
                 } | undefined): SubmitRequest;
                 fromPartial(object: {
                     collectionId?: string | undefined;
@@ -16153,6 +16171,11 @@ declare const LinksAndCommentsDefinition: {
                     crosspostFullname?: string | undefined;
                     richtextFallback?: string | undefined;
                     imageUrls?: any[] | undefined;
+                    runAs?: RunAs_2;
+                    userGeneratedContent?: {
+                        text?: string;
+                        imageUrls?: string[];
+                    } | undefined;
                 }): SubmitRequest;
             };
             readonly requestStream: false;
@@ -16220,6 +16243,11 @@ declare const LinksAndCommentsDefinition: {
                     crosspostFullname?: string | undefined;
                     richtextFallback?: string | undefined;
                     imageUrls?: any[] | undefined;
+                    runAs?: RunAs_2;
+                    userGeneratedContent?: {
+                        text?: string;
+                        imageUrls?: string[];
+                    } | undefined;
                 } | undefined): SubmitRequest;
                 fromPartial(object: {
                     collectionId?: string | undefined;
@@ -16238,6 +16266,11 @@ declare const LinksAndCommentsDefinition: {
                     crosspostFullname?: string | undefined;
                     richtextFallback?: string | undefined;
                     imageUrls?: any[] | undefined;
+                    runAs?: RunAs_2;
+                    userGeneratedContent?: {
+                        text?: string;
+                        imageUrls?: string[];
+                    } | undefined;
                 }): SubmitRequest;
             };
             readonly requestStream: false;
@@ -36463,8 +36496,11 @@ declare namespace protos {
         Modlog,
         ModlogServiceName,
         ModlogClientImpl,
+        runAsFromJSON,
+        runAsToJSON,
         apiClientConfig_BodyTypeFromJSON,
         apiClientConfig_BodyTypeToJSON,
+        RunAs,
         Listing_2 as Listing,
         Listing_ListingData,
         WrappedRedditObject,
@@ -36482,6 +36518,7 @@ declare namespace protos {
         WrappedUserObject,
         ApiClientConfig,
         ApiClientConfig_BodyType,
+        UserGeneratedContent,
         ClearFlairTemplatesRequest,
         DeleteFlairRequest,
         DeleteFlairTemplateRequest,
@@ -41474,6 +41511,17 @@ declare interface Rpc_9 {
     request(service: string, method: string, data: Uint8Array, metadata?: Metadata): Promise<Uint8Array>;
 }
 
+/** Indicates who the request should be made on behalf of. Currently, only 'APP' or 'USER' types are supported. */
+declare enum RunAs {
+    APP = 0,
+    USER = 1,
+    UNRECOGNIZED = -1
+}
+
+declare function runAsFromJSON(object: any): RunAs;
+
+declare function runAsToJSON(object: RunAs): number;
+
 /**
  * Schedule a new job to run at a specific time or on a cron schedule
  * @param job The job to schedule
@@ -42997,6 +43045,10 @@ declare interface SubmitRequest {
     richtextFallback?: string | undefined;
     /** If `kind` is "image" this must be set to the images URLs */
     imageUrls?: Array<any> | undefined;
+    /** Indicates who the Post should be submited as */
+    runAs: RunAs;
+    /** The UserGeneratedContent attached to the Post */
+    userGeneratedContent?: UserGeneratedContent | undefined;
 }
 
 declare const SubmitRequest: {
@@ -51385,6 +51437,24 @@ declare const UserFlairV2: {
     fromPartial(object: DeepPartial_19<UserFlairV2>): UserFlairV2;
 };
 
+/** Represents data on the user's content submission */
+declare interface UserGeneratedContent {
+    /** The text body of the content */
+    text: string;
+    /** The imageUrls attached to the content, if any */
+    imageUrls: string[];
+}
+
+declare const UserGeneratedContent: {
+    $type: "devvit.plugin.redditapi.common.UserGeneratedContent";
+    encode(message: UserGeneratedContent, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): UserGeneratedContent;
+    fromJSON(object: any): UserGeneratedContent;
+    toJSON(message: UserGeneratedContent): unknown;
+    create(base?: DeepPartial_9<UserGeneratedContent>): UserGeneratedContent;
+    fromPartial(object: DeepPartial_9<UserGeneratedContent>): UserGeneratedContent;
+};
+
 declare type UserLink = {
     e: typeof USER_LINK_ELEMENT;
     t: string;
@@ -53307,6 +53377,8 @@ export declare type UseWebViewResult<To extends JSONValue = JSONValue> = {
     postMessage(message: To): void;
     /** Initiate a request for the web view to open */
     mount(): void;
+    /** Initiate a request for the web view to be closed */
+    unmount(): void;
 };
 
 export declare type ValidatedBooleanField = Prettify<ValidatedFormField<BooleanField, boolean>>;