@devvit/protos 0.11.4 → 0.11.5-next-2024-12-09-8401a61d8.0

package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/audit.proto

@@ -0,0 +1,72 @@
+syntax = "proto3";
+
+package devvit.data.api.admin.v1alpha;
+
+import "devvit/data/api/admin/v1alpha/organization.proto";
+import "google/protobuf/timestamp.proto";
+
+option go_package = "github.snooguts.net/reddit/data-api-firehose/generated/protos/types/admin";
+
+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;
+}
+
+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 = 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 {
+  Organization organization = 1;
+}
+
+message GetAuditLogEventsByOrganizationNameRequest {
+  string organization_name = 1;
+}
+
+message GetAuditLogEventsByOrganizationNameResponse {
+  repeated AuditLogEvent events = 1;
+}
+
+message CreateAuditLogEventRequest {
+  AuditLogEvent event = 1;
+}
+
+message CreateAuditLogEventResponse {}

package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/auth.proto

@@ -0,0 +1,49 @@
+syntax = "proto3";
+
+package devvit.data.api.admin.v1alpha;
+
+import "google/protobuf/duration.proto";
+import "google/protobuf/timestamp.proto";
+
+option go_package = "github.snooguts.net/reddit/data-api-firehose/generated/protos/types/admin";
+
+message AccessToken {
+  string id = 1;
+  string organization_id = 2;
+  google.protobuf.Timestamp created_at = 3;
+  google.protobuf.Timestamp expires_at = 4;
+  bool is_revoked = 5;
+}
+
+message CreateAccessTokenRequest {
+  string organization_name = 1;
+  google.protobuf.Duration expires_in = 2;
+}
+
+message CreateAccessTokenResponse {
+  string token = 1;
+  google.protobuf.Timestamp expires_at = 2;
+  string token_id = 3;
+}
+
+message GetAccessTokenByIdRequest {
+  string id = 1;
+}
+
+message GetAccessTokenByIdResponse {
+  AccessToken token = 1;
+}
+
+message GetAccessTokensByOrganizationNameRequest {
+  string organization_name = 1;
+}
+
+message GetAccessTokensByOrganizationNameResponse {
+  repeated AccessToken tokens = 1;
+}
+
+message RevokeAccessTokenByIdRequest {
+  string token_id = 1;
+}
+
+message RevokeAccessTokenByIdResponse {}

package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/organization.proto

@@ -0,0 +1,54 @@
+syntax = "proto3";
+
+package devvit.data.api.admin.v1alpha;
+
+import "google/protobuf/timestamp.proto";
+
+option go_package = "github.snooguts.net/reddit/data-api-firehose/generated/protos/types/admin";
+
+message Organization {
+  string id = 1;
+  string name = 2;
+  bool is_internal = 3;
+  google.protobuf.Timestamp contract_end_date = 4;
+}
+
+message CreateOrganizationRequest {
+  string name = 1;
+  bool is_internal = 2;
+  google.protobuf.Timestamp contract_end_date = 3;
+}
+
+message CreateOrganizationResponse {
+  Organization organization = 1;
+}
+
+message DeleteOrganizationRequest {
+  string id = 1;
+}
+
+message DeleteOrganizationResponse {
+  Organization organization = 1;
+}
+
+message GetOrganizationByNameRequest {
+  string name = 1;
+}
+
+message GetOrganizationByNameResponse {
+  Organization organization = 1;
+}
+
+message GetOrganizationByIdRequest {
+  string id = 1;
+}
+
+message GetOrganizationByIdResponse {
+  Organization organization = 1;
+}
+
+message GetOrganizationsRequest {}
+
+message GetOrganizationsResponse {
+  repeated Organization organizations = 1;
+}

package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/service.proto

@@ -0,0 +1,46 @@
+syntax = "proto3";
+
+package devvit.data.api.admin.v1alpha;
+
+import "devvit/data/api/admin/v1alpha/audit.proto";
+import "devvit/data/api/admin/v1alpha/auth.proto";
+import "devvit/data/api/admin/v1alpha/organization.proto";
+import "devvit/data/api/admin/v1alpha/subscription.proto";
+import "devvit/data/api/admin/v1alpha/ui.proto";
+import "devvit/data/api/admin/v1alpha/user.proto";
+
+option go_package = "github.snooguts.net/reddit/data-api-firehose/generated/protos/types/admin";
+
+service Admin {
+  // Auth
+  rpc CreateAccessToken(CreateAccessTokenRequest) returns (CreateAccessTokenResponse);
+  rpc GetAccessTokenById(GetAccessTokenByIdRequest) returns (GetAccessTokenByIdResponse);
+  rpc GetAccessTokensByOrganizationName(GetAccessTokensByOrganizationNameRequest) returns (GetAccessTokensByOrganizationNameResponse);
+  rpc RevokeAccessTokenById(RevokeAccessTokenByIdRequest) returns (RevokeAccessTokenByIdResponse);
+
+  // Subscriptions
+  rpc CreateSubscription(CreateSubscriptionRequest) returns (CreateSubscriptionResponse);
+  rpc GetSubscriptionById(GetSubscriptionByIdRequest) returns (GetSubscriptionByIdResponse);
+  rpc GetSubscriptionsByOrganizationName(GetSubscriptionsByOrganizationNameRequest) returns (GetSubscriptionsByOrganizationNameResponse);
+  rpc UpdateSubscription(UpdateSubscriptionRequest) returns (UpdateSubscriptionResponse);
+  rpc DeleteSubscription(DeleteSubscriptionRequest) returns (DeleteSubscriptionResponse);
+
+  // Organizations
+  rpc CreateOrganization(CreateOrganizationRequest) returns (CreateOrganizationResponse);
+  rpc DeleteOrganization(DeleteOrganizationRequest) returns (DeleteOrganizationResponse);
+  rpc GetOrganizationById(GetOrganizationByIdRequest) returns (GetOrganizationByIdResponse);
+  rpc GetOrganizationByName(GetOrganizationByNameRequest) returns (GetOrganizationByNameResponse);
+  rpc GetOrganizations(GetOrganizationsRequest) returns (GetOrganizationsResponse);
+
+  // Audit Logs
+  rpc GetAuditLogEventsByOrganizationName(GetAuditLogEventsByOrganizationNameRequest) returns (GetAuditLogEventsByOrganizationNameResponse);
+  rpc CreateAuditLogEvent(CreateAuditLogEventRequest) returns (CreateAuditLogEventResponse);
+
+  // UI Helpers
+  rpc UIGetHydratedOrganizations(UIGetOrganizationsRequest) returns (UIGetOrganizationsResponse);
+
+  rpc CreateUser(CreateUserRequest) returns (CreateUserResponse);
+  rpc GetUsersByOrgId(GetUsersByOrgIdRequest) returns (GetUsersByOrgIdResponse);
+  rpc GetUserById(GetUserByIdRequest) returns (GetUserByIdResponse);
+  rpc DeleteUser(DeleteUserRequest) returns (DeleteUserResponse);
+}

package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/subscription.proto

@@ -0,0 +1,72 @@
+syntax = "proto3";
+
+package devvit.data.api.admin.v1alpha;
+
+import "devvit/options/options.proto";
+import "devvit/reddit/v2alpha/subredditv2.proto";
+
+option go_package = "github.snooguts.net/reddit/data-api-firehose/generated/protos/types/admin";
+
+message Subscription {
+  string id = 1;
+  string name = 2;
+  string organization_id = 3;
+  string description = 4;
+  repeated devvit.options.FirehoseEvent events = 5;
+  repeated string subreddits = 6;
+  repeated devvit.reddit.v2alpha.SubredditRating subreddit_ratings = 7;
+}
+
+message CreateSubscriptionRequest {
+  repeated devvit.options.FirehoseEvent events = 1;
+  repeated string subreddits = 2;
+  repeated devvit.reddit.v2alpha.SubredditRating subreddit_ratings = 3;
+  string organization_id = 4;
+  string name = 5;
+  string description = 6;
+}
+
+message CreateSubscriptionResponse {
+  Subscription subscription = 1;
+}
+
+message GetSubscriptionByIdRequest {
+  string subscription_id = 1;
+}
+
+message GetSubscriptionByIdResponse {
+  Subscription subscription = 1;
+}
+
+message GetSubscriptionsByOrganizationNameRequest {
+  string organization_name = 1;
+}
+
+message GetSubscriptionsByOrganizationNameResponse {
+  repeated Subscription subscriptions = 1;
+}
+
+message UpdateSubscriptionRequest {
+  // 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 events. Will overwrite the array of existing events.
+  repeated devvit.options.FirehoseEvent events = 4;
+  // New subreddits. Will overwrite the array of existing subreddits.
+  repeated string subreddits = 5;
+  // New subreddit ratings. Will overwrite the array of existing subreddit ratings.
+  repeated devvit.reddit.v2alpha.SubredditRating subreddit_ratings = 6;
+}
+
+message UpdateSubscriptionResponse {
+  Subscription subscription = 1;
+}
+
+message DeleteSubscriptionRequest {
+  string subscription_id = 1;
+}
+
+message DeleteSubscriptionResponse {}

