Core Types

message User {
  fixed64 id = 1;  // @snowflake<User>
  string name = 2;
  optional string username = 3;
  optional UserStatus status = 4;
  optional ChatPhoto photo = 5;
  bool bot = 6;
  optional fixed64 icon = 7;  // @snowflake<Emoji>
  optional uint32 color = 8;
}

message ChatPhoto {
  fixed64 file_id = 1;  // @snowflake<File>
  bytes preview = 2;
}

message UserStatus {
  enum Status {
    ONLINE = 0;
    IDLE = 1;
  }
  bool online = 2 [deprecated = true];
  optional Status status = 3;
}

message Message {
  enum MessageType {
    UNKNOWN = 0;
    CALL = 1;
    JOIN = 2;
    LEAVE = 3;
  }

  message MessageForwardInfo {}

  refs.ChatRef chat_ref = 1;
  fixed64 message_id = 2;  // @snowflake<Message>
  fixed64 author_id = 3;  // @snowflake<User>
  string message = 4;
  optional fixed64 reply_to = 5;  // @snowflake<Message>
  repeated media.MessageMedia media = 6;
  repeated MessageEntity entities = 7;
  optional uint64 edited_at = 8;
  optional MessageType type = 9;
  optional MessageForwardInfo forward = 10;
}

message MessageEntity {
  uint32 start_index = 1;
  uint32 length = 2;

  message CustomEmojiEntity {
    fixed64 emoji_id = 1;  // @snowflake<Emoji>
  }

  message TextUrlEntity { string url = 1; }
  message PreEntity { optional string language = 1; }
  message SpoilerEntity {}
  message UserMentionEntity {}

  oneof entity {
    bool bold = 3;
    bool italic = 4;
    bool underline = 5;
    bool strikethrough = 6;
    bool code = 7;
    bool url = 8;
    SpoilerEntity spoiler = 9;
    PreEntity pre = 10;
    TextUrlEntity textUrl = 11;
    CustomEmojiEntity custom_emoji = 12;
    UserMentionEntity user_mention = 13;
    bool username = 14;
  }
}

message Channel {
  fixed64 id = 1;  // @snowflake<Channel>
  fixed64 community_id = 2;  // @snowflake<Community>
  string name = 3;
  ChannelType type = 4;
  uint32 position = 5;
  optional fixed64 parent_id = 6;  // @snowflake<Channel>
}

enum ChannelType {
  TEXT = 0;
  VOICE = 1;
  CATEGORY = 2;
}

message Community {
  fixed64 id = 1;  // @snowflake<Community>
  bool owner = 2;
  string name = 3;
  optional ChatPhoto photo = 4;
  fixed64 permissions = 5;
  bool muted = 6;
}

message CommunityMember {
  fixed64 id = 1;  // @snowflake<User>
  fixed64 community_id = 2;  // @snowflake<Community>
  repeated fixed64 role_ids = 3;  // @snowflake<Role>
  optional string nickname = 4;
}

message CommunityRole {
  fixed64 id = 1;  // @snowflake<Role>
  fixed64 community_id = 2;  // @snowflake<Community>
  string name = 3;
  fixed64 permissions = 4;
  uint32 priority = 5;
  uint32 color = 6;
  bool separated = 7;
  bool public = 8;
}

enum CommunityPermission {
  NO_PERMISSION = 0;
  ADMINISTRATOR = 1;      // 1<<0
  VIEW_CHANNEL = 2;       // 1<<1
  SEND_MESSAGES = 4;      // 1<<2
  CONNECT_VOICE = 8;      // 1<<3
  MODIFY_CHANNEL = 16;    // 1<<4
  SEND_MEDIA = 32;        // 1<<5
  DELETE_MESSAGES = 64;   // 1<<6
  PIN_MESSAGES = 128;     // 1<<7
  SPEAK_VOICE = 256;      // 1<<8
  MODIFY_COMMUNITY = 512; // 1<<9
  MODIFY_ROLES = 1024;    // 1<<10
  REMOVE_MEMBERS = 2048;  // 1<<11
}

message PermissionOverrides {
  fixed64 pos = 1;
  fixed64 neg = 2;
}

message ChannelOverride {
  fixed64 community_id = 1;  // @snowflake<Community>
  fixed64 channel_id = 2;    // @snowflake<Channel>
  fixed64 role_id = 3;       // @snowflake<Role>
  PermissionOverrides permissions = 4;
}

message Group {
  fixed64 id = 1;  // @snowflake<Chat>
  string name = 2;
  bool owner = 3;
  repeated fixed64 participant_ids = 4;  // @snowflake<User>
}

message Conversation {
  refs.ChatRef chat_ref = 1;
  fixed64 last_message_id = 2;      // @snowflake<Message>
  fixed64 last_read_message_id = 3; // @snowflake<Message>
  reserved 4;
  uint32 unread_count = 5;
  optional string draft = 6;
  optional PermissionOverrides permissions = 7;
  bool muted = 8;
}

enum RelationshipStatus {
  INVALID = 0;
  FRIEND = 1;
  FRIEND_REQUEST_INCOMING = 2;
  FRIEND_REQUEST_OUTGOING = 3;
  BLOCKED = 4;
  SUGGESTED_FRIEND = 5;
}

message Relationship {
  fixed64 user_id = 1;  // @snowflake<User>
  RelationshipStatus status = 2;
}

message Entrypoint {
  string hostname = 1;
  optional string ip_address = 2;
  uint32 port = 3;
  uint32 region = 4;
}