HoYoLAB Accompany Models

accompany

HoYoLAB character accompany models.

Classes:

• AccompanyAction –

  Action that grants accompany points.

• AccompanyAvatarFrame –

  Quarterly avatar frame reward progress.

• AccompanyAvatarFrameConfig –

  Avatar frame reward configuration.

• AccompanyAwardInfo –

  Accompany rewards and point-earning actions.

• AccompanyCharacter –

  Accompany character.

• AccompanyCharacterAttribute –

  Accompany character attribute.

• AccompanyCharacterDetails –

  Accompany character page details.

• AccompanyCharacterGame –

  Accompany character game.

• AccompanyCharacterInfo –

  Accompany character info.

• AccompanyCharacterProfile –

  Accompany character color and images.

• AccompanyFeedInfo –

  Post counts of an accompany character's feed.

• AccompanyInfo –

  Accompany progress of a character.

• AccompanyJump –

  Deep link to a location in the app or on the web.

• AccompanyLanternBonus –

  Lantern sign reward tier.

• AccompanyLanternConfig –

  Lantern sign event configuration.

• AccompanyLanternSign –

  Lantern sign event progress.

• AccompanyLanternTemplate –

  Suggested post template for the lantern sign event.

• AccompanyMomentPost –

  Official post shown on an accompany character's page.

• AccompanyPendant –

  Cosmetic unlockable with accompany points.

• AccompanyPopupDoc –

  Avatar frame popup document.

• AccompanyRecentPoster –

  Recent poster in an accompany character's topic.

• AccompanyResult –

  Accompany result.

• AccompanyTitle –

  Title earnable through accompanying.

• AccompanyTopicStats –

  Community statistics of an accompany character's topic.

• AccompanyVoiceLine –

  Accompany character voice line.

• AccompanyVoiceSetting –

  Voice and subtitle language setting of an accompany character.

• AccompanyWidget –

  Accompany character widget image assets.

• AccompanyWidgetImage –

  Widget image asset in two resolutions.

• AccompanyWikiImage –

  Accompany character wiki gallery image.

• AccompanyWikiVideo –

  Accompany character wiki video.

AccompanyAction pydantic-model

Action that grants accompany points.

Fields:

• action (str)
• points (int)
• max_points_per_day (int)
• done (bool)
• jump (Optional[AccompanyJump])

action pydantic-field

action: str

done pydantic-field

done: bool

jump pydantic-field

jump: Optional[AccompanyJump] = None

max_points_per_day pydantic-field

max_points_per_day: int

points pydantic-field

points: int

AccompanyAvatarFrame pydantic-model

Quarterly avatar frame reward progress.

Fields:

• config (AccompanyAvatarFrameConfig)
• id (int)
• quarter_days (int)
• accompanied_today (bool)

accompanied_today pydantic-field

accompanied_today: bool

config pydantic-field

config: AccompanyAvatarFrameConfig

id pydantic-field

id: int

quarter_days pydantic-field

quarter_days: int

AccompanyAvatarFrameConfig pydantic-model

Avatar frame reward configuration.

Fields:

• icon (str)
• popup_docs (Sequence[AccompanyPopupDoc])
• jump (AccompanyJump)
• quarter_begin_at (int)
• quarter_end_at (int)
• quarter_left_seconds (int)

icon pydantic-field

icon: str

jump pydantic-field

jump: AccompanyJump

popup_docs pydantic-field

popup_docs: Sequence[AccompanyPopupDoc]

quarter_begin_at pydantic-field

quarter_begin_at: int

quarter_end_at pydantic-field

quarter_end_at: int

quarter_left_seconds pydantic-field

quarter_left_seconds: int

AccompanyAwardInfo pydantic-model

Accompany rewards and point-earning actions.

Fields:

• pendants (Sequence[AccompanyPendant])
• actions (Sequence[AccompanyAction])
• titles (Sequence[AccompanyTitle])

actions pydantic-field

actions: Sequence[AccompanyAction]

pendants pydantic-field

pendants: Sequence[AccompanyPendant]

titles pydantic-field

titles: Sequence[AccompanyTitle]

AccompanyCharacter pydantic-model

Accompany character.

Fields:

• info (AccompanyCharacterInfo)
• profile (AccompanyCharacterProfile)
• attribute_ids (Sequence[int])

attribute_ids pydantic-field

attribute_ids: Sequence[int]

info pydantic-field