package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/ui.proto

@@ -0,0 +1,20 @@
+syntax = "proto3";
+
+package devvit.data.api.admin.v1alpha;
+
+import "devvit/data/api/admin/v1alpha/auth.proto";
+import "devvit/data/api/admin/v1alpha/organization.proto";
+import "devvit/data/api/admin/v1alpha/subscription.proto";
+
+option go_package = "github.snooguts.net/reddit/data-api-firehose/generated/protos/types/admin";
+
+message UIGetOrganizationsRequest {}
+
+message UIGetOrganizationsResponse {
+  message HydratedOrganization {
+    Organization organization = 1;
+    repeated Subscription subscriptions = 2;
+    repeated AccessToken acccess_tokens = 3;
+  }
+  repeated HydratedOrganization organizations = 1;
+}

package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/user.proto

@@ -0,0 +1,45 @@
+syntax = "proto3";
+
+package devvit.data.api.admin.v1alpha;
+
+option go_package = "github.snooguts.net/reddit/data-api-firehose/generated/protos/types/admin";
+
+message User {
+  string t2id = 1;
+  string org_id = 2;
+  string username = 3;
+}
+
+message CreateUserRequest {
+  string t2id = 1;
+  string org_id = 2;
+  string username = 3;
+}
+
+message CreateUserResponse {
+  User user = 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;
+}

package/schema/.snootobuf/deps/devvit/data/api/v1alpha/admin.proto

@@ -0,0 +1,54 @@
+syntax = "proto3";
+
+package devvit.data.api.v1alpha;
+
+import "devvit/options/options.proto";
+import "devvit/reddit/v2alpha/subredditv2.proto";
+import "google/protobuf/duration.proto";
+import "google/protobuf/timestamp.proto";
+
+option go_package = "github.snooguts.net/reddit/data-api-firehose/generated/protos/types/v1alpha";
+
+message DataToken {
+  string id = 1;
+  string organization_id = 2;
+  google.protobuf.Timestamp created_at = 3;
+  google.protobuf.Timestamp expires_at = 4;
+  bool is_revoked = 5;
+}
+
+message DataSubscription {
+  string id = 1;
+  devvit.options.DataTier tier = 2;
+  repeated devvit.options.FirehoseEvent events = 3;
+  repeated string subreddits = 4;
+
+  repeated devvit.reddit.v2alpha.SubredditRating subreddit_ratings = 5;
+  string organization_id = 6;
+  string name = 7;
+  optional string description = 8;
+}
+
+message Organization {
+  string id = 1;
+  string name = 2;
+  repeated DataSubscription subscriptions = 3;
+  repeated DataToken tokens = 4;
+  google.protobuf.Timestamp contract_end_date = 5;
+}
+
+message DataApiAuthTokenRequest {
+  string customer = 1;
+  google.protobuf.Duration expires_in = 2;
+}
+
+message DataApiAuthTokenResponse {
+  string id = 1;
+  string token = 2;
+  google.protobuf.Timestamp expires_at = 3;
+}
+
+// DataApiAuthTokenIssuer is the service that issues auth tokens for the data api
+service DataApiAuthTokenIssuer {
+  rpc GenerateAuthToken(DataApiAuthTokenRequest) returns (DataApiAuthTokenResponse);
+}