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

package/schema/.snootobuf/deps/google/type/postal_address.proto

@@ -0,0 +1,135 @@
+// Copyright 2019 Google LLC.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+syntax = "proto3";
+
+package google.type;
+
+option cc_enable_arenas = true;
+option go_package = "google.golang.org/genproto/googleapis/type/postaladdress;postaladdress";
+option java_multiple_files = true;
+option java_outer_classname = "PostalAddressProto";
+option java_package = "com.google.type";
+option objc_class_prefix = "GTP";
+
+// Represents a postal address, e.g. for postal delivery or payments addresses.
+// Given a postal address, a postal service can deliver items to a premise, P.O.
+// Box or similar.
+// It is not intended to model geographical locations (roads, towns,
+// mountains).
+//
+// In typical usage an address would be created via user input or from importing
+// existing data, depending on the type of process.
+//
+// Advice on address input / editing:
+//  - Use an i18n-ready address widget such as
+//    https://github.com/google/libaddressinput)
+// - Users should not be presented with UI elements for input or editing of
+//   fields outside countries where that field is used.
+//
+// For more guidance on how to use this schema, please see:
+// https://support.google.com/business/answer/6397478
+message PostalAddress {
+  // The schema revision of the `PostalAddress`. This must be set to 0, which is
+  // the latest revision.
+  //
+  // All new revisions **must** be backward compatible with old revisions.
+  int32 revision = 1;
+
+  // Required. CLDR region code of the country/region of the address. This
+  // is never inferred and it is up to the user to ensure the value is
+  // correct. See http://cldr.unicode.org/ and
+  // http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
+  // for details. Example: "CH" for Switzerland.
+  string region_code = 2;
+
+  // Optional. BCP-47 language code of the contents of this address (if
+  // known). This is often the UI language of the input form or is expected
+  // to match one of the languages used in the address' country/region, or their
+  // transliterated equivalents.
+  // This can affect formatting in certain countries, but is not critical
+  // to the correctness of the data and will never affect any validation or
+  // other non-formatting related operations.
+  //
+  // If this value is not known, it should be omitted (rather than specifying a
+  // possibly incorrect default).
+  //
+  // Examples: "zh-Hant", "ja", "ja-Latn", "en".
+  string language_code = 3;
+
+  // Optional. Postal code of the address. Not all countries use or require
+  // postal codes to be present, but where they are used, they may trigger
+  // additional validation with other parts of the address (e.g. state/zip
+  // validation in the U.S.A.).
+  string postal_code = 4;
+
+  // Optional. Additional, country-specific, sorting code. This is not used
+  // in most regions. Where it is used, the value is either a string like
+  // "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
+  // alone, representing the "sector code" (Jamaica), "delivery area indicator"
+  // (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
+  string sorting_code = 5;
+
+  // Optional. Highest administrative subdivision which is used for postal
+  // addresses of a country or region.
+  // For example, this can be a state, a province, an oblast, or a prefecture.
+  // Specifically, for Spain this is the province and not the autonomous
+  // community (e.g. "Barcelona" and not "Catalonia").
+  // Many countries don't use an administrative area in postal addresses. E.g.
+  // in Switzerland this should be left unpopulated.
+  string administrative_area = 6;
+
+  // Optional. Generally refers to the city/town portion of the address.
+  // Examples: US city, IT comune, UK post town.
+  // In regions of the world where localities are not well defined or do not fit
+  // into this structure well, leave locality empty and use address_lines.
+  string locality = 7;
+
+  // Optional. Sublocality of the address.
+  // For example, this can be neighborhoods, boroughs, districts.
+  string sublocality = 8;
+
+  // Unstructured address lines describing the lower levels of an address.
+  //
+  // Because values in address_lines do not have type information and may
+  // sometimes contain multiple values in a single field (e.g.
+  // "Austin, TX"), it is important that the line order is clear. The order of
+  // address lines should be "envelope order" for the country/region of the
+  // address. In places where this can vary (e.g. Japan), address_language is
+  // used to make it explicit (e.g. "ja" for large-to-small ordering and
+  // "ja-Latn" or "en" for small-to-large). This way, the most specific line of
+  // an address can be selected based on the language.
+  //
+  // The minimum permitted structural representation of an address consists
+  // of a region_code with all remaining information placed in the
+  // address_lines. It would be possible to format such an address very
+  // approximately without geocoding, but no semantic reasoning could be
+  // made about any of the address components until it was at least
+  // partially resolved.
+  //
+  // Creating an address only containing a region_code and address_lines, and
+  // then geocoding is the recommended way to handle completely unstructured
+  // addresses (as opposed to guessing which parts of the address should be
+  // localities or administrative areas).
+  repeated string address_lines = 9;
+
+  // Optional. The recipient at the address.
+  // This field may, under certain circumstances, contain multiline information.
+  // For example, it might contain "care of" information.
+  repeated string recipients = 10;
+
+  // Optional. The name of the organization at the address.
+  string organization = 11;
+}

