app.bsky.graph.defs

Shared type definitions.

class atproto_client.models.app.bsky.graph.defs.ListViewBasic

Bases: ModelBase

Definition model for app.bsky.graph.defs.

field avatar: Uri | None = None

Avatar.

field cid: Cid [Required]

Cid.

field indexed_at: DateTime | None = None

Indexed at.

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

Labels.

field list_item_count: int | None = None

List item count.

Constraints:
  • ge = 0

field name: str [Required]

Name.

Constraints:
  • min_length = 1

  • max_length = 64

field purpose: models.AppBskyGraphDefs.ListPurpose [Required]

Purpose.

field uri: AtUri [Required]

Uri.

field viewer: models.AppBskyGraphDefs.ListViewerState | None = None

Viewer.

class atproto_client.models.app.bsky.graph.defs.ListView

Bases: ModelBase

Definition model for app.bsky.graph.defs.

field avatar: Uri | None = None

Avatar.

field cid: Cid [Required]

Cid.

field creator: models.AppBskyActorDefs.ProfileView [Required]

Creator.

field description: str | None = None

Description.

Constraints:
  • max_length = 3000

field description_facets: List[models.AppBskyRichtextFacet.Main] | None = None

Description facets.

field indexed_at: DateTime [Required]

Indexed at.

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

Labels.

field list_item_count: int | None = None

List item count.

Constraints:
  • ge = 0

field name: str [Required]

Name.

Constraints:
  • min_length = 1

  • max_length = 64

field purpose: models.AppBskyGraphDefs.ListPurpose [Required]

Purpose.

field uri: AtUri [Required]

Uri.

field viewer: models.AppBskyGraphDefs.ListViewerState | None = None

Viewer.

class atproto_client.models.app.bsky.graph.defs.ListItemView

Bases: ModelBase

Definition model for app.bsky.graph.defs.

field subject: models.AppBskyActorDefs.ProfileView [Required]

Subject.

field subject_opted_out: bool | None = None
field uri: AtUri [Required]

Uri.

class atproto_client.models.app.bsky.graph.defs.StarterPackView

Bases: ModelBase

Definition model for app.bsky.graph.defs.

field cid: Cid [Required]

Cid.

field creator: models.AppBskyActorDefs.ProfileViewBasic [Required]

Creator.

field feeds: List[models.AppBskyFeedDefs.GeneratorView] | None = None
Constraints:
  • max_length = 3

field indexed_at: DateTime [Required]

Indexed at.

field joined_all_time_count: int | None = None

Joined all time count.

Constraints:
  • ge = 0

field joined_week_count: int | None = None

Joined week count.

Constraints:
  • ge = 0

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

Labels.

field list: models.AppBskyGraphDefs.ListViewBasic | None = None

List.

field list_items_sample: List[models.AppBskyGraphDefs.ListItemView] | None = None
Constraints:
  • max_length = 12

field record: UnknownType [Required]

Record.

Constraints:
  • __module__ = atproto_client.models.unknown_union

  • __firstlineno__ = 72

  • __doc__ = Annotation for lexicon unknown fields: any registered record type, else DotDict. Record types are looked up in the runtime registry rather than in a union fixed at import time, so a record defined by a package generated from custom lexicons is decoded to its own model.

  • __get_pydantic_core_schema__ = <bound method UnknownRecordFallback.__get_pydantic_core_schema__ of <class ‘atproto_client.models.unknown_union.UnknownRecordFallback’>>

  • __static_attributes__ = ()

  • __dict__ = {‘__module__’: ‘atproto_client.models.unknown_union’, ‘__firstlineno__’: 72, ‘__doc__’: ‘Annotation for lexicon unknown fields: any registered record type, else DotDict.nnRecord types are looked up in the runtime registry rather than in a union fixed at import time,nso a record defined by a package generated from custom lexicons is decoded to its own model.n’, ‘__get_pydantic_core_schema__’: <classmethod(<function UnknownRecordFallback.__get_pydantic_core_schema__ at 0x786e5ef30d60>)>, ‘__static_attributes__’: (), ‘__dict__’: <attribute ‘__dict__’ of ‘UnknownRecordFallback’ objects>, ‘__weakref__’: <attribute ‘__weakref__’ of ‘UnknownRecordFallback’ objects>}

  • __weakref__ = <attribute ‘__weakref__’ of ‘UnknownRecordFallback’ objects>

