@atproto/api
Version:
Client library for atproto and Bluesky
1,583 lines • 237 kB
TypeScript
import { LexiconDoc, Lexicons } from '@atproto/lexicon';
export declare const schemaDict: {
ComAtprotoAdminDefs: {
lexicon: number;
id: string;
defs: {
statusAttr: {
type: string;
required: string[];
properties: {
applied: {
type: string;
};
ref: {
type: string;
};
};
};
modEventView: {
type: string;
required: string[];
properties: {
id: {
type: string;
};
event: {
type: string;
refs: string[];
};
subject: {
type: string;
refs: string[];
};
subjectBlobCids: {
type: string;
items: {
type: string;
};
};
createdBy: {
type: string;
format: string;
};
createdAt: {
type: string;
format: string;
};
creatorHandle: {
type: string;
};
subjectHandle: {
type: string;
};
};
};
modEventViewDetail: {
type: string;
required: string[];
properties: {
id: {
type: string;
};
event: {
type: string;
refs: string[];
};
subject: {
type: string;
refs: string[];
};
subjectBlobs: {
type: string;
items: {
type: string;
ref: string;
};
};
createdBy: {
type: string;
format: string;
};
createdAt: {
type: string;
format: string;
};
};
};
reportView: {
type: string;
required: string[];
properties: {
id: {
type: string;
};
reasonType: {
type: string;
ref: string;
};
comment: {
type: string;
};
subjectRepoHandle: {
type: string;
};
subject: {
type: string;
refs: string[];
};
reportedBy: {
type: string;
format: string;
};
createdAt: {
type: string;
format: string;
};
resolvedByActionIds: {
type: string;
items: {
type: string;
};
};
};
};
subjectStatusView: {
type: string;
required: string[];
properties: {
id: {
type: string;
};
subject: {
type: string;
refs: string[];
};
subjectBlobCids: {
type: string;
items: {
type: string;
format: string;
};
};
subjectRepoHandle: {
type: string;
};
updatedAt: {
type: string;
format: string;
description: string;
};
createdAt: {
type: string;
format: string;
description: string;
};
reviewState: {
type: string;
ref: string;
};
comment: {
type: string;
description: string;
};
muteUntil: {
type: string;
format: string;
};
lastReviewedBy: {
type: string;
format: string;
};
lastReviewedAt: {
type: string;
format: string;
};
lastReportedAt: {
type: string;
format: string;
};
takendown: {
type: string;
};
suspendUntil: {
type: string;
format: string;
};
};
};
reportViewDetail: {
type: string;
required: string[];
properties: {
id: {
type: string;
};
reasonType: {
type: string;
ref: string;
};
comment: {
type: string;
};
subject: {
type: string;
refs: string[];
};
subjectStatus: {
type: string;
ref: string;
};
reportedBy: {
type: string;
format: string;
};
createdAt: {
type: string;
format: string;
};
resolvedByActions: {
type: string;
items: {
type: string;
ref: string;
};
};
};
};
repoView: {
type: string;
required: string[];
properties: {
did: {
type: string;
format: string;
};
handle: {
type: string;
format: string;
};
email: {
type: string;
};
relatedRecords: {
type: string;
items: {
type: string;
};
};
indexedAt: {
type: string;
format: string;
};
moderation: {
type: string;
ref: string;
};
invitedBy: {
type: string;
ref: string;
};
invitesDisabled: {
type: string;
};
inviteNote: {
type: string;
};
};
};
repoViewDetail: {
type: string;
required: string[];
properties: {
did: {
type: string;
format: string;
};
handle: {
type: string;
format: string;
};
email: {
type: string;
};
relatedRecords: {
type: string;
items: {
type: string;
};
};
indexedAt: {
type: string;
format: string;
};
moderation: {
type: string;
ref: string;
};
labels: {
type: string;
items: {
type: string;
ref: string;
};
};
invitedBy: {
type: string;
ref: string;
};
invites: {
type: string;
items: {
type: string;
ref: string;
};
};
invitesDisabled: {
type: string;
};
inviteNote: {
type: string;
};
emailConfirmedAt: {
type: string;
format: string;
};
};
};
accountView: {
type: string;
required: string[];
properties: {
did: {
type: string;
format: string;
};
handle: {
type: string;
format: string;
};
email: {
type: string;
};
indexedAt: {
type: string;
format: string;
};
invitedBy: {
type: string;
ref: string;
};
invites: {
type: string;
items: {
type: string;
ref: string;
};
};
invitesDisabled: {
type: string;
};
emailConfirmedAt: {
type: string;
format: string;
};
inviteNote: {
type: string;
};
};
};
repoViewNotFound: {
type: string;
required: string[];
properties: {
did: {
type: string;
format: string;
};
};
};
repoRef: {
type: string;
required: string[];
properties: {
did: {
type: string;
format: string;
};
};
};
repoBlobRef: {
type: string;
required: string[];
properties: {
did: {
type: string;
format: string;
};
cid: {
type: string;
format: string;
};
recordUri: {
type: string;
format: string;
};
};
};
recordView: {
type: string;
required: string[];
properties: {
uri: {
type: string;
format: string;
};
cid: {
type: string;
format: string;
};
value: {
type: string;
};
blobCids: {
type: string;
items: {
type: string;
format: string;
};
};
indexedAt: {
type: string;
format: string;
};
moderation: {
type: string;
ref: string;
};
repo: {
type: string;
ref: string;
};
};
};
recordViewDetail: {
type: string;
required: string[];
properties: {
uri: {
type: string;
format: string;
};
cid: {
type: string;
format: string;
};
value: {
type: string;
};
blobs: {
type: string;
items: {
type: string;
ref: string;
};
};
labels: {
type: string;
items: {
type: string;
ref: string;
};
};
indexedAt: {
type: string;
format: string;
};
moderation: {
type: string;
ref: string;
};
repo: {
type: string;
ref: string;
};
};
};
recordViewNotFound: {
type: string;
required: string[];
properties: {
uri: {
type: string;
format: string;
};
};
};
moderation: {
type: string;
properties: {
subjectStatus: {
type: string;
ref: string;
};
};
};
moderationDetail: {
type: string;
properties: {
subjectStatus: {
type: string;
ref: string;
};
};
};
blobView: {
type: string;
required: string[];
properties: {
cid: {
type: string;
format: string;
};
mimeType: {
type: string;
};
size: {
type: string;
};
createdAt: {
type: string;
format: string;
};
details: {
type: string;
refs: string[];
};
moderation: {
type: string;
ref: string;
};
};
};
imageDetails: {
type: string;
required: string[];
properties: {
width: {
type: string;
};
height: {
type: string;
};
};
};
videoDetails: {
type: string;
required: string[];
properties: {
width: {
type: string;
};
height: {
type: string;
};
length: {
type: string;
};
};
};
subjectReviewState: {
type: string;
knownValues: string[];
};
reviewOpen: {
type: string;
description: string;
};
reviewEscalated: {
type: string;
description: string;
};
reviewClosed: {
type: string;
description: string;
};
modEventTakedown: {
type: string;
description: string;
properties: {
comment: {
type: string;
};
durationInHours: {
type: string;
description: string;
};
};
};
modEventReverseTakedown: {
type: string;
description: string;
properties: {
comment: {
type: string;
description: string;
};
};
};
modEventComment: {
type: string;
description: string;
required: string[];
properties: {
comment: {
type: string;
};
sticky: {
type: string;
description: string;
};
};
};
modEventReport: {
type: string;
description: string;
required: string[];
properties: {
comment: {
type: string;
};
reportType: {
type: string;
ref: string;
};
};
};
modEventLabel: {
type: string;
description: string;
required: string[];
properties: {
comment: {
type: string;
};
createLabelVals: {
type: string;
items: {
type: string;
};
};
negateLabelVals: {
type: string;
items: {
type: string;
};
};
};
};
modEventAcknowledge: {
type: string;
properties: {
comment: {
type: string;
};
};
};
modEventEscalate: {
type: string;
properties: {
comment: {
type: string;
};
};
};
modEventMute: {
type: string;
description: string;
required: string[];
properties: {
comment: {
type: string;
};
durationInHours: {
type: string;
description: string;
};
};
};
modEventUnmute: {
type: string;
description: string;
properties: {
comment: {
type: string;
description: string;
};
};
};
modEventEmail: {
type: string;
description: string;
required: string[];
properties: {
subjectLine: {
type: string;
description: string;
};
};
};
};
};
ComAtprotoAdminDeleteAccount: {
lexicon: number;
id: string;
defs: {
main: {
type: string;
description: string;
input: {
encoding: string;
schema: {
type: string;
required: string[];
properties: {
did: {
type: string;
format: string;
};
};
};
};
};
};
};
ComAtprotoAdminDisableAccountInvites: {
lexicon: number;
id: string;
defs: {
main: {
type: string;
description: string;
input: {
encoding: string;
schema: {
type: string;
required: string[];
properties: {
account: {
type: string;
format: string;
};
note: {
type: string;
description: string;
};
};
};
};
};
};
};
ComAtprotoAdminDisableInviteCodes: {
lexicon: number;
id: string;
defs: {
main: {
type: string;
description: string;
input: {
encoding: string;
schema: {
type: string;
properties: {
codes: {
type: string;
items: {
type: string;
};
};
accounts: {
type: string;
items: {
type: string;
};
};
};
};
};
};
};
};
ComAtprotoAdminEmitModerationEvent: {
lexicon: number;
id: string;
defs: {
main: {
type: string;
description: string;
input: {
encoding: string;
schema: {
type: string;
required: string[];
properties: {
event: {
type: string;
refs: string[];
};
subject: {
type: string;
refs: string[];
};
subjectBlobCids: {
type: string;
items: {
type: string;
format: string;
};
};
createdBy: {
type: string;
format: string;
};
};
};
};
output: {
encoding: string;
schema: {
type: string;
ref: string;
};
};
errors: {
name: string;
}[];
};
};
};
ComAtprotoAdminEnableAccountInvites: {
lexicon: number;
id: string;
defs: {
main: {
type: string;
description: string;
input: {
encoding: string;
schema: {
type: string;
required: string[];
properties: {
account: {
type: string;
format: string;
};
note: {
type: string;
description: string;
};
};
};
};
};
};
};
ComAtprotoAdminGetAccountInfo: {
lexicon: number;
id: string;
defs: {
main: {
type: string;
description: string;
parameters: {
type: string;
required: string[];
properties: {
did: {
type: string;
format: string;
};
};
};
output: {
encoding: string;
schema: {
type: string;
ref: string;
};
};
};
};
};
ComAtprotoAdminGetInviteCodes: {
lexicon: number;
id: string;
defs: {
main: {
type: string;
description: string;
parameters: {
type: string;
properties: {
sort: {
type: string;
knownValues: string[];
default: string;
};
limit: {
type: string;
minimum: number;
maximum: number;
default: number;
};
cursor: {
type: string;
};
};
};
output: {
encoding: string;
schema: {
type: string;
required: string[];
properties: {
cursor: {
type: string;
};
codes: {
type: string;
items: {
type: string;
ref: string;
};
};
};
};
};
};
};
};
ComAtprotoAdminGetModerationEvent: {
lexicon: number;
id: string;
defs: {
main: {
type: string;
description: string;
parameters: {
type: string;
required: string[];
properties: {
id: {
type: string;
};
};
};
output: {
encoding: string;
schema: {
type: string;
ref: string;
};
};
};
};
};
ComAtprotoAdminGetRecord: {
lexicon: number;
id: string;
defs: {
main: {
type: string;
description: string;
parameters: {
type: string;
required: string[];
properties: {
uri: {
type: string;
format: string;
};
cid: {
type: string;
format: string;
};
};
};
output: {
encoding: string;
schema: {
type: string;
ref: string;
};
};
errors: {
name: string;
}[];
};
};
};
ComAtprotoAdminGetRepo: {
lexicon: number;
id: string;
defs: {
main: {
type: string;
description: string;
parameters: {
type: string;
required: string[];
properties: {
did: {
type: string;
format: string;
};
};
};
output: {
encoding: string;
schema: {
type: string;
ref: string;
};
};
errors: {
name: string;
}[];
};
};
};
ComAtprotoAdminGetSubjectStatus: {
lexicon: number;
id: string;
defs: {
main: {
type: string;
description: string;
parameters: {
type: string;
properties: {
did: {
type: string;
format: string;
};
uri: {
type: string;
format: string;
};
blob: {
type: string;
format: string;
};
};
};
output: {
encoding: string;
schema: {
type: string;
required: string[];
properties: {
subject: {
type: string;
refs: string[];
};
takedown: {
type: string;
ref: string;
};
};
};
};
};
};
};
ComAtprotoAdminQueryModerationEvents: {
lexicon: number;
id: string;
defs: {
main: {
type: string;
description: string;
parameters: {
type: string;
properties: {
types: {
type: string;
items: {
type: string;
};
description: string;
};
createdBy: {
type: string;
format: string;
};
sortDirection: {
type: string;
default: string;
enum: string[];
description: string;
};
subject: {
type: string;
format: string;
};
includeAllUserRecords: {
type: string;
default: boolean;
description: string;
};
limit: {
type: string;
minimum: number;
maximum: number;
default: number;
};
cursor: {
type: string;
};
};
};
output: {
encoding: string;
schema: {
type: string;
required: string[];
properties: {
cursor: {
type: string;
};
events: {
type: string;
items: {
type: string;
ref: string;
};
};
};
};
};
};
};
};
ComAtprotoAdminQueryModerationStatuses: {
lexicon: number;
id: string;
defs: {
main: {
type: string;
description: string;
parameters: {
type: string;
properties: {
subject: {
type: string;
format: string;
};
comment: {
type: string;
description: string;
};
reportedAfter: {
type: string;
format: string;
description: string;
};
reportedBefore: {
type: string;
format: string;
description: string;
};
reviewedAfter: {
type: string;
format: string;
description: string;
};
reviewedBefore: {
type: string;
format: string;
description: string;
};
includeMuted: {
type: string;
description: string;
};
reviewState: {
type: string;
description: string;
};
ignoreSubjects: {
type: string;
items: {
type: string;
format: string;
};
};
lastReviewedBy: {
type: string;
format: string;
description: string;
};
sortField: {
type: string;
default: string;
enum: string[];
};
sortDirection: {
type: string;
default: string;
enum: string[];
};
takendown: {
type: string;
description: string;
};
limit: {
type: string;
minimum: number;
maximum: number;
default: number;
};
cursor: {
type: string;
};
};
};
output: {
encoding: string;
schema: {
type: string;
required: string[];
properties: {
cursor: {
type: string;
};
subjectStatuses: {
type: string;
items: {
type: string;
ref: string;
};
};
};
};
};
};
};
};
ComAtprotoAdminSearchRepos: {
lexicon: number;
id: string;
defs: {
main: {
type: string;
description: string;
parameters: {
type: string;
properties: {
term: {
type: string;
description: string;
};
q: {
type: string;
};
limit: {
type: string;
minimum: number;
maximum: number;
default: number;
};
cursor: {
type: string;
};
};
};
output: {
encoding: string;
schema: {
type: string;
required: string[];
properties: {
cursor: {
type: string;
};
repos: {
type: string;
items: {
type: string;
ref: string;
};
};
};
};
};
};
};
};
ComAtprotoAdminSendEmail: {
lexicon: number;
id: string;
defs: {
main: {
type: string;
description: string;
input: {
encoding: string;
schema: {
type: string;
required: string[];
properties: {
recipientDid: {
type: string;
format: string;
};
content: {
type: string;
};
subject: {
type: string;
};
senderDid: {
type: string;
format: string;
};
};
};
};
output: {
encoding: string;
schema: {
type: string;
required: string[];
properties: {
sent: {
type: string;
};
};
};
};
};
};
};
ComAtprotoAdminUpdateAccountEmail: {
lexicon: number;
id: string;
defs: {
main: {
type: string;
description: string;
input: {
encoding: string;
schema: {
type: string;
required: string[];
properties: {
account: {
type: string;
format: string;
description: string;
};
email: {
type: string;
};
};
};
};
};
};
};
ComAtprotoAdminUpdateAccountHandle: {
lexicon: number;
id: string;
defs: {
main: {
type: string;
description: string;
input: {
encoding: string;
schema: {
type: string;
required: string[];
properties: {
did: {
type: string;
format: string;
};
handle: {
type: string;
format: string;
};
};
};
};
};
};
};
ComAtprotoAdminUpdateSubjectStatus: {
lexicon: number;
id: string;
defs: {
main: {
type: string;
description: string;
input: {
encoding: string;
schema: {
type: string;
required: string[];
properties: {
subject: {
type: string;
refs: string[];
};
takedown: {
type: string;
ref: string;
};
};
};
};
output: {
encoding: string;
schema: {
type: string;
required: string[];
properties: {
subject: {
type: string;
refs: string[];
};
takedown: {
type: string;
ref: string;
};
};
};
};
};
};
};
ComAtprotoIdentityResolveHandle: {
lexicon: number;
id: string;
defs: {
main: {
type: string;
description: string;
parameters: {
type: string;
required: string[];
properties: {
handle: {
type: string;
format: string;
description: string;
};
};
};
output: {
encoding: string;
schema: {
type: string;
required: string[];
properties: {
did: {
type: string;
format: string;
};
};
};
};
};
};
};
ComAtprotoIdentityUpdateHandle: {
lexicon: number;
id: string;
defs: {
main: {
type: string;
description: string;
input: {
encoding: string;
schema: {
type: string;
required: string[];
properties: {
handle: {
type: string;
format: string;
};
};
};
};
};
};
};
ComAtprotoLabelDefs: {
lexicon: number;
id: string;
defs: {
label: {
type: string;
description: string;
required: string[];
properties: {
src: {
type: string;
format: string;
description: string;
};
uri: {
type: string;
format: string;
description: string;
};
cid: {
type: string;
format: string;
description: string;
};
val: {
type: string;
maxLength: number;
description: string;
};
neg: {
type: string;
description: string;
};
cts: {
type: string;
format: string;
description: string;
};
};
};
selfLabels: {
type: string;
description: string;
required: string[];
properties: {
values: {
type: string;
items: {
type: string;
ref: string;
};
maxLength: number;
};
};
};
selfLabel: {
type: string;
description: string;
required: string[];
properties: {
val: {
type: string;
maxLength: number;
description: string;
};
};
};
};
};
ComAtprotoLabelQueryLabels: {
lexicon: number;
id: string;
defs: {
main: {
type: string;
description: string;
parameters: {
type: string;
required: string[];
properties: {
uriPatterns: {
type: string;
items: {
type: