Models

class atproto_lexicon.models.LexDefinitionType

Bases: object

RECORD = 'record'

QUERY = 'query'

PROCEDURE = 'procedure'

SUBSCRIPTION = 'subscription'

PARAMS = 'params'

TOKEN = 'token'

OBJECT = 'object'

BLOB = 'blob'

ARRAY = 'array'

STRING = 'string'

PERMISSION = 'permission'

PERMISSION_SET = 'permission-set'

class atproto_lexicon.models.LexPrimitiveType

Bases: object

BOOLEAN = 'boolean'

NUMBER = 'number'

INTEGER = 'integer'

STRING = 'string'

REF = 'ref'

UNION = 'union'

UNKNOWN = 'unknown'

CID_LINK = 'cid-link'

BYTES = 'bytes'

class atproto_lexicon.models.LexBase

Bases: BaseModel

Base class for all lexicon models.

class atproto_lexicon.models.LexDefinitionBase

Bases: LexBase

Base class for all lexicon definitions.

field description: str | None = None

class atproto_lexicon.models.LexPrimitiveBase

Bases: LexBase

Base class for all lexicon primitives.

field description: str | None = None

class atproto_lexicon.models.LexXrpcError

Bases: LexBase

field description: str | None = None

field name: str [Required]

class atproto_lexicon.models.LexUnknown

Bases: LexPrimitiveBase

field type: Literal['unknown'] = 'unknown'

class atproto_lexicon.models.LexCidLink

Bases: LexPrimitiveBase

field type: Literal['cid-link'] = 'cid-link'

class atproto_lexicon.models.LexBytes

Bases: LexPrimitiveBase

field max_length: int | float | None = None

field min_length: int | float | None = None

field type: Literal['bytes'] = 'bytes'

class atproto_lexicon.models.LexBoolean

Bases: LexPrimitiveBase

field const: bool | None = None

field default: bool | None = None

field type: Literal['boolean'] = 'boolean'

class atproto_lexicon.models.LexNumber

Bases: LexPrimitiveBase

field const: int | float | None = None

field default: int | float | None = None

field enum: List[int | float] | None = None

field maximum: int | float | None = None

field minimum: int | float | None = None

field type: Literal['number'] = 'number'

class atproto_lexicon.models.LexInteger

Bases: LexPrimitiveBase

field const: int | None = None

field default: int | None = None

field enum: List[int] | None = None

field maximum: int | None = None

field minimum: int | None = None

field type: Literal['integer'] = 'integer'

class atproto_lexicon.models.LexString

Bases: LexPrimitiveBase

field const: str | None = None

field default: str | None = None

field enum: List[str] | None = None

field format: str | None = None

field known_values: List[str] | None = None

field max_graphemes: int | None = None

field max_length: int | None = None

field min_graphemes: int | None = None

field min_length: int | None = None

field type: Literal['string'] = 'string'

class atproto_lexicon.models.LexRef

Bases: LexPrimitiveBase

field ref: str [Required]

field type: Literal['ref'] = 'ref'

class atproto_lexicon.models.LexRefUnion

Bases: LexPrimitiveBase

field closed: bool | None = False

field refs: List[str] [Required]

field type: Literal['union'] = 'union'

class atproto_lexicon.models.LexBlob

Bases: LexDefinitionBase

field accept: List[str] | None = None

field max_size: int | float | None = None

field type: Literal['blob'] = 'blob'

class atproto_lexicon.models.LexArray

Bases: LexDefinitionBase

field items: LexRef | LexRefUnion | LexUnknown | LexCidLink | LexBytes | LexBoolean | LexNumber | LexInteger | LexString | LexBlob [Required]

field max_length: int | None = None

field min_length: int | None = None

field type: Literal['array'] = 'array'

class atproto_lexicon.models.LexToken

Bases: LexDefinitionBase

field type: Literal['token'] = 'token'

class atproto_lexicon.models.LexObject

Bases: LexDefinitionBase

field nullable: List[str] | None = None

field properties: Dict[str, LexUnknown | LexCidLink | LexBytes | LexBoolean | LexNumber | LexInteger | LexString | LexRef | LexRefUnion | LexArray | LexBlob | LexObject] [Required]

field required: List[str] | None = None

field type: Literal['object'] = 'object'

class atproto_lexicon.models.LexRecord

Bases: LexDefinitionBase

field key: str | None = None

field record: LexObject [Required]

field type: Literal['record'] = 'record'

class atproto_lexicon.models.LexXrpcParameters

Bases: LexDefinitionBase

field properties: Dict[str, LexBoolean | LexInteger | LexString | LexUnknown | LexArray] [Required]

field required: List[str] | None = None

field type: Literal['params'] = 'params'

class atproto_lexicon.models.LexXrpcSubscriptionMessage

Bases: LexBase

field description: str | None = None

field schema_: LexObject | LexRef | LexRefUnion | None = None

class atproto_lexicon.models.LexXrpcBody

Bases: LexBase

field description: str | None = None

field encoding: str | List[str] [Required]

field schema_: LexObject | LexRef | LexRefUnion | None = None

class atproto_lexicon.models.LexSubscription

Bases: LexDefinitionBase

field errors: List[LexXrpcError] | None = None

field infos: List[LexXrpcError] | None = None

field message: LexXrpcSubscriptionMessage | None = None

field parameters: LexXrpcParameters | None = None

field subprotocol: str | None = None

field type: Literal['subscription'] = 'subscription'

class atproto_lexicon.models.LexXrpcQuery

Bases: LexDefinitionBase

field errors: List[LexXrpcError] | None = None

field output: LexXrpcBody | None = None

field parameters: LexXrpcParameters | None = None

field type: Literal['query'] = 'query'

class atproto_lexicon.models.LexXrpcProcedure

Bases: LexDefinitionBase

field errors: List[LexXrpcError] | None = None

field input: LexXrpcBody | None = None

field output: LexXrpcBody | None = None

field parameters: LexXrpcParameters | None = None

field type: Literal['procedure'] = 'procedure'

class atproto_lexicon.models.LexPermission

Bases: LexDefinitionBase

field resource: str [Required]

field type: Literal['permission'] = 'permission'

class atproto_lexicon.models.LexPermissionSet

Bases: LexDefinitionBase

field description: str | None = None

field detail: str | None = None

field detail_lang: Dict[str, str | None] | None = None

field permissions: List[LexPermission] [Required]

field title: str | None = None

field title_lang: Dict[str, str | None] | None = None

field type: Literal['permission-set'] = 'permission-set'

class atproto_lexicon.models.LexiconDoc

Bases: LexBase

Lexicon document model.

field defs: Dict[str, LexBlob | LexArray | LexToken | LexObject | LexRecord | LexXrpcParameters | LexSubscription | LexXrpcQuery | LexXrpcProcedure | LexPermissionSet | LexString] [Required]

field description: str | None = None

field id: str [Required]

field lexicon: int [Required]

field revision: int | None = None