package/schema/.snootobuf/deps/google/type/quaternion.proto

@@ -0,0 +1,95 @@
+// Copyright 2019 Google LLC.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+syntax = "proto3";
+
+package google.type;
+
+option cc_enable_arenas = true;
+option go_package = "google.golang.org/genproto/googleapis/type/quaternion;quaternion";
+option java_multiple_files = true;
+option java_outer_classname = "QuaternionProto";
+option java_package = "com.google.type";
+option objc_class_prefix = "GTP";
+
+// A quaternion is defined as the quotient of two directed lines in a
+// three-dimensional space or equivalently as the quotient of two Euclidean
+// vectors (https://en.wikipedia.org/wiki/Quaternion).
+//
+// Quaternions are often used in calculations involving three-dimensional
+// rotations (https://en.wikipedia.org/wiki/Quaternions_and_spatial_rotation),
+// as they provide greater mathematical robustness by avoiding the gimbal lock
+// problems that can be encountered when using Euler angles
+// (https://en.wikipedia.org/wiki/Gimbal_lock).
+//
+// Quaternions are generally represented in this form:
+//
+//     w + xi + yj + zk
+//
+// where x, y, z, and w are real numbers, and i, j, and k are three imaginary
+// numbers.
+//
+// Our naming choice `(x, y, z, w)` comes from the desire to avoid confusion for
+// those interested in the geometric properties of the quaternion in the 3D
+// Cartesian space. Other texts often use alternative names or subscripts, such
+// as `(a, b, c, d)`, `(1, i, j, k)`, or `(0, 1, 2, 3)`, which are perhaps
+// better suited for mathematical interpretations.
+//
+// To avoid any confusion, as well as to maintain compatibility with a large
+// number of software libraries, the quaternions represented using the protocol
+// buffer below *must* follow the Hamilton convention, which defines `ij = k`
+// (i.e. a right-handed algebra), and therefore:
+//
+//     i^2 = j^2 = k^2 = ijk = −1
+//     ij = −ji = k
+//     jk = −kj = i
+//     ki = −ik = j
+//
+// Please DO NOT use this to represent quaternions that follow the JPL
+// convention, or any of the other quaternion flavors out there.
+//
+// Definitions:
+//
+//   - Quaternion norm (or magnitude): `sqrt(x^2 + y^2 + z^2 + w^2)`.
+//   - Unit (or normalized) quaternion: a quaternion whose norm is 1.
+//   - Pure quaternion: a quaternion whose scalar component (`w`) is 0.
+//   - Rotation quaternion: a unit quaternion used to represent rotation.
+//   - Orientation quaternion: a unit quaternion used to represent orientation.
+//
+// A quaternion can be normalized by dividing it by its norm. The resulting
+// quaternion maintains the same direction, but has a norm of 1, i.e. it moves
+// on the unit sphere. This is generally necessary for rotation and orientation
+// quaternions, to avoid rounding errors:
+// https://en.wikipedia.org/wiki/Rotation_formalisms_in_three_dimensions
+//
+// Note that `(x, y, z, w)` and `(-x, -y, -z, -w)` represent the same rotation,
+// but normalization would be even more useful, e.g. for comparison purposes, if
+// it would produce a unique representation. It is thus recommended that `w` be
+// kept positive, which can be achieved by changing all the signs when `w` is
+// negative.
+//
+message Quaternion {
+  // The x component.
+  double x = 1;
+
+  // The y component.
+  double y = 2;
+
+  // The z component.
+  double z = 3;
+
+  // The scalar component.
+  double w = 4;
+}

package/schema/.snootobuf/deps/google/type/timeofday.proto

