@devvit/protos 0.12.1-next-2025-09-08-20-55-43-6ce1b439e.0 → 0.12.1-next-2025-09-09-13-45-18-0f0a506a2.0

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/dev_portal/app_settings/app_settings.proto

@@ -0,0 +1,48 @@
+syntax = "proto3";
+
+package devvit.dev_portal.app_settings;
+
+import "devvit/plugin/settings/v1alpha/settings.proto";
+import "devvit/ui/form_builder/v1alpha/form.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/devportal/appsettings";
+
+message GetAppSettingsRequest {
+  string app_id = 1;
+}
+
+message GetAppSettingsResponse {
+  devvit.plugin.settings.v1alpha.SettingsValues settings = 1;
+}
+
+message UpdateAppSettingsRequest {
+  string app_id = 1;
+  devvit.plugin.settings.v1alpha.SettingsValues settings = 2;
+}
+
+message UpdateAppSettingsResponse {
+  bool success = 1;
+  map<string, string> errors = 2;
+}
+
+message GetAppSettingsFormRequest {
+  string app_id = 1;
+}
+
+message GetAppSettingsFormResponse {
+  // App settings Forms mapped by actor_name
+  map<string, devvit.ui.form_builder.v1alpha.Form> form = 1;
+}
+
+message ValidateAppSettingsFormRequest {
+  string app_id = 1;
+  devvit.plugin.settings.v1alpha.SettingsValues settings = 2;
+}
+
+message ValidateAppSettingsFormResponse {
+  // If false, prevent submission and display errors on the form
+  bool success = 1;
+
+  // Map of field_id:error pairs to display on the form
+  map<string, string> errors = 2;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/dev_portal/app_version/app_version.proto

@@ -0,0 +1,168 @@
+syntax = "proto3";
+
+package devvit.dev_portal.app_version;
+
+import "devvit/dev_portal/actor/actor_type.proto";
+import "devvit/dev_portal/app/info/app_info.proto";
+import "devvit/dev_portal/app_version/info/app_version_info.proto";
+import "devvit/dev_portal/installation/installation.proto";
+import "devvit/plugin/buildpack/buildpack_common.proto";
+import "devvit/runtime/bundle.proto";
+import "google/protobuf/wrappers.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/devportal/appversion";
+
+// region Request parameters
+
+// Used to create a new app version.
+message AppVersionCreationRequest {
+  // What is the ID of the app this version belongs to?
+  string app_id = 1;
+
+  // How visible is this app version?
+  info.VersionVisibility visibility = 2;
+  // What installation types are allowed for this app?
+  repeated info.InstallationType valid_install_types = 3;
+  // What is this version's major version number? i.e. x.0.0
+  int32 major_version = 4;
+  // What is this version's minor version number? i.e. 0.x.0
+  int32 minor_version = 5;
+  // What is this version's patch version number? i.e. 0.0.x
+  int32 patch_version = 6;
+  // What is this version's prerelease version number, if applicable? i.e. 0.0.0.x
+  google.protobuf.Int32Value prerelease_version = 7;
+
+  // Give me the actor bundles of this app
+  repeated devvit.plugin.buildpack.Bundle actor_bundles = 8;
+
+  // What should go in this version's about chunk? (Comes from README.md by default.)
+  string about = 9;
+
+  // Whether we should not create a default playtest subreddit for this app
+  bool prevent_playtest_subreddit_creation = 10;
+
+  // Any marketing information for this app version, if available
+  optional app_version.info.AppVersionMarketingInfo marketing_info = 11;
+
+  // If this app version is a Devvit Web app, this field contains the `devvit.json` used by the app.
+  optional string devvit_json = 12;
+}
+
+// Used to send an app's slug and version; the object equivalent of "my-app@1.2.3"
+message AppSlugAndVersion {
+  // What's the slug of the app we're looking for?
+  string slug = 1;
+  // What version are you looking for? Can be '1.2.3[.4]' or 'latest'.
+  string version = 2;
+}
+
+// Used to update an existing app version's information. If a field is optional, omitting it will
+// leave its value unchanged.
+message AppVersionUpdateRequest {
+  // What is the ID of the version you want to update?
+  string id = 1;
+  // How visible should the version be?
+  info.OptionalVersionVisibility visibility = 2;
+  // What installation types are allowed for this app?
+  reserved 3;
+  repeated info.InstallationType valid_install_types = 4;
+  // What should go in this version's about chunk?
+  google.protobuf.StringValue about = 5;
+
+  info.ComputePool pool = 6;
+
+  reserved 7; // removed
+
+  // Version information is not editable.
+  // Upload time is not editable.
+  // Build status and timestamp are editable only by the build system, not via API.
+
+  // The actor list is not editable.
+}
+
+// Get a list of valid installation locations for a given app version, optionally with
+// paging info.
+message ValidInstallLocationsRequest {
+  // What is the ID of the app version you want to get valid install locations for?
+  string id = 1;
+  // If present, specifies what page of the response data you're asking for.
+  repeated InstallLocationPageInfo page_info = 2;
+}
+
+// For a given install location type, give me requests before or after a given cursor.
+message InstallLocationPageInfo {
+  // The type of installation we're paging over
+  info.InstallationType type = 1;
+  // The cursor to start or end at
+  oneof cursor {
+    // Show me results before this startCursor.
+    string before = 2;
+    // Show me results after this endCursor.
+    string after = 3;
+  }
+}
+
+// endregion
+
+// region Response types
+
+// Contains the basic information about an app version, as well as the app it belongs to, the
+// actors contained in the app, and any installations of the app.
+message FullAppVersionInfo {
+  info.AppVersionInfo app_version = 1;
+  app.info.AppInfo app = 2;
+  repeated actor.ActorTypeInfo actor_types = 3;
+  repeated installation.InstallationInfo installations = 4;
+}
+
+// Lists all valid installation types and locations for a given app.
+// Logic for this response:
+// For each install type:
+// - the type we're talking about
+// - an array of valid install locations
+message ValidInstallLocationsResponse {
+  repeated InstallLocationInfo locations = 1;
+}
+
+// Gives an installation type, and list all valid installation locations matching that type.
+message InstallLocationInfo {
+  // The type of installation we're providing locations for
+  info.InstallationType type = 1;
+  // The list of valid install locations
+  repeated InstallLocationDetails locations = 2;
+  // Paging info for the response, if applicable
+  optional PageInfo page_info = 3;
+}
+
+// Details each valid install location, and if there's already an install there or not.
+message InstallLocationDetails {
+  // The thing ID of the valid install location
+  string thing_id = 1;
+  // The name of the valid install location
+  string name = 2;
+  // If present, gives the UUID of an installation of the app in question that already exists in this location.
+  google.protobuf.StringValue existing_install_id = 3;
+  // The icon or avatar for the install location
+  google.protobuf.StringValue icon = 4;
+}
+
+// Used to provide paging info about a response. This mirrors the PageInfo type in GQL.
+message PageInfo {
+  // When paginating forwards, are there more items?
+  bool has_next_page = 1;
+  // When paginating backwards, are there more items?
+  bool has_previous_page = 2;
+  // When paginating backwards, the cursor to continue.
+  string start_cursor = 3;
+  // When paginating forwards, the cursor to continue.
+  string end_cursor = 4;
+}
+
+message GetAppVersionBundleResponse {
+  message BundleInfo {
+    string actor = 1;
+    devvit.runtime.LinkedBundle bundle = 2;
+  }
+  repeated BundleInfo actor_bundles = 1;
+}
+// endregion

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/dev_portal/app_version/info/app_version_info.proto

@@ -0,0 +1,88 @@
+syntax = "proto3";
+
+package devvit.dev_portal.app_version.info;
+
+import "devvit/dev_portal/nutrition/nutrition.proto";
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/devportal/appversion/info";
+
+// This exists in its own file to prevent circular dependency imports between
+// app_version and installation.
+
+// region Enums
+
+enum VersionVisibility {
+  PUBLIC = 0;
+  PRIVATE = 1;
+  UNLISTED = 2;
+}
+
+enum BuildStatus {
+  BUILDING = 0;
+  READY = 1;
+  FAILED = 2;
+}
+
+enum InstallationType {
+  USER = 0;
+  SUBREDDIT = 1;
+  SUBREDDIT_GLOBAL = 2;
+}
+
+enum ComputePool {
+  LOW = 0;
+  MEDIUM = 1 [deprecated = true];
+  HIGH = 2;
+  RESTRICTED = 3;
+  INTERNAL = 4;
+  BETA = 5;
+}
+
+// endregion
+
+message OptionalVersionVisibility {
+  VersionVisibility value = 1;
+}
+
+// Contains the details of an app version. For field documentation, refer to the Prisma schema.
+message AppVersionInfo {
+  string id = 1;
+  VersionVisibility visibility = 2;
+  reserved 3;
+  repeated InstallationType valid_install_types = 4;
+
+  int32 major_version = 5;
+  int32 minor_version = 6;
+  int32 patch_version = 7;
+  google.protobuf.Int32Value prerelease_version = 8;
+
+  google.protobuf.Timestamp uploaded_at = 9;
+  BuildStatus build_status = 10;
+  google.protobuf.Timestamp built_at = 11;
+
+  string about = 12;
+  bool has_custom_settings = 13;
+  ComputePool pool = 14;
+  reserved 15; // removed
+
+  // Abstract plugin capabilities used by the target app version
+  repeated devvit.dev_portal.nutrition.NutritionCategory app_capabilities = 16;
+
+  // Devvit API version of this app version (e.g. "1.0.0")
+  optional string public_api_version = 17;
+
+  AppVersionMarketingInfo marketing_info = 18;
+
+  // Indicates whether the app version has a devvit.json file.
+  bool has_devvit_json = 19;
+}
+
+// Contains marketing information about an app version, such as its icon.
+message AppVersionMarketingInfo {
+  // Reddit-hosted URL for the app version's icon, OR in the case of uploading a new app version,
+  // the UUID of the media asset to use as the icon.
+  optional string icon = 1;
+  // pssst, there's more coming later
+}

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/dev_portal/data_api/admin/audit/audit.proto

@@ -0,0 +1,75 @@
+syntax = "proto3";
+
+package devvit.dev_portal.data_api.admin.audit;
+
+import "devvit/data/api/admin/v1alpha/organization.proto";
+import "google/protobuf/timestamp.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/devportal/data_api/admin/audit";
+
+enum AuditLogEventType {
+  DATA_SUBSCRIPTION_CREATE = 0;
+  DATA_SUBSCRIPTION_UPDATE = 1;
+  DATA_SUBSCRIPTION_DELETE = 2;
+  DATA_TOKEN_CREATE = 3;
+  DATA_TOKEN_REVOKE = 4;
+  ORGANIZATION_DELETE = 5;
+  ORGANIZATION_UPDATE = 6;
+}
+
+message AuditLogEvent {
+  string id = 1; // unique identifier for the event
+  google.protobuf.Timestamp created_at = 2; // when the event was created
+  string user_id = 3; // t2_ id of the user who performed the action
+  AuditLogEventType type = 4; // type of the event
+  string organization_id = 5; // id of the organization the event is associated with
+  oneof payload {
+    DataTokenCreateAuditLogEventPayload data_token_create_payload = 6;
+    DataTokenRevokeAuditLogEventPayload data_token_revoke_payload = 7;
+    DataSubscriptionCreateAuditLogEventPayload data_subscription_create_payload = 8;
+    DataSubscriptionUpdateAuditLogEventPayload data_subscription_update_payload = 9;
+    DataSubscriptionDeleteAuditLogEventPayload data_subscription_delete_payload = 10;
+    OrganizationDeleteAuditLogEventPayload organization_delete_payload = 13;
+    OrganizationUpdateAuditLogEventPayload organization_update_payload = 14;
+  }
+  // username of the user who performed the action without the u/ prefix
+  // @example "spez"
+  string username = 11;
+}
+
+message DataTokenCreateAuditLogEventPayload {
+  string token_id = 1; // id of the data token that was created
+  google.protobuf.Timestamp expiration = 2; // expiration date of the data token
+}
+
+message DataTokenRevokeAuditLogEventPayload {
+  string token_id = 1; // id of the data token that was revoked
+}
+
+message DataSubscriptionCreateAuditLogEventPayload {
+  string subscription_id = 1;
+}
+
+message DataSubscriptionUpdateAuditLogEventPayload {
+  string subscription_id = 1;
+}
+
+message DataSubscriptionDeleteAuditLogEventPayload {
+  string subscription_id = 1;
+}
+
+message OrganizationDeleteAuditLogEventPayload {
+  devvit.data.api.admin.v1alpha.Organization organization = 1;
+}
+
+message OrganizationUpdateAuditLogEventPayload {
+  devvit.data.api.admin.v1alpha.Organization organization = 1;
+}
+
+message GetAuditLogEventsRequest {
+  string organization_name = 1;
+}
+
+message GetAuditLogEventsResponse {
+  repeated AuditLogEvent events = 1;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/dev_portal/data_api/admin/auth/auth.proto

@@ -0,0 +1,41 @@
+syntax = "proto3";
+
+package devvit.dev_portal.data_api.admin.auth;
+
+import "devvit/data/api/v1alpha/admin.proto";
+import "google/protobuf/duration.proto";
+import "google/protobuf/timestamp.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/devportal/data_api/admin/auth";
+
+message CreateDataTokenRequest {
+  string organization_name = 1;
+  google.protobuf.Duration expires_in = 2;
+}
+
+message CreateDataTokenResponse {
+  string token = 1;
+  google.protobuf.Timestamp expires_at = 2;
+}
+
+message GetDataTokenByIdRequest {
+  string id = 1;
+}
+
+message GetDataTokenByIdResponse {
+  devvit.data.api.v1alpha.DataToken token = 1;
+}
+
+message GetDataTokensByOrganizationNameRequest {
+  string organization_name = 1;
+}
+
+message GetDataTokensByOrganizationNameResponse {
+  repeated devvit.data.api.v1alpha.DataToken tokens = 1;
+}
+
+message RevokeDataTokenByIdRequest {
+  string token_id = 1;
+}
+
+message RevokeDataTokenByIdResponse {}

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/dev_portal/data_api/admin/organization/organization.proto

@@ -0,0 +1,41 @@
+syntax = "proto3";
+
+package devvit.dev_portal.data_api.admin.organization;
+
+import "devvit/data/api/v1alpha/admin.proto";
+import "google/protobuf/timestamp.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/devportal/data_api/admin/organization";
+
+message CreateOrganizationRequest {
+  string name = 1;
+  google.protobuf.Timestamp contract_end_date = 2;
+  // Indicates if the organization is an internal or external organization
+  bool is_internal = 3;
+}
+
+message CreateOrganizationResponse {
+  string organization_id = 1;
+  string name = 2;
+}
+
+message GetOrganizationByNameRequest {
+  string name = 1;
+}
+message GetOrganizationByNameResponse {
+  string organization_id = 1;
+  bool is_internal = 2;
+}
+
+message GetOrganizationsRequest {}
+
+message GetOrganizationsResponse {
+  repeated devvit.data.api.v1alpha.Organization organizations = 1;
+}
+
+message UpdateOrganizationRequest {
+  string organization_id = 1;
+  bool is_internal = 2;
+}
+
+message UpdateOrganizationResponse {}

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/dev_portal/data_api/admin/subscription/subscription.proto

@@ -0,0 +1,91 @@
+syntax = "proto3";
+
+package devvit.dev_portal.data_api.admin.subscription;
+
+import "devvit/data/api/v1alpha/admin.proto";
+import "devvit/options/options.proto";
+import "devvit/reddit/v2alpha/subredditv2.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/devportal/data_api/admin/subscription";
+
+// region Subscription messages
+message CreateDataSubscriptionRequest {
+  devvit.options.DataTier tier = 1;
+  repeated devvit.options.FirehoseEvent events = 2;
+  repeated string subreddits = 3;
+  repeated devvit.reddit.v2alpha.SubredditRating subreddit_ratings = 4;
+  string customer = 5;
+  string name = 6;
+  optional string description = 7;
+}
+message CreateDataSubscriptionResponse {
+  devvit.data.api.v1alpha.DataSubscription subscription = 1;
+}
+
+message GetDataSubscriptionByIdRequest {
+  string subscription_id = 1;
+}
+message GetDataSubscriptionByIdResponse {
+  devvit.data.api.v1alpha.DataSubscription subscription = 1;
+}
+
+message DataSubscriptionSubredditInfo {
+  // t5_ subreddit ID
+  // @example "t5_2qh1o"
+  string id = 1;
+  // Subreddit display name - not prefixed with r/
+  // @example "aww"
+  string name = 2;
+  // Subreddit icon URL
+  string icon = 3;
+  // Whether the subreddit is NSFW
+  bool is_nsfw = 4;
+}
+
+// Data subscription for UI consumption that includes hydrated subreddit info
+message UIDataSubscription {
+  // Subscription ID
+  string id = 1;
+  // Subscription name
+  string name = 2;
+  // Subscription description
+  optional string description = 3;
+  // Firehose events types the subscription is subscribed to
+  repeated devvit.options.FirehoseEvent events = 4;
+  // Subreddits the subscription is subscribed to
+  repeated DataSubscriptionSubredditInfo subreddits = 5;
+  // Subreddit ratings the subscription is subscribed to
+  repeated devvit.reddit.v2alpha.SubredditRating subreddit_ratings = 6;
+}
+
+message GetDataSubscriptionsByOrganizationNameRequest {
+  string organization_name = 1;
+}
+message GetDataSubscriptionsByOrganizationNameResponse {
+  repeated UIDataSubscription subscriptions = 1;
+}
+
+message UpdateDataSubscriptionRequest {
+  // Id of the subscription to update
+  string subscription_id = 1;
+  // New name of the subscription
+  optional string name = 2;
+  // New description of the subscription
+  optional string description = 3;
+  // New data tier of the subscription.
+  optional devvit.options.DataTier tier = 4;
+  // New events. Will overwrite the array of existing events.
+  repeated devvit.options.FirehoseEvent events = 5;
+  // New subreddits. Will overwrite the array of existing subreddits.
+  repeated string subreddits = 6;
+  // New subreddit ratings. Will overwrite the array of existing subreddit ratings.
+  repeated devvit.reddit.v2alpha.SubredditRating subreddit_ratings = 7;
+}
+message UpdateDataSubscriptionResponse {
+  devvit.data.api.v1alpha.DataSubscription subscription = 1;
+}
+
+message DeleteDataSubscriptionRequest {
+  string subscription_id = 1;
+}
+message DeleteDataSubscriptionResponse {}

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/dev_portal/data_api/admin/user/user.proto

@@ -0,0 +1,44 @@
+syntax = "proto3";
+
+package devvit.dev_portal.data_api.admin.user;
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/devportal/data_api/admin/user";
+
+message User {
+  string t2id = 1;
+  string org_id = 2;
+  string username = 3;
+}
+
+message AddUsersToOrgRequest {
+  string org_id = 2;
+  repeated string usernames = 3;
+}
+
+message AddUsersToOrgResponse {
+  repeated User users = 1;
+}
+
+message GetUsersByOrgIdRequest {
+  string id = 1;
+}
+
+message GetUsersByOrgIdResponse {
+  repeated User users = 1;
+}
+
+message GetUserByIdRequest {
+  string t2id = 1;
+}
+
+message GetUserByIdResponse {
+  User user = 1;
+}
+
+message DeleteUserRequest {
+  string t2id = 1;
+}
+
+message DeleteUserResponse {
+  User user = 1;
+}