app.bsky.actor.defs¶

class atproto_client.models.app.bsky.actor.defs.AdultContentPref¶

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field enabled: bool = False¶: Enabled.

field py_type: Literal['app.bsky.actor.defs#adultContentPref'] = 'app.bsky.actor.defs#adultContentPref'¶

class atproto_client.models.app.bsky.actor.defs.BskyAppProgressGuide¶

Bases: ModelBase

Definition model for app.bsky.actor.defs. If set, an active progress guide. Once completed, can be set to undefined. Should have unspecced fields tracking progress.

field guide: str [Required]¶

Guide.

Constraints:

max_length = 100

field py_type: Literal['app.bsky.actor.defs#bskyAppProgressGuide'] = 'app.bsky.actor.defs#bskyAppProgressGuide'¶

class atproto_client.models.app.bsky.actor.defs.BskyAppStatePref¶

Bases: ModelBase

Definition model for app.bsky.actor.defs. A grab bag of state that’s specific to the bsky.app program. Third-party apps shouldn’t use this.

field active_progress_guide: models.AppBskyActorDefs.BskyAppProgressGuide | None = None¶: Active progress guide.

field nuxs: List[models.AppBskyActorDefs.Nux] | None = None¶

Storage for NUXs the user has encountered.

Constraints:

max_length = 100

field py_type: Literal['app.bsky.actor.defs#bskyAppStatePref'] = 'app.bsky.actor.defs#bskyAppStatePref'¶

field queued_nudges: List[str] | None = None¶

An array of tokens which identify nudges (modals, popups, tours, highlight dots) that should be shown to the user.

Constraints:

max_length = 1000

class atproto_client.models.app.bsky.actor.defs.ContentLabelPref¶

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field label: str [Required]¶: Label.

field labeler_did: str | None = None¶

field py_type: Literal['app.bsky.actor.defs#contentLabelPref'] = 'app.bsky.actor.defs#contentLabelPref'¶

field visibility: Literal['ignore'] | Literal['show'] | Literal['warn'] | Literal['hide'] | str [Required]¶: Visibility.

class atproto_client.models.app.bsky.actor.defs.FeedViewPref¶

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field feed: str [Required]¶: The URI of the feed, or an identifier which describes the feed.

field hide_quote_posts: bool | None = None¶: Hide quote posts in the feed.

field hide_replies: bool | None = None¶: Hide replies in the feed.

field hide_replies_by_like_count: int | None = None¶

field hide_replies_by_unfollowed: bool | None = True¶: Hide replies in the feed if they are not by followed users.

field hide_reposts: bool | None = None¶: Hide reposts in the feed.

field py_type: Literal['app.bsky.actor.defs#feedViewPref'] = 'app.bsky.actor.defs#feedViewPref'¶

class atproto_client.models.app.bsky.actor.defs.HiddenPostsPref¶

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field items: List[str[str]] [Required]¶: A list of URIs of posts the account owner has hidden.

field py_type: Literal['app.bsky.actor.defs#hiddenPostsPref'] = 'app.bsky.actor.defs#hiddenPostsPref'¶

class atproto_client.models.app.bsky.actor.defs.InterestsPref¶

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field py_type: Literal['app.bsky.actor.defs#interestsPref'] = 'app.bsky.actor.defs#interestsPref'¶

field tags: List[str] [Required]¶

A list of tags which describe the account owner’s interests gathered during onboarding.

Constraints:

max_length = 100

class atproto_client.models.app.bsky.actor.defs.KnownFollowers¶

Bases: ModelBase

Definition model for app.bsky.actor.defs. The subject’s followers whom you also follow.

field count: int [Required]¶: Count.

field followers: List[models.AppBskyActorDefs.ProfileViewBasic] [Required]¶

Followers.

Constraints:

min_length = 0
max_length = 5

field py_type: Literal['app.bsky.actor.defs#knownFollowers'] = 'app.bsky.actor.defs#knownFollowers'¶

class atproto_client.models.app.bsky.actor.defs.LabelerPrefItem¶

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field did: str [Required]¶

Did.

Constraints:

func = <function only_validate_if_strict.<locals>.wrapper at 0x7f7d65a12160>
json_schema_input_type = PydanticUndefined

field py_type: Literal['app.bsky.actor.defs#labelerPrefItem'] = 'app.bsky.actor.defs#labelerPrefItem'¶

class atproto_client.models.app.bsky.actor.defs.LabelersPref¶

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field labelers: List[models.AppBskyActorDefs.LabelerPrefItem] [Required]¶: Labelers.

field py_type: Literal['app.bsky.actor.defs#labelersPref'] = 'app.bsky.actor.defs#labelersPref'¶