@@ -0,0 +1,44 @@
+// Copyright 2019 Google LLC.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+syntax = "proto3";
+
+package google.type;
+
+option cc_enable_arenas = true;
+option go_package = "google.golang.org/genproto/googleapis/type/timeofday;timeofday";
+option java_multiple_files = true;
+option java_outer_classname = "TimeOfDayProto";
+option java_package = "com.google.type";
+option objc_class_prefix = "GTP";
+
+// Represents a time of day. The date and time zone are either not significant
+// or are specified elsewhere. An API may choose to allow leap seconds. Related
+// types are [google.type.Date][google.type.Date] and `google.protobuf.Timestamp`.
+message TimeOfDay {
+  // Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
+  // to allow the value "24:00:00" for scenarios like business closing time.
+  int32 hours = 1;
+
+  // Minutes of hour of day. Must be from 0 to 59.
+  int32 minutes = 2;
+
+  // Seconds of minutes of the time. Must normally be from 0 to 59. An API may
+  // allow the value 60 if it allows leap-seconds.
+  int32 seconds = 3;
+
+  // Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+  int32 nanos = 4;
+}

package/schema/.snootobuf/deps/openapi/helper.proto

@@ -0,0 +1,20 @@
+// From https://github.snooguts.net/reddit/protoc-gen-openapi/blob/main/openapi/helper.proto
+
+syntax = "proto3";
+
+package openapi;
+
+import "google/protobuf/descriptor.proto";
+import "google/protobuf/struct.proto";
+
+option go_package = "github.snooguts.net/reddit/devplatform-api/go/grpc/openapi";
+
+extend google.protobuf.MessageOptions {
+  //Add a json example
+  google.protobuf.Struct message_example = 66700;
+}
+
+extend google.protobuf.FieldOptions {
+  // Add an example to the field
+  optional string field_example = 66701;
+}

package/schema/.snootobuf/deps/products-api/protos/reddit/xpaymentsplatform/payproducts/v1/currencies.proto

