Models

class atproto_lexicon.models.LexArray

Bases: LexDefinitionBase

field description: t.Optional[str] = None

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

field max_length: int | None = None

field min_length: int | None = None

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

class atproto_lexicon.models.LexBase

Bases: BaseModel

Base class for all lexicon models.

class atproto_lexicon.models.LexBlob

Bases: LexDefinitionBase

field accept: List[str] | None = None

field description: t.Optional[str] = None

field max_size: int | float | None = None

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

class atproto_lexicon.models.LexBoolean

Bases: LexPrimitiveBase

field const: bool | None = None

field default: bool | None = None

field description: t.Optional[str] = None

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

class atproto_lexicon.models.LexBytes

Bases: LexPrimitiveBase

field description: t.Optional[str] = None

field max_length: int | float | None = None

field min_length: int | float | None = None

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

class atproto_lexicon.models.LexCidLink

Bases: LexPrimitiveBase

field description: t.Optional[str] = None

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

class atproto_lexicon.models.LexDefinitionBase

Bases: LexBase

Base class for all lexicon definitions.

field description: str | None = None

class atproto_lexicon.models.LexDefinitionType

Bases: object

ARRAY = 'array'

BLOB = 'blob'

OBJECT = 'object'

PARAMS = 'params'

PROCEDURE = 'procedure'

QUERY = 'query'

RECORD = 'record'

STRING = 'string'

SUBSCRIPTION = 'subscription'

TOKEN = 'token'

class atproto_lexicon.models.LexInteger

Bases: LexPrimitiveBase

field const: int | None = None

field default: int | None = None

field description: t.Optional[str] = None

field enum: List[int] | None = None

field maximum: int | None = None

field minimum: int | None = None

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

class atproto_lexicon.models.LexNumber

Bases: LexPrimitiveBase

field const: int | float | None = None

field default: int | float | None = None

field description: t.Optional[str] = None

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

field maximum: int | float | None = None

field minimum: int | float | None = None

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

class atproto_lexicon.models.LexObject

Bases: LexDefinitionBase

field description: t.Optional[str] = None

field nullable: List[str] | None = None

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

field required: List[str] | None = None

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

class atproto_lexicon.models.LexPrimitiveBase

Bases: LexBase

Base class for all lexicon primitives.

field description: str | None = None

class atproto_lexicon.models.LexPrimitiveType

Bases: object

BOOLEAN = 'boolean'

BYTES = 'bytes'

CID_LINK = 'cid-link'

INTEGER = 'integer'

NUMBER = 'number'

REF = 'ref'

STRING = 'string'

UNION = 'union'

UNKNOWN = 'unknown'

class atproto_lexicon.models.LexRecord

Bases: LexDefinitionBase

field description: t.Optional[str] = None

field key: str | None = None

field record: LexObject [Required]

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

class atproto_lexicon.models.LexRef

Bases: LexPrimitiveBase

field description: t.Optional[str] = None

field ref: str [Required]

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

class atproto_lexicon.models.LexRefUnion

Bases: LexPrimitiveBase

field closed: bool | None = None

field description: t.Optional[str] = None

field refs: List[str] [Required]

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

class atproto_lexicon.models.LexString

Bases: LexPrimitiveBase

field const: str | None = None

field default: str | None = None

field description: t.Optional[str] = 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: typing_extensions.Literal[string] = 'string'

class atproto_lexicon.models.LexSubscription

Bases: LexDefinitionBase

field description: t.Optional[str] = None

field errors: List[LexXrpcError] | None = None

field infos: List[LexXrpcError] | None = None

field message: LexXrpcSubscriptionMessage | None = None

field parameters: LexXrpcParameters | None = None

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

class atproto_lexicon.models.LexToken

Bases: LexDefinitionBase

field description: t.Optional[str] = None

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

class atproto_lexicon.models.LexUnknown

Bases: LexPrimitiveBase

field description: t.Optional[str] = None

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

class atproto_lexicon.models.LexXrpcBody

Bases: LexBase

field description: str | None = None

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

field schema_: LexObject | atproto_lexicon.models.LexRef | atproto_lexicon.models.LexRefUnion[atproto_lexicon.models.LexRef | atproto_lexicon.models.LexRefUnion][LexObject | LexRef | atproto_lexicon.models.LexRefUnion[LexRef | LexRefUnion]] | None = None

class atproto_lexicon.models.LexXrpcError

Bases: LexBase

field description: str | None = None

field name: str [Required]

class atproto_lexicon.models.LexXrpcParameters

Bases: LexDefinitionBase

field description: t.Optional[str] = None

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

field required: List[str] | None = None

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

class atproto_lexicon.models.LexXrpcProcedure

Bases: LexDefinitionBase

field description: t.Optional[str] = None

field errors: List[LexXrpcError] | None = None

field input: LexXrpcBody | None = None

field output: LexXrpcBody | None = None

field parameters: LexXrpcParameters | None = None

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

class atproto_lexicon.models.LexXrpcQuery

Bases: LexDefinitionBase

field description: t.Optional[str] = None

field errors: List[LexXrpcError] | None = None

field output: LexXrpcBody | None = None

field parameters: LexXrpcParameters | None = None

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

class atproto_lexicon.models.LexXrpcSubscriptionMessage

Bases: LexBase

field description: str | None = None

field schema_: LexObject | atproto_lexicon.models.LexRef | atproto_lexicon.models.LexRefUnion[atproto_lexicon.models.LexRef | atproto_lexicon.models.LexRefUnion][LexObject | LexRef | atproto_lexicon.models.LexRefUnion[LexRef | LexRefUnion]] | None = None

class atproto_lexicon.models.LexiconDoc

Bases: LexBase

Lexicon document model.

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

field description: str | None = None

field id: str [Required]

field lexicon: int [Required]

field revision: int | None = None