class atproto_client.models.app.bsky.actor.defs.MutedWord¶

Bases: ModelBase

Definition model for app.bsky.actor.defs. A word that the account owner has muted.

field actor_target: Literal['all'] | Literal['exclude-following'] | str | None = 'all'¶

field expires_at: str | None = None¶

field id: str | None = None¶: Id.

field py_type: Literal['app.bsky.actor.defs#mutedWord'] = 'app.bsky.actor.defs#mutedWord'¶

field targets: List[models.AppBskyActorDefs.MutedWordTarget] [Required]¶: The intended targets of the muted word.

field value: str [Required]¶

The muted word itself.

Constraints:

max_length = 10000

atproto_client.models.app.bsky.actor.defs.MutedWordTarget¶

Muted word target

alias of Union[Literal[‘content’], Literal[‘tag’], str]

class atproto_client.models.app.bsky.actor.defs.MutedWordsPref¶

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field items: List[models.AppBskyActorDefs.MutedWord] [Required]¶: A list of words the account owner has muted.

field py_type: Literal['app.bsky.actor.defs#mutedWordsPref'] = 'app.bsky.actor.defs#mutedWordsPref'¶

class atproto_client.models.app.bsky.actor.defs.Nux¶

Bases: ModelBase

Definition model for app.bsky.actor.defs. A new user experiences (NUX) storage object.

field completed: bool = False¶: Completed.

field data: str | None = None¶

Arbitrary data for the NUX. The structure is defined by the NUX itself. Limited to 300 characters.

Constraints:

max_length = 3000

field expires_at: str | None = None¶

field id: str [Required]¶

Id.

Constraints:

max_length = 100

field py_type: Literal['app.bsky.actor.defs#nux'] = 'app.bsky.actor.defs#nux'¶

class atproto_client.models.app.bsky.actor.defs.PersonalDetailsPref¶

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field birth_date: str | None = None¶: The birth date of account owner.

field py_type: Literal['app.bsky.actor.defs#personalDetailsPref'] = 'app.bsky.actor.defs#personalDetailsPref'¶

class atproto_client.models.app.bsky.actor.defs.ProfileAssociated¶

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field chat: models.AppBskyActorDefs.ProfileAssociatedChat | None = None¶: Chat.

field feedgens: int | None = None¶: Feedgens.

field labeler: bool | None = None¶: Labeler.

field lists: int | None = None¶: Lists.

field py_type: Literal['app.bsky.actor.defs#profileAssociated'] = 'app.bsky.actor.defs#profileAssociated'¶

field starter_packs: int | None = None¶: Starter packs.

class atproto_client.models.app.bsky.actor.defs.ProfileAssociatedChat¶

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field allow_incoming: Literal['all'] | Literal['none'] | Literal['following'] | str [Required]¶: Allow incoming.

field py_type: Literal['app.bsky.actor.defs#profileAssociatedChat'] = 'app.bsky.actor.defs#profileAssociatedChat'¶

class atproto_client.models.app.bsky.actor.defs.ProfileView¶

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field associated: models.AppBskyActorDefs.ProfileAssociated | None = None¶: Associated.

field avatar: str | None = None¶: Avatar.

field created_at: str | None = None¶: Created at.

field description: str | None = None¶

Description.

Constraints:

max_length = 2560

field did: str [Required]¶

Did.

Constraints:

func = <function only_validate_if_strict.<locals>.wrapper at 0x7f7d65a12160>
json_schema_input_type = PydanticUndefined

field display_name: str | None = None¶

Display name.

Constraints:

max_length = 640

field handle: str [Required]¶

Handle.

Constraints:

func = <function only_validate_if_strict.<locals>.wrapper at 0x7f7d65a12040>
json_schema_input_type = PydanticUndefined

field indexed_at: str | None = None¶: Indexed at.

field labels: List[models.ComAtprotoLabelDefs.Label] | None = None¶: Labels.

field py_type: Literal['app.bsky.actor.defs#profileView'] = 'app.bsky.actor.defs#profileView'¶

field viewer: models.AppBskyActorDefs.ViewerState | None = None¶: Viewer.

class atproto_client.models.app.bsky.actor.defs.ProfileViewBasic¶

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field associated: models.AppBskyActorDefs.ProfileAssociated | None = None¶: Associated.

field avatar: str | None = None¶: Avatar.

field created_at: str | None = None¶: Created at.

field did: str [Required]¶

Did.

Constraints:

func = <function only_validate_if_strict.<locals>.wrapper at 0x7f7d65a12160>
json_schema_input_type = PydanticUndefined

field display_name: str | None = None¶

Display name.

Constraints:

max_length = 640

field handle: str [Required]¶