@@ -0,0 +1,189 @@
+syntax = "proto3";
+
+package reddit.xpaymentsplatform.payproducts.v1;
+
+option go_package = "github.snooguts.net/reddit/reddit-service-pay-products/products-api/api/xpaymentsplatform/payproductspb/v1;payproductspb";
+
+enum Currency {
+  CURRENCY_UNSPECIFIED = 0;
+
+  AED = 1; // United Arab Emirates dirham
+  AFN = 2; // Afghan afghani
+  ALL = 3; // Albanian lek
+  AMD = 4; // Armenian dram
+  ANG = 5; // Netherlands Antillean guilder
+  AOA = 6; // Angolan kwanza
+  ARS = 7; // Argentine peso
+  AUD = 8; // Australian dollar
+  AWG = 9; // Aruban florin
+  AZN = 10; // Azerbaijani manat
+  BAM = 11; // Bosnia and Herzegovina convertible mark
+  BBD = 12; // Barbados dollar
+  BDT = 13; // Bangladeshi taka
+  BGN = 14; // Bulgarian lev
+  BHD = 15; // Bahraini dinar
+  BIF = 16; // Burundian franc
+  BMD = 17; // Bermudian dollar
+  BND = 18; // Brunei dollar
+  BOB = 19; // Boliviano
+  BOV = 20; // Bolivian Mvdol (funds code)
+  BRL = 21; // Brazilian real
+  BSD = 22; // Bahamian dollar
+  BTN = 23; // Bhutanese ngultrum
+  BWP = 24; // Botswana pula
+  BYN = 25; // Belarusian ruble
+  BZD = 26; // Belize dollar
+  CAD = 27; // Canadian dollar
+  CDF = 28; // Congolese franc
+  CHE = 29; // WIR euro (complementary currency)
+  CHF = 30; // Swiss franc
+  CHW = 31; // WIR franc (complementary currency)
+  CLF = 32; // Unidad de Fomento (funds code)
+  CLP = 33; // Chilean peso
+  CNY = 34; // Chinese yuan
+  COP = 35; // Colombian peso
+  COU = 36; // Unidad de Valor Real (UVR) (funds code)
+  CRC = 37; // Costa Rican colon
+  CUC = 38; // Cuban convertible peso
+  CUP = 39; // Cuban peso
+  CVE = 40; // Cape Verdean escudo
+  CZK = 41; // Czech koruna
+  DJF = 42; // Djiboutian franc
+  DKK = 43; // Danish krone
+  DOP = 44; // Dominican peso
+  DZD = 45; // Algerian dinar
+  EGP = 46; // Egyptian pound
+  ERN = 47; // Eritrean nakfa
+  ETB = 48; // Ethiopian birr
+  EUR = 49; // Euro
+  FJD = 50; // Fiji dollar
+  FKP = 51; // Falkland Islands pound
+  GBP = 52; // Pound sterling
+  GEL = 53; // Georgian lari
+  GHS = 54; // Ghanaian cedi
+  GIP = 55; // Gibraltar pound
+  GMD = 56; // Gambian dalasi
+  GNF = 57; // Guinean franc
+  GTQ = 58; // Guatemalan quetzal
+  GYD = 59; // Guyanese dollar
+  HKD = 60; // Hong Kong dollar
+  HNL = 61; // Honduran lempira
+  HRK = 62; // Croatian kuna
+  HTG = 63; // Haitian gourde
+  HUF = 64; // Hungarian forint
+  IDR = 65; // Indonesian rupiah
+  ILS = 66; // Israeli new shekel
+  INR = 67; // Indian rupee
+  IQD = 68; // Iraqi dinar
+  IRR = 69; // Iranian rial
+  ISK = 70; // Icelandic krona
+  JMD = 71; // Jamaican dollar
+  JOD = 72; // Jordanian dinar
+  JPY = 73; // Japanese yen
+  KES = 74; // Kenyan shilling
+  KGS = 75; // Kyrgyzstani som
+  KHR = 76; // Cambodian riel
+  KMF = 77; // Comoro franc
+  KPW = 78; // North Korean won
+  KRW = 79; // South Korean won
+  KWD = 80; // Kuwaiti dinar
+  KYD = 81; // Cayman Islands dollar
+  KZT = 82; // Kazakhstani tenge
+  LAK = 83; // Lao kip
+  LBP = 84; // Lebanese pound
+  LKR = 85; // Sri Lankan rupee
+  LRD = 86; // Liberian dollar
+  LSL = 87; // Lesotho loti
+  LYD = 88; // Libyan dinar
+  MAD = 89; // Moroccan dirham
+  MDL = 90; // Moldovan leu
+  MGA = 91; // Malagasy ariary
+  MKD = 92; // Macedonian denar
+  MMK = 93; // Myanmar kyat
+  MNT = 94; // Mongolian togrog
+  MOP = 95; // Macanese pataca
+  MRU = 96; // Mauritanian ouguiya
+  MUR = 97; // Mauritian rupee
+  MVR = 98; // Maldivian rufiyaa
+  MWK = 99; // Malawian kwacha
+  MXN = 100; // Mexican peso
+  MXV = 101; // Mexican Unidad de Inversion (UDI) (funds code)
+  MYR = 102; // Malaysian ringgit
+  MZN = 103; // Mozambican metical
+  NAD = 104; // Namibian dollar
+  NGN = 105; // Nigerian naira
+  NIO = 106; // Nicaraguan cordoba
+  NOK = 107; // Norwegian krone
+  NPR = 108; // Nepalese rupee
+  NZD = 109; // New Zealand dollar
+  OMR = 110; // Omani rial
+  PAB = 111; // Panamanian balboa
+  PEN = 112; // Peruvian sol
+  PGK = 113; // Papua New Guinean kina
+  PHP = 114; // Philippine peso
+  PKR = 115; // Pakistani rupee
+  PLN = 116; // Polish zloty
+  PYG = 117; // Paraguayan guarani
+  QAR = 118; // Qatari riyal
+  RON = 119; // Romanian leu
+  RSD = 120; // Serbian dinar
+  RUB = 121; // Russian ruble
+  RWF = 122; // Rwandan franc
+  SAR = 123; // Saudi riyal
+  SBD = 124; // Solomon Islands dollar
+  SCR = 125; // Seychelles rupee
+  SDG = 126; // Sudanese pound
+  SEK = 127; // Swedish krona/kronor
+  SGD = 128; // Singapore dollar
+  SHP = 129; // Saint Helena pound
+  SLL = 130; // Sierra Leonean leone
+  SOS = 131; // Somali shilling
+  SRD = 132; // Surinamese dollar
+  SSP = 133; // South Sudanese pound
+  STN = 134; // Sao Tome and Principe dobra
+  SVC = 135; // Salvadoran colon
+  SYP = 136; // Syrian pound
+  SZL = 137; // Swazi lilangeni
+  THB = 138; // Thai baht
+  TJS = 139; // Tajikistani somoni
+  TMT = 140; // Turkmenistan manat
+  TND = 141; // Tunisian dinar
+  TOP = 142; // Tongan pa anga
+  TRY = 143; // Turkish lira
+  TTD = 144; // Trinidad and Tobago dollar
+  TWD = 145; // New Taiwan dollar
+  TZS = 146; // Tanzanian shilling
+  UAH = 147; // Ukrainian hryvnia
+  UGX = 148; // Ugandan shilling
+  USD = 149; // United States dollar
+  USN = 150; // United States dollar (next day) (funds code)
+  UYI = 151; // Uruguay Peso en Unidades Indexadas (URUIURUI) (funds code)
+  UYU = 152; // Uruguayan peso
+  UYW = 153; // Unidad previsional
+  UZS = 154; // Uzbekistan som
+  VES = 155; // Venezuelan bolivar soberano
+  VND = 156; // Vietnamese dong
+  VUV = 157; // Vanuatu vatu
+  WST = 158; // Samoan tala
+  XAF = 159; // CFA franc BEAC
+  XAG = 160; // Silver (one troy ounce)
+  XAU = 161; // Gold (one troy ounce)
+  XBA = 162; // European Composite Unit (EURCO) (bond market unit)
+  XBB = 163; // European Monetary Unit (E.M.U.-6) (bond market unit)
+  XBC = 164; // European Unit of Account 9 (E.U.A.-9) (bond market unit)
+  XBD = 165; // European Unit of Account 17 (E.U.A.-17) (bond market unit)
+  XCD = 166; // East Caribbean dollar
+  XDR = 167; // Special drawing rights
+  XOF = 168; // CFA franc BCEAO
+  XPD = 169; // Palladium (one troy ounce)
+  XPF = 170; // CFP franc (franc Pacifique)
+  XPT = 171; // Platinum (one troy ounce)
+  XSU = 172; // SUCRE
+  XUA = 173; // ADB Unit of Account
+  YER = 174; // Yemeni rial
+  ZAR = 175; // South African rand
+  ZMW = 176; // Zambian kwacha
+  ZWL = 177; // Zimbabwean dollar
+
+  GOLD = 200; // Reddit internal currency
+}