info: AccompanyCharacterInfo

profile pydantic-field

profile: AccompanyCharacterProfile

AccompanyCharacterAttribute pydantic-model

Accompany character attribute.

Fields:

• id (int)
• icon (str)
• corner_icon (str)

corner_icon pydantic-field

corner_icon: str

icon pydantic-field

icon: str

id pydantic-field

id: int

AccompanyCharacterDetails pydantic-model

Accompany character page details.

Fields:

• info (AccompanyCharacterInfo)
• profile (AccompanyCharacterProfile)
• accompany_info (AccompanyInfo)
• voice_scripts (Mapping[str, Sequence[AccompanyVoiceLine]])
• videos (Sequence[AccompanyWikiVideo])
• gallery (Sequence[AccompanyWikiImage])
• widget (Optional[AccompanyWidget])
• moment_posts (Sequence[AccompanyMomentPost])
• feed_info (AccompanyFeedInfo)
• game_jump_url (str)
• award_info (Optional[AccompanyAwardInfo])
• lantern_sign (Optional[AccompanyLanternSign])
• avatar_frame (Optional[AccompanyAvatarFrame])
• stats (Optional[AccompanyTopicStats])

Validators:

• __unnest_voice_scripts → voice_scripts
• __unnest_videos → videos
• __unnest_gallery → gallery
• __unnest_moment_posts → moment_posts

accompany_info pydantic-field

accompany_info: AccompanyInfo

avatar_frame pydantic-field

avatar_frame: Optional[AccompanyAvatarFrame] = None

award_info pydantic-field

award_info: Optional[AccompanyAwardInfo] = None

feed_info pydantic-field

feed_info: AccompanyFeedInfo

gallery pydantic-field

gallery: Sequence[AccompanyWikiImage]

game_jump_url pydantic-field

game_jump_url: str

info pydantic-field

info: AccompanyCharacterInfo

lantern_sign pydantic-field

lantern_sign: Optional[AccompanyLanternSign] = None

moment_posts pydantic-field

moment_posts: Sequence[AccompanyMomentPost]

profile pydantic-field

profile: AccompanyCharacterProfile

stats pydantic-field

stats: Optional[AccompanyTopicStats] = None

Topic statistics, not part of role_info but passed in by the client.

videos pydantic-field

videos: Sequence[AccompanyWikiVideo]

voice_scripts pydantic-field

voice_scripts: Mapping[str, Sequence[AccompanyVoiceLine]]

widget pydantic-field

widget: Optional[AccompanyWidget] = None

AccompanyCharacterGame pydantic-model

Accompany character game.

Fields:

• attributes (Sequence[Sequence[AccompanyCharacterAttribute]])
• id (int)
• icon (str)
• characters (Sequence[AccompanyCharacter])

Validators:

• __unnest_attributes → attributes

attributes pydantic-field

attributes: Sequence[Sequence[AccompanyCharacterAttribute]]

characters pydantic-field

characters: Sequence[AccompanyCharacter]

game property

game: Game

icon pydantic-field

icon: str

id pydantic-field

id: int

AccompanyCharacterInfo pydantic-model

Accompany character info.

Fields:

• role_id (int)
• game_id (int)
• name (str)
• brief_name (str)
• topic_id (int)
• game_name (str)

brief_name pydantic-field

brief_name: str

game_id pydantic-field

game_id: int

game_name pydantic-field

game_name: str

name pydantic-field

name: str

role_id pydantic-field

role_id: int

topic_id pydantic-field

topic_id: int

AccompanyCharacterProfile pydantic-model

Accompany character color and images.

Fields:

• card_color (str)
• bg_dark_color (str)
• bg_light_color (str)
• bg_card_color (str)
• card_image (str)
• video (str)
• icon (str)

bg_card_color pydantic-field

bg_card_color: str

bg_dark_color pydantic-field

bg_dark_color: str

bg_light_color pydantic-field

bg_light_color: str

card_color pydantic-field

card_color: str

card_image pydantic-field

card_image: str

icon pydantic-field

icon: str

video pydantic-field

video: str

AccompanyFeedInfo pydantic-model

Post counts of an accompany character's feed.

Fields:

• fan_art_posts (int)
• discussion_posts (int)
• yesterday_posts (int)
• total_posts (int)

discussion_posts pydantic-field

discussion_posts: int

fan_art_posts pydantic-field

fan_art_posts: int