field uri: AtUri [Required]

Uri.

class atproto_client.models.app.bsky.graph.defs.StarterPackViewBasic

Bases: ModelBase

Definition model for app.bsky.graph.defs.

field cid: Cid [Required]

Cid.

field creator: models.AppBskyActorDefs.ProfileViewBasic [Required]

Creator.

field indexed_at: DateTime [Required]

Indexed at.

field joined_all_time_count: int | None = None

Joined all time count.

Constraints:
  • ge = 0

field joined_week_count: int | None = None

Joined week count.

Constraints:
  • ge = 0

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

Labels.

field list_item_count: int | None = None

List item count.

Constraints:
  • ge = 0

field record: UnknownType [Required]

Record.

Constraints:
  • __module__ = atproto_client.models.unknown_union

  • __firstlineno__ = 72

  • __doc__ = Annotation for lexicon unknown fields: any registered record type, else DotDict. Record types are looked up in the runtime registry rather than in a union fixed at import time, so a record defined by a package generated from custom lexicons is decoded to its own model.

  • __get_pydantic_core_schema__ = <bound method UnknownRecordFallback.__get_pydantic_core_schema__ of <class ‘atproto_client.models.unknown_union.UnknownRecordFallback’>>

  • __static_attributes__ = ()

  • __dict__ = {‘__module__’: ‘atproto_client.models.unknown_union’, ‘__firstlineno__’: 72, ‘__doc__’: ‘Annotation for lexicon unknown fields: any registered record type, else DotDict.nnRecord types are looked up in the runtime registry rather than in a union fixed at import time,nso a record defined by a package generated from custom lexicons is decoded to its own model.n’, ‘__get_pydantic_core_schema__’: <classmethod(<function UnknownRecordFallback.__get_pydantic_core_schema__ at 0x786e5ef30d60>)>, ‘__static_attributes__’: (), ‘__dict__’: <attribute ‘__dict__’ of ‘UnknownRecordFallback’ objects>, ‘__weakref__’: <attribute ‘__weakref__’ of ‘UnknownRecordFallback’ objects>}

  • __weakref__ = <attribute ‘__weakref__’ of ‘UnknownRecordFallback’ objects>

field uri: AtUri [Required]

Uri.

atproto_client.models.app.bsky.graph.defs.ListPurpose

List purpose

alias of models.AppBskyGraphDefs.Modlist | models.AppBskyGraphDefs.Curatelist | models.AppBskyGraphDefs.Referencelist | str

atproto_client.models.app.bsky.graph.defs.Modlist

A list of actors to apply an aggregate moderation action (mute/block) on.

alias of Literal[‘app.bsky.graph.defs#modlist’]

atproto_client.models.app.bsky.graph.defs.Curatelist

A list of actors used for curation purposes such as list feeds or interaction gating.

alias of Literal[‘app.bsky.graph.defs#curatelist’]

atproto_client.models.app.bsky.graph.defs.Referencelist

A list of actors used for only for reference purposes such as within a starter pack.

alias of Literal[‘app.bsky.graph.defs#referencelist’]

class atproto_client.models.app.bsky.graph.defs.ListViewerState

Bases: ModelBase

Definition model for app.bsky.graph.defs.

field blocked: AtUri | None = None

Blocked.

field muted: bool | None = None

Muted.

field reference_list_opt_out: AtUri | None = None
class atproto_client.models.app.bsky.graph.defs.NotFoundActor

Bases: ModelBase

Definition model for app.bsky.graph.defs. indicates that a handle or DID could not be resolved.

field actor: AtIdentifier [Required]

Actor.

field not_found: bool [Required]

Not found.

class atproto_client.models.app.bsky.graph.defs.Relationship

Bases: ModelBase

Definition model for app.bsky.graph.defs. lists the bi-directional graph relationships between one actor (not indicated in the object), and the target actors (the DID included in the object).

field blocked_by: AtUri | None = None
field blocked_by_list: AtUri | None = None
field blocking: AtUri | None = None
field blocking_by_list: AtUri | None = None
field did: Did [Required]

Did.

field followed_by: AtUri | None = None
field following: AtUri | None = None