app.bsky.graph.defs#
- atproto.xrpc_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]
- pydantic model atproto.xrpc_client.models.app.bsky.graph.defs.ListItemView#
Bases:
ModelBase
Definition model for
app.bsky.graph.defs
.Show JSON schema
{ "title": "ListItemView", "description": "Definition model for :obj:`app.bsky.graph.defs`.", "type": "object", "properties": { "subject": { "$ref": "#/$defs/ProfileView" }, "$type": { "const": "app.bsky.graph.defs#listItemView", "default": "app.bsky.graph.defs#listItemView", "title": "$Type" } }, "$defs": { "Label": { "additionalProperties": false, "description": "Definition model for :obj:`com.atproto.label.defs`. Metadata tag on an atproto resource (eg, repo or record)", "properties": { "cts": { "title": "Cts", "type": "string" }, "src": { "title": "Src", "type": "string" }, "uri": { "title": "Uri", "type": "string" }, "val": { "maxLength": 128, "title": "Val", "type": "string" }, "cid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Cid" }, "neg": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Neg" }, "$type": { "const": "com.atproto.label.defs#label", "default": "com.atproto.label.defs#label", "title": "$Type" } }, "required": [ "cts", "src", "uri", "val" ], "title": "Label", "type": "object" }, "ListViewBasic": { "additionalProperties": false, "description": "Definition model for :obj:`app.bsky.graph.defs`.", "properties": { "cid": { "title": "Cid", "type": "string" }, "name": { "maxLength": 64, "minLength": 1, "title": "Name", "type": "string" }, "purpose": { "anyOf": [ { "const": "app.bsky.graph.defs#modlist" }, { "const": "app.bsky.graph.defs#curatelist" } ], "title": "Purpose" }, "uri": { "title": "Uri", "type": "string" }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Avatar" }, "indexedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Indexedat" }, "viewer": { "anyOf": [ { "$ref": "#/$defs/ListViewerState" }, { "type": "null" } ], "default": null }, "$type": { "const": "app.bsky.graph.defs#listViewBasic", "default": "app.bsky.graph.defs#listViewBasic", "title": "$Type" } }, "required": [ "cid", "name", "purpose", "uri" ], "title": "ListViewBasic", "type": "object" }, "ListViewerState": { "additionalProperties": false, "description": "Definition model for :obj:`app.bsky.graph.defs`.", "properties": { "blocked": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Blocked" }, "muted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Muted" }, "$type": { "const": "app.bsky.graph.defs#listViewerState", "default": "app.bsky.graph.defs#listViewerState", "title": "$Type" } }, "title": "ListViewerState", "type": "object" }, "ProfileView": { "additionalProperties": false, "description": "Definition model for :obj:`app.bsky.actor.defs`.", "properties": { "did": { "title": "Did", "type": "string" }, "handle": { "title": "Handle", "type": "string" }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Avatar" }, "description": { "anyOf": [ { "maxLength": 2560, "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "displayName": { "anyOf": [ { "maxLength": 640, "type": "string" }, { "type": "null" } ], "default": null, "title": "Displayname" }, "indexedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Indexedat" }, "labels": { "anyOf": [ { "items": { "$ref": "#/$defs/Label" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Labels" }, "viewer": { "anyOf": [ { "$ref": "#/$defs/ViewerState" }, { "type": "null" } ], "default": null }, "$type": { "const": "app.bsky.actor.defs#profileView", "default": "app.bsky.actor.defs#profileView", "title": "$Type" } }, "required": [ "did", "handle" ], "title": "ProfileView", "type": "object" }, "ViewerState": { "additionalProperties": false, "description": "Definition model for :obj:`app.bsky.actor.defs`.", "properties": { "blockedBy": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Blockedby" }, "blocking": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Blocking" }, "blockingByList": { "anyOf": [ { "$ref": "#/$defs/ListViewBasic" }, { "type": "null" } ], "default": null }, "followedBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Followedby" }, "following": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Following" }, "muted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Muted" }, "mutedByList": { "anyOf": [ { "$ref": "#/$defs/ListViewBasic" }, { "type": "null" } ], "default": null }, "$type": { "const": "app.bsky.actor.defs#viewerState", "default": "app.bsky.actor.defs#viewerState", "title": "$Type" } }, "title": "ViewerState", "type": "object" } }, "additionalProperties": false, "required": [ "subject" ] }
- Fields:
- field py_type: typing_extensions.Literal[app.bsky.graph.defs#listItemView] = 'app.bsky.graph.defs#listItemView' (alias '$type')#
- field subject: models.AppBskyActorDefs.ProfileView [Required]#
Subject.
- atproto.xrpc_client.models.app.bsky.graph.defs.ListPurpose#
List purpose
alias of
Union
[models.AppBskyGraphDefs.Modlist
,models.AppBskyGraphDefs.Curatelist
]
- pydantic model atproto.xrpc_client.models.app.bsky.graph.defs.ListView#
Bases:
ModelBase
Definition model for
app.bsky.graph.defs
.Show JSON schema
{ "title": "ListView", "description": "Definition model for :obj:`app.bsky.graph.defs`.", "type": "object", "properties": { "cid": { "title": "Cid", "type": "string" }, "creator": { "$ref": "#/$defs/ProfileView" }, "indexedAt": { "title": "Indexedat", "type": "string" }, "name": { "maxLength": 64, "minLength": 1, "title": "Name", "type": "string" }, "purpose": { "anyOf": [ { "const": "app.bsky.graph.defs#modlist" }, { "const": "app.bsky.graph.defs#curatelist" } ], "title": "Purpose" }, "uri": { "title": "Uri", "type": "string" }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Avatar" }, "description": { "anyOf": [ { "maxLength": 3000, "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "descriptionFacets": { "anyOf": [ { "items": { "$ref": "#/$defs/Main" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Descriptionfacets" }, "viewer": { "anyOf": [ { "$ref": "#/$defs/ListViewerState" }, { "type": "null" } ], "default": null }, "$type": { "const": "app.bsky.graph.defs#listView", "default": "app.bsky.graph.defs#listView", "title": "$Type" } }, "$defs": { "ByteSlice": { "additionalProperties": false, "description": "Definition model for :obj:`app.bsky.richtext.facet`. A text segment. Start is inclusive, end is exclusive. Indices are for utf8-encoded strings.", "properties": { "byteEnd": { "minimum": 0, "title": "Byteend", "type": "integer" }, "byteStart": { "minimum": 0, "title": "Bytestart", "type": "integer" }, "$type": { "const": "app.bsky.richtext.facet#byteSlice", "default": "app.bsky.richtext.facet#byteSlice", "title": "$Type" } }, "required": [ "byteEnd", "byteStart" ], "title": "ByteSlice", "type": "object" }, "Label": { "additionalProperties": false, "description": "Definition model for :obj:`com.atproto.label.defs`. Metadata tag on an atproto resource (eg, repo or record)", "properties": { "cts": { "title": "Cts", "type": "string" }, "src": { "title": "Src", "type": "string" }, "uri": { "title": "Uri", "type": "string" }, "val": { "maxLength": 128, "title": "Val", "type": "string" }, "cid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Cid" }, "neg": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Neg" }, "$type": { "const": "com.atproto.label.defs#label", "default": "com.atproto.label.defs#label", "title": "$Type" } }, "required": [ "cts", "src", "uri", "val" ], "title": "Label", "type": "object" }, "Link": { "additionalProperties": false, "description": "Definition model for :obj:`app.bsky.richtext.facet`. A facet feature for links.", "properties": { "uri": { "title": "Uri", "type": "string" }, "$type": { "const": "app.bsky.richtext.facet#link", "default": "app.bsky.richtext.facet#link", "title": "$Type" } }, "required": [ "uri" ], "title": "Link", "type": "object" }, "ListViewBasic": { "additionalProperties": false, "description": "Definition model for :obj:`app.bsky.graph.defs`.", "properties": { "cid": { "title": "Cid", "type": "string" }, "name": { "maxLength": 64, "minLength": 1, "title": "Name", "type": "string" }, "purpose": { "anyOf": [ { "const": "app.bsky.graph.defs#modlist" }, { "const": "app.bsky.graph.defs#curatelist" } ], "title": "Purpose" }, "uri": { "title": "Uri", "type": "string" }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Avatar" }, "indexedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Indexedat" }, "viewer": { "anyOf": [ { "$ref": "#/$defs/ListViewerState" }, { "type": "null" } ], "default": null }, "$type": { "const": "app.bsky.graph.defs#listViewBasic", "default": "app.bsky.graph.defs#listViewBasic", "title": "$Type" } }, "required": [ "cid", "name", "purpose", "uri" ], "title": "ListViewBasic", "type": "object" }, "ListViewerState": { "additionalProperties": false, "description": "Definition model for :obj:`app.bsky.graph.defs`.", "properties": { "blocked": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Blocked" }, "muted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Muted" }, "$type": { "const": "app.bsky.graph.defs#listViewerState", "default": "app.bsky.graph.defs#listViewerState", "title": "$Type" } }, "title": "ListViewerState", "type": "object" }, "Main": { "additionalProperties": false, "description": "Definition model for :obj:`app.bsky.richtext.facet`.", "properties": { "features": { "items": { "discriminator": { "mapping": { "app.bsky.richtext.facet#link": "#/$defs/Link", "app.bsky.richtext.facet#mention": "#/$defs/Mention", "app.bsky.richtext.facet#tag": "#/$defs/Tag" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/$defs/Mention" }, { "$ref": "#/$defs/Link" }, { "$ref": "#/$defs/Tag" } ] }, "title": "Features", "type": "array" }, "index": { "$ref": "#/$defs/ByteSlice" }, "$type": { "const": "app.bsky.richtext.facet", "default": "app.bsky.richtext.facet", "title": "$Type" } }, "required": [ "features", "index" ], "title": "Main", "type": "object" }, "Mention": { "additionalProperties": false, "description": "Definition model for :obj:`app.bsky.richtext.facet`. A facet feature for actor mentions.", "properties": { "did": { "title": "Did", "type": "string" }, "$type": { "const": "app.bsky.richtext.facet#mention", "default": "app.bsky.richtext.facet#mention", "title": "$Type" } }, "required": [ "did" ], "title": "Mention", "type": "object" }, "ProfileView": { "additionalProperties": false, "description": "Definition model for :obj:`app.bsky.actor.defs`.", "properties": { "did": { "title": "Did", "type": "string" }, "handle": { "title": "Handle", "type": "string" }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Avatar" }, "description": { "anyOf": [ { "maxLength": 2560, "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "displayName": { "anyOf": [ { "maxLength": 640, "type": "string" }, { "type": "null" } ], "default": null, "title": "Displayname" }, "indexedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Indexedat" }, "labels": { "anyOf": [ { "items": { "$ref": "#/$defs/Label" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Labels" }, "viewer": { "anyOf": [ { "$ref": "#/$defs/ViewerState" }, { "type": "null" } ], "default": null }, "$type": { "const": "app.bsky.actor.defs#profileView", "default": "app.bsky.actor.defs#profileView", "title": "$Type" } }, "required": [ "did", "handle" ], "title": "ProfileView", "type": "object" }, "Tag": { "additionalProperties": false, "description": "Definition model for :obj:`app.bsky.richtext.facet`. A hashtag.", "properties": { "tag": { "maxLength": 640, "title": "Tag", "type": "string" }, "$type": { "const": "app.bsky.richtext.facet#tag", "default": "app.bsky.richtext.facet#tag", "title": "$Type" } }, "required": [ "tag" ], "title": "Tag", "type": "object" }, "ViewerState": { "additionalProperties": false, "description": "Definition model for :obj:`app.bsky.actor.defs`.", "properties": { "blockedBy": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Blockedby" }, "blocking": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Blocking" }, "blockingByList": { "anyOf": [ { "$ref": "#/$defs/ListViewBasic" }, { "type": "null" } ], "default": null }, "followedBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Followedby" }, "following": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Following" }, "muted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Muted" }, "mutedByList": { "anyOf": [ { "$ref": "#/$defs/ListViewBasic" }, { "type": "null" } ], "default": null }, "$type": { "const": "app.bsky.actor.defs#viewerState", "default": "app.bsky.actor.defs#viewerState", "title": "$Type" } }, "title": "ViewerState", "type": "object" } }, "additionalProperties": false, "required": [ "cid", "creator", "indexedAt", "name", "purpose", "uri" ] }
- Fields:
- field avatar: Optional[str] = None#
Avatar.
- field cid: str [Required]#
Cid.
- field creator: models.AppBskyActorDefs.ProfileView [Required]#
Creator.
- field description: Optional[str] = None#
Description.
- Constraints:
max_length = 3000
- field description_facets: Optional[List[models.AppBskyRichtextFacet.Main]] = None (alias 'descriptionFacets')#
Description facets.
- field indexed_at: str [Required] (alias 'indexedAt')#
Indexed at.
- field name: str [Required]#
Name.
- Constraints:
min_length = 1
max_length = 64
- field purpose: models.AppBskyGraphDefs.ListPurpose [Required]#
Purpose.
- field py_type: typing_extensions.Literal[app.bsky.graph.defs#listView] = 'app.bsky.graph.defs#listView' (alias '$type')#
- field uri: str [Required]#
Uri.
- field viewer: Optional[models.AppBskyGraphDefs.ListViewerState] = None#
Viewer.
- pydantic model atproto.xrpc_client.models.app.bsky.graph.defs.ListViewBasic#
Bases:
ModelBase
Definition model for
app.bsky.graph.defs
.Show JSON schema
{ "title": "ListViewBasic", "description": "Definition model for :obj:`app.bsky.graph.defs`.", "type": "object", "properties": { "cid": { "title": "Cid", "type": "string" }, "name": { "maxLength": 64, "minLength": 1, "title": "Name", "type": "string" }, "purpose": { "anyOf": [ { "const": "app.bsky.graph.defs#modlist" }, { "const": "app.bsky.graph.defs#curatelist" } ], "title": "Purpose" }, "uri": { "title": "Uri", "type": "string" }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Avatar" }, "indexedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Indexedat" }, "viewer": { "anyOf": [ { "$ref": "#/$defs/ListViewerState" }, { "type": "null" } ], "default": null }, "$type": { "const": "app.bsky.graph.defs#listViewBasic", "default": "app.bsky.graph.defs#listViewBasic", "title": "$Type" } }, "$defs": { "ListViewerState": { "additionalProperties": false, "description": "Definition model for :obj:`app.bsky.graph.defs`.", "properties": { "blocked": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Blocked" }, "muted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Muted" }, "$type": { "const": "app.bsky.graph.defs#listViewerState", "default": "app.bsky.graph.defs#listViewerState", "title": "$Type" } }, "title": "ListViewerState", "type": "object" } }, "additionalProperties": false, "required": [ "cid", "name", "purpose", "uri" ] }
- Fields:
- field avatar: Optional[str] = None#
Avatar.
- field cid: str [Required]#
Cid.
- field indexed_at: Optional[str] = None (alias 'indexedAt')#
Indexed at.
- field name: str [Required]#
Name.
- Constraints:
min_length = 1
max_length = 64
- field purpose: models.AppBskyGraphDefs.ListPurpose [Required]#
Purpose.
- field py_type: typing_extensions.Literal[app.bsky.graph.defs#listViewBasic] = 'app.bsky.graph.defs#listViewBasic' (alias '$type')#
- field uri: str [Required]#
Uri.
- field viewer: Optional[models.AppBskyGraphDefs.ListViewerState] = None#
Viewer.
- pydantic model atproto.xrpc_client.models.app.bsky.graph.defs.ListViewerState#
Bases:
ModelBase
Definition model for
app.bsky.graph.defs
.Show JSON schema
{ "title": "ListViewerState", "description": "Definition model for :obj:`app.bsky.graph.defs`.", "type": "object", "properties": { "blocked": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Blocked" }, "muted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Muted" }, "$type": { "const": "app.bsky.graph.defs#listViewerState", "default": "app.bsky.graph.defs#listViewerState", "title": "$Type" } }, "additionalProperties": false }
- Fields:
- field blocked: Optional[str] = None#
Blocked.
- field muted: Optional[bool] = None#
Muted.
- field py_type: typing_extensions.Literal[app.bsky.graph.defs#listViewerState] = 'app.bsky.graph.defs#listViewerState' (alias '$type')#
- atproto.xrpc_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]