total_posts pydantic-field

total_posts: int

yesterday_posts pydantic-field

yesterday_posts: int

AccompanyInfo pydantic-model

Accompany progress of a character.

Fields:

• days (int)
• quarter_days (int)
• accompanied_today (bool)
• can_accompany (bool)
• points (int)
• available_points (int)

accompanied_today pydantic-field

accompanied_today: bool

available_points pydantic-field

available_points: int

can_accompany pydantic-field

can_accompany: bool

days pydantic-field

days: int

points pydantic-field

points: int

quarter_days pydantic-field

quarter_days: int

AccompanyJump pydantic-model

Deep link to a location in the app or on the web.

Fields:

• text (str)
• app_path (str)
• web_path (str)

app_path pydantic-field

app_path: str

text pydantic-field

text: str

web_path pydantic-field

web_path: str

AccompanyLanternBonus pydantic-model

Lantern sign reward tier.

Fields:

• required_points (int)
• pendant_id (int)
• lifetime (int)
• title (str)
• light_icon (str)
• dark_icon (str)
• description (str)

dark_icon pydantic-field

dark_icon: str

description pydantic-field

description: str

lifetime pydantic-field

lifetime: int

light_icon pydantic-field

light_icon: str

pendant_id pydantic-field

pendant_id: int

required_points pydantic-field

required_points: int

title pydantic-field

title: str

AccompanyLanternConfig pydantic-model

Lantern sign event configuration.

Fields:

• bonuses (Sequence[AccompanyLanternBonus])
• templates (Sequence[AccompanyLanternTemplate])
• jump (AccompanyJump)
• quarter_begin_at (int)
• quarter_end_at (int)
• quarter_left_seconds (int)
• light_icon (str)
• dark_icon (str)

bonuses pydantic-field

bonuses: Sequence[AccompanyLanternBonus]

dark_icon pydantic-field

dark_icon: str

jump pydantic-field

jump: AccompanyJump

light_icon pydantic-field

light_icon: str

quarter_begin_at pydantic-field

quarter_begin_at: int

quarter_end_at pydantic-field

quarter_end_at: int

quarter_left_seconds pydantic-field

quarter_left_seconds: int

templates pydantic-field

templates: Sequence[AccompanyLanternTemplate]

AccompanyLanternSign pydantic-model

Lantern sign event progress.

Fields:

• config (AccompanyLanternConfig)
• pendant_id (int)
• post_points (int)
• total_post_points (int)
• post_points_today (int)
• accompany_points (int)
• total_accompany_points (int)
• accompany_days (int)
• accompanied_today (bool)
• wearing (bool)
• has_got (bool)
• expire_at (int)

accompanied_today pydantic-field

accompanied_today: bool

accompany_days pydantic-field

accompany_days: int

accompany_points pydantic-field

accompany_points: int

config pydantic-field

config: AccompanyLanternConfig

expire_at pydantic-field

expire_at: int

has_got pydantic-field

has_got: bool

pendant_id pydantic-field

pendant_id: int

post_points pydantic-field

post_points: int

post_points_today pydantic-field

post_points_today: int

total_accompany_points pydantic-field

total_accompany_points: int

total_post_points pydantic-field

total_post_points: int

wearing pydantic-field

wearing: bool

AccompanyLanternTemplate pydantic-model

Suggested post template for the lantern sign event.

Fields:

• subject (str)
• game_id (int)
• classification_id (int)
• topic_ids (Sequence[int])

classification_id pydantic-field

classification_id: int

game_id pydantic-field

game_id: int

subject pydantic-field

subject: str

topic_ids pydantic-field

topic_ids: Sequence[int]

AccompanyMomentPost pydantic-model

Official post shown on an accompany character's page.

Fields:

• id (int)
• game_id (int)
• subject (str)
• content (str)
• lang (str)
• created_at (UnixDateTime)

content pydantic-field

content: str

created_at pydantic-field

created_at: UnixDateTime

game_id pydantic-field

game_id: int

id pydantic-field

id: int

lang pydantic-field

lang: str

subject pydantic-field

subject: str

AccompanyPendant pydantic-model

Cosmetic unlockable with accompany points.

Fields:

• id (int)
• icon (str)
• lifetime (str)
• source (str)
• type (str)
• cost (int)
• award_type (str)
• is_owned (bool)
• can_use (bool)
• in_use (bool)
• jump (Optional[AccompanyJump])