package/schema/.snootobuf/deps/products-api/protos/reddit/xpaymentsplatform/payproducts/v1/payproducts.proto

@@ -0,0 +1,118 @@
+syntax = "proto3";
+
+package reddit.xpaymentsplatform.payproducts.v1;
+
+import "reddit/xpaymentsplatform/payproducts/v1/currencies.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-service-pay-products/products-api/api/xpaymentsplatform/payproductspb/v1;payproductspb";
+
+// DemoRequest should be replaced by the request message for your first RPC.
+message DemoRequest {
+  // Add (and document) your request parameters here.
+  string parameter = 1;
+}
+
+// DemoResponse should be replaced by the response message for your first RPC.
+message DemoResponse {
+  // Add (and document) your output fields here.
+  string output = 1;
+}
+
+// AuthDemoRequest should be replaced by the request message for your first RPC.
+message AuthDemoRequest {
+  // Add (and document) your request parameters here.
+  string what = 1;
+}
+
+// AuthDemoResponse should be replaced by the response message for your first RPC.
+message AuthDemoResponse {
+  // Add (and document) your output fields here.
+  string output = 1;
+}
+
+enum ProductType {
+  PRODUCT_TYPE_UNSPECIFIED = 0;
+  REDDIT_GOLD = 1;
+  AWARD = 2;
+}
+
+enum PaymentProvider {
+  PAYMENT_PROVIDER_UNSPECIFIED = 0;
+  STRIPE = 1;
+  PAYPAL = 2;
+  GOOGLE_INAPP = 3;
+  APPLE_INAPP = 4;
+  REDDIT_GOLD_PROVIDER = 5;
+}
+
+message Image {
+  string url = 1;
+  int32 width = 2;
+  int32 height = 3;
+}
+
+message Product {
+  string id = 1;
+  ProductType product_type = 2;
+  string name = 3; // internal name
+  PaymentProvider payment_provider = 4;
+  ProductPrice price = 5;
+  ProductPrice base_price = 6;
+  string external_id = 7;
+  map<string, Image> images = 8;
+  oneof metadata {
+    RedditGoldMetadata reddit_gold = 9;
+  }
+}
+
+message ProductPrice {
+  int32 amount = 1;
+  Currency currency = 2;
+}
+
+message RedditGoldMetadata {
+  int32 amount = 1;
+}
+
+message ClientInfo {
+  string app_name = 1;
+  string app_version = 2;
+  string request_ip = 3;
+  string country_code = 4;
+  string subdivision_code = 5;
+  string city_code = 6;
+}
+
+message GetProductsRequest {
+  ProductType product_type = 1;
+  repeated PaymentProvider payment_providers = 2;
+  Currency currency = 3;
+  ClientInfo client_info = 4;
+}
+
+message GetProductsResponse {
+  repeated Product products = 1;
+}
+
+message GetSpecificProductRequest {
+  string product_id = 1;
+  Currency currency = 2;
+}
+
+message GetSpecificProductResponse {
+  Product product = 1;
+}
+
+// Rename this RPC service and add your RPCs.
+service PayProductsService {
+  // Replace this RPC and its request and response messages.
+  rpc Demo(DemoRequest) returns (DemoResponse) {}
+
+  // This is like the endpoint above but it enforces authentication.
+  // Again, this should be replaced or removed based on your service requirements.
+  rpc AuthDemo(AuthDemoRequest) returns (AuthDemoResponse) {}
+
+  rpc GetProducts(GetProductsRequest) returns (GetProductsResponse) {}
+
+  rpc GetSpecificProduct(GetSpecificProductRequest) returns (GetSpecificProductResponse) {}
+}

