syntax = "proto3";

package creator_subscription_settings;

option go_package = "creator_subscription_settings";

import "eventbus/owner.proto";

// BadgeFlairSetting refers to the expected values for a creator's badge flair setting.
enum BadgeFlairSetting {
  BADGE_FLAIR_SETTING_INVALID = 0;
  // none means "do not display badge flair on my subscriber badges"
  BADGE_FLAIR_SETTING_NONE = 1;
  // default means "display the twitch default badge flairs on my subscriber badges"
  BADGE_FLAIR_SETTING_DEFAULT = 2;
  // custom means "display the badge flair that I uploaded on my subscriber badges"
  BADGE_FLAIR_SETTING_CUSTOM = 3;
}

// CreatorSubscriptionSettingsUpdate occurs when a creator changes their subscription settings.
message CreatorSubscriptionSettingsUpdate {
  option (eventbus.owner.ldap_group) = "team-subs";
  // user_id refers to the creator who uploaded a new subscriber badge.
  string user_id = 1;
  // badge_flair_settings refers to what type of badge flair the creator wants to use for their channel. e.g. ["none", "custom", "default]
  BadgeFlairSetting badge_flair_settings = 2;
}