award_type pydantic-field

award_type: str

can_use pydantic-field

can_use: bool

cost pydantic-field

cost: int

icon pydantic-field

icon: str

id pydantic-field

id: int

in_use pydantic-field

in_use: bool

is_owned pydantic-field

is_owned: bool

jump pydantic-field

jump: Optional[AccompanyJump] = None

lifetime pydantic-field

lifetime: str

source pydantic-field

source: str

type pydantic-field

type: str

AccompanyPopupDoc pydantic-model

Avatar frame popup document.

Fields:

• day (str)
• icon (str)
• description (str)

day pydantic-field

day: str

description pydantic-field

description: str

icon pydantic-field

icon: str

AccompanyRecentPoster pydantic-model

Recent poster in an accompany character's topic.

Fields:

• uid (int)
• posted_at (UnixDateTime)

posted_at pydantic-field

posted_at: UnixDateTime

uid pydantic-field

uid: int

AccompanyResult pydantic-model

Accompany result.

Fields:

• accompany_days (int)
• points_increased (int)

accompany_days pydantic-field

accompany_days: int

points_increased pydantic-field

points_increased: int

AccompanyTitle pydantic-model

Title earnable through accompanying.

Fields:

• title (str)
• name (str)
• description (str)
• icon (str)
• highlight_icon (str)
• is_owned (bool)

description pydantic-field

description: str

highlight_icon pydantic-field

highlight_icon: str

icon pydantic-field

icon: str

is_owned pydantic-field

is_owned: bool

name pydantic-field

name: str

title pydantic-field

title: str

AccompanyTopicStats pydantic-model

Community statistics of an accompany character's topic.

Fields:

• topic_id (int)
• views (int)
• replies (int)
• members (int)
• posts (int)
• today_posts (int)
• week_posts (int)
• recent_posters (Sequence[AccompanyRecentPoster])

members pydantic-field

members: int

posts pydantic-field

posts: int

recent_posters pydantic-field

recent_posters: Sequence[AccompanyRecentPoster]

replies pydantic-field

replies: int

today_posts pydantic-field

today_posts: int

topic_id pydantic-field

topic_id: int

views pydantic-field

views: int

week_posts pydantic-field

week_posts: int

AccompanyVoiceLine pydantic-model

Accompany character voice line.

Fields:

• voice_url (str)
• text (str)

text pydantic-field

text: str

voice_url pydantic-field

voice_url: str

AccompanyVoiceSetting pydantic-model

Voice and subtitle language setting of an accompany character.

Fields:

• voice_lang (str)
• script_lang (str)
• updated_at (UnixDateTime)

script_lang pydantic-field

script_lang: str

updated_at pydantic-field

updated_at: UnixDateTime

voice_lang pydantic-field

voice_lang: str

AccompanyWidget pydantic-model

Accompany character widget image assets.

Fields:

• role_image (AccompanyWidgetImage)
• component_image (AccompanyWidgetImage)
• emoji_image (AccompanyWidgetImage)
• background_url (str)

background_url pydantic-field

background_url: str

component_image pydantic-field

component_image: AccompanyWidgetImage

emoji_image pydantic-field

emoji_image: AccompanyWidgetImage

role_image pydantic-field

role_image: AccompanyWidgetImage

AccompanyWidgetImage pydantic-model

Widget image asset in two resolutions.

Fields:

• img_2x (str)
• img_3x (str)

img_2x pydantic-field

img_2x: str

img_3x pydantic-field

img_3x: str

AccompanyWikiImage pydantic-model

Accompany character wiki gallery image.

Fields:

• image_url (str)
• origin_url (str)
• height (int)
• width (int)
• size (int)
• synced_at (UnixDateTime)

height pydantic-field

height: int

image_url pydantic-field

image_url: str

origin_url pydantic-field

origin_url: str

size pydantic-field

size: int

synced_at pydantic-field

synced_at: UnixDateTime

width pydantic-field

width: int

AccompanyWikiVideo pydantic-model

Accompany character wiki video.

Fields:

• video_id (str)
• video_url (str)
• cover_url (str)
• synced_at (UnixDateTime)
• sort (int)

cover_url pydantic-field

cover_url: str

sort pydantic-field

sort: int

synced_at pydantic-field

synced_at: UnixDateTime

video_id pydantic-field

video_id: str

video_url pydantic-field

video_url: str