package/schema/.snootobuf/deps/reddit/api/metadata/v1/metadata.proto

@@ -0,0 +1,55 @@
+syntax = "proto3";
+
+package reddit.api.metadata.v1;
+
+import "google/protobuf/descriptor.proto";
+import "google/protobuf/duration.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-api-metadata/api/go/metadata/v1;metadata";
+option java_multiple_files = true;
+option java_outer_classname = "MetadataProto";
+option java_package = "com.reddit.api.metadata.v1";
+
+extend google.protobuf.FieldOptions {
+  // Metadata describing the usage and behavior of API entity fields
+  EntityFieldMetadata entity_field_metadata = 79010000;
+}
+
+// The reddit metadata for an entity field. This message is used to encapsulate
+// and document information about reddit entities. An "entity" refers to messages
+// that represent permanent or semi-permanent resources, as opposed to ephemeral
+// messages, such as ones that are used to pass request arguments and responses.
+message EntityFieldMetadata {
+  // Level of sensitivity that the data stored in a field should be treated with.
+  enum SensitivityLevel {
+    // This is a default vault used to convey the absence of a value.
+    SENSITIVITY_LEVEL_UNSPECIFIED = 0;
+
+    // Value to denote fields that should be treated as user PII
+    SENSITIVITY_LEVEL_PII = 1;
+
+    // Value to describe fields that are visible to reddit administrators but not
+    // publicly visible to users.
+    SENSITIVITY_LEVEL_ADMIN = 2;
+
+    // Value to describe fields that are visible to all users regardless of authentication status.
+    SENSITIVITY_LEVEL_PUBLIC = 3;
+
+    // Value to describe fields that are visible only to the owner or owners of the entity
+    // the field is defined on. For example, a user is the owner of an account or link. Whereas
+    // a moderator with sufficient permissions is an owner of a subreddit. Private data should
+    // not be interpreted as PII, but PII is always private.
+    SENSITIVITY_LEVEL_PRIVATE = 4;
+  }
+
+  // The sensitivity level of the data stored in the annotated field
+  SensitivityLevel sensitivity_level = 1;
+
+  // An http url to the design doc which documents the purposed and introduction of this field to the API.
+  // New fields added by contributors must have this value populated
+  string design_doc_url = 2;
+
+  // The maximum duration the contents of this field can be cached or stored. After which, its value
+  // must be expunged. This is most commonly used to describe the retention period of fields which store PII.
+  google.protobuf.Duration max_retention = 3;
+}