Handle.

Constraints:

func = <function only_validate_if_strict.<locals>.wrapper at 0x7f7d65a12040>
json_schema_input_type = PydanticUndefined

field labels: List[models.ComAtprotoLabelDefs.Label] | None = None¶: Labels.

field py_type: Literal['app.bsky.actor.defs#profileViewBasic'] = 'app.bsky.actor.defs#profileViewBasic'¶

field viewer: models.AppBskyActorDefs.ViewerState | None = None¶: Viewer.

class atproto_client.models.app.bsky.actor.defs.ProfileViewDetailed¶

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field associated: models.AppBskyActorDefs.ProfileAssociated | None = None¶: Associated.

field avatar: str | None = None¶: Avatar.

field banner: str | None = None¶: Banner.

field created_at: str | None = None¶: Created at.

field description: str | None = None¶

Description.

Constraints:

max_length = 2560

field did: str [Required]¶

Did.

Constraints:

func = <function only_validate_if_strict.<locals>.wrapper at 0x7f7d65a12160>
json_schema_input_type = PydanticUndefined

field display_name: str | None = None¶

Display name.

Constraints:

max_length = 640

field followers_count: int | None = None¶: Followers count.

field follows_count: int | None = None¶: Follows count.

field handle: str [Required]¶

Handle.

Constraints:

func = <function only_validate_if_strict.<locals>.wrapper at 0x7f7d65a12040>
json_schema_input_type = PydanticUndefined

field indexed_at: str | None = None¶: Indexed at.

field joined_via_starter_pack: models.AppBskyGraphDefs.StarterPackViewBasic | None = None¶

field labels: List[models.ComAtprotoLabelDefs.Label] | None = None¶: Labels.

field pinned_post: models.ComAtprotoRepoStrongRef.Main | None = None¶: Pinned post.

field posts_count: int | None = None¶: Posts count.

field py_type: Literal['app.bsky.actor.defs#profileViewDetailed'] = 'app.bsky.actor.defs#profileViewDetailed'¶

field viewer: models.AppBskyActorDefs.ViewerState | None = None¶: Viewer.

class atproto_client.models.app.bsky.actor.defs.SavedFeed¶

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field id: str [Required]¶: Id.

field pinned: bool [Required]¶: Pinned.

field py_type: Literal['app.bsky.actor.defs#savedFeed'] = 'app.bsky.actor.defs#savedFeed'¶

field type: Literal['feed'] | Literal['list'] | Literal['timeline'] | str [Required]¶: Type.

field value: str [Required]¶: Value.

class atproto_client.models.app.bsky.actor.defs.SavedFeedsPref¶

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field pinned: List[str[str]] [Required]¶: Pinned.

field py_type: Literal['app.bsky.actor.defs#savedFeedsPref'] = 'app.bsky.actor.defs#savedFeedsPref'¶

field saved: List[str[str]] [Required]¶: Saved.

field timeline_index: int | None = None¶: Timeline index.

class atproto_client.models.app.bsky.actor.defs.SavedFeedsPrefV2¶

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field items: List[models.AppBskyActorDefs.SavedFeed] [Required]¶: Items.

field py_type: Literal['app.bsky.actor.defs#savedFeedsPrefV2'] = 'app.bsky.actor.defs#savedFeedsPrefV2'¶

class atproto_client.models.app.bsky.actor.defs.ThreadViewPref¶

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field prioritize_followed_users: bool | None = None¶: Show followed users at the top of all replies.

field py_type: Literal['app.bsky.actor.defs#threadViewPref'] = 'app.bsky.actor.defs#threadViewPref'¶

field sort: Literal['oldest'] | Literal['newest'] | Literal['most-likes'] | Literal['random'] | Literal['hotness'] | str | None = None¶: Sorting mode for threads.

class atproto_client.models.app.bsky.actor.defs.ViewerState¶

Bases: ModelBase

Definition model for app.bsky.actor.defs. Metadata about the requesting account’s relationship with the subject account. Only has meaningful content for authed requests.

field blocked_by: bool | None = None¶: Blocked by.

field blocking: str | None = None¶: Blocking.

field blocking_by_list: models.AppBskyGraphDefs.ListViewBasic | None = None¶: Blocking by list.

field followed_by: str | None = None¶: Followed by.

field following: str | None = None¶: Following.

field known_followers: models.AppBskyActorDefs.KnownFollowers | None = None¶: Known followers.

field muted: bool | None = None¶: Muted.

field muted_by_list: models.AppBskyGraphDefs.ListViewBasic | None = None¶: Muted by list.

field py_type: Literal['app.bsky.actor.defs#viewerState'] = 'app.bsky.actor.defs#viewerState'¶