{ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "7.36.3", "schemaVersion": 1011, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ { "tagName": "@alpha", "syntaxKind": "modifier" }, { "tagName": "@beta", "syntaxKind": "modifier" }, { "tagName": "@defaultValue", "syntaxKind": "block" }, { "tagName": "@decorator", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@deprecated", "syntaxKind": "block" }, { "tagName": "@eventProperty", "syntaxKind": "modifier" }, { "tagName": "@example", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@experimental", "syntaxKind": "modifier" }, { "tagName": "@inheritDoc", "syntaxKind": "inline" }, { "tagName": "@internal", "syntaxKind": "modifier" }, { "tagName": "@label", "syntaxKind": "inline" }, { "tagName": "@link", "syntaxKind": "inline", "allowMultiple": true }, { "tagName": "@override", "syntaxKind": "modifier" }, { "tagName": "@packageDocumentation", "syntaxKind": "modifier" }, { "tagName": "@param", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@privateRemarks", "syntaxKind": "block" }, { "tagName": "@public", "syntaxKind": "modifier" }, { "tagName": "@readonly", "syntaxKind": "modifier" }, { "tagName": "@remarks", "syntaxKind": "block" }, { "tagName": "@returns", "syntaxKind": "block" }, { "tagName": "@sealed", "syntaxKind": "modifier" }, { "tagName": "@see", "syntaxKind": "block" }, { "tagName": "@throws", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@typeParam", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@virtual", "syntaxKind": "modifier" }, { "tagName": "@betaDocumentation", "syntaxKind": "modifier" }, { "tagName": "@internalRemarks", "syntaxKind": "block" }, { "tagName": "@preapproved", "syntaxKind": "modifier" } ], "supportForTags": { "@alpha": true, "@beta": true, "@defaultValue": true, "@decorator": true, "@deprecated": true, "@eventProperty": true, "@example": true, "@experimental": true, "@inheritDoc": true, "@internal": true, "@label": true, "@link": true, "@override": true, "@packageDocumentation": true, "@param": true, "@privateRemarks": true, "@public": true, "@readonly": true, "@remarks": true, "@returns": true, "@sealed": true, "@see": true, "@throws": true, "@typeParam": true, "@virtual": true, "@betaDocumentation": true, "@internalRemarks": true, "@preapproved": true }, "reportUnsupportedHtmlElements": false } }, "kind": "Package", "canonicalReference": "iceshrimp-sdk!", "docComment": "", "name": "iceshrimp-sdk", "preserveMemberOrder": false, "members": [ { "kind": "EntryPoint", "canonicalReference": "iceshrimp-sdk!", "name": "", "preserveMemberOrder": false, "members": [ { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!Acct:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type Acct = " }, { "kind": "Content", "text": "{\n username: string;\n host: string | null;\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/acct.ts", "releaseTag": "Public", "name": "Acct", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Namespace", "canonicalReference": "iceshrimp-sdk!api:namespace", "docComment": "", "excerptTokens": [], "fileUrlPath": "src/index.ts", "releaseTag": "None", "name": "api", "preserveMemberOrder": false, "members": [ { "kind": "Class", "canonicalReference": "iceshrimp-sdk!api.APIClient:class", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare class APIClient " } ], "fileUrlPath": "src/api.ts", "releaseTag": "Public", "isAbstract": false, "name": "APIClient", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "iceshrimp-sdk!api.APIClient:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `APIClient` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(opts: " }, { "kind": "Content", "text": "{\n origin: " }, { "kind": "Reference", "text": "APIClient", "canonicalReference": "iceshrimp-sdk!api.APIClient:class" }, { "kind": "Content", "text": "[\"origin\"];\n credential?: " }, { "kind": "Reference", "text": "APIClient", "canonicalReference": "iceshrimp-sdk!api.APIClient:class" }, { "kind": "Content", "text": "[\"credential\"];\n fetch?: " }, { "kind": "Reference", "text": "APIClient", "canonicalReference": "iceshrimp-sdk!api.APIClient:class" }, { "kind": "Content", "text": "[\"fetch\"] | null | undefined;\n }" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "opts", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 8 }, "isOptional": false } ] }, { "kind": "Property", "canonicalReference": "iceshrimp-sdk!api.APIClient#credential:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "credential: " }, { "kind": "Content", "text": "string | null | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "credential", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "iceshrimp-sdk!api.APIClient#fetch:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "fetch: " }, { "kind": "Reference", "text": "FetchLike", "canonicalReference": "iceshrimp-sdk!api.FetchLike:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fetch", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "iceshrimp-sdk!api.APIClient#origin:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "origin: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "origin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "iceshrimp-sdk!api.APIClient#request:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "request(endpoint: " }, { "kind": "Content", "text": "E" }, { "kind": "Content", "text": ", params?: " }, { "kind": "Content", "text": "P" }, { "kind": "Content", "text": ", credential?: " }, { "kind": "Content", "text": "string | null | undefined" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Endpoints", "canonicalReference": "iceshrimp-sdk!Endpoints:type" }, { "kind": "Content", "text": "[E][\"res\"] extends {\n $switch: {\n $cases: [any, any][];\n $default: any;\n };\n } ? " }, { "kind": "Reference", "text": "IsCaseMatched", "canonicalReference": "iceshrimp-sdk!~IsCaseMatched:type" }, { "kind": "Content", "text": " extends true ? " }, { "kind": "Reference", "text": "GetCaseResult", "canonicalReference": "iceshrimp-sdk!~GetCaseResult:type" }, { "kind": "Content", "text": " : " }, { "kind": "Reference", "text": "IsCaseMatched", "canonicalReference": "iceshrimp-sdk!~IsCaseMatched:type" }, { "kind": "Content", "text": " extends true ? " }, { "kind": "Reference", "text": "GetCaseResult", "canonicalReference": "iceshrimp-sdk!~GetCaseResult:type" }, { "kind": "Content", "text": " : " }, { "kind": "Reference", "text": "IsCaseMatched", "canonicalReference": "iceshrimp-sdk!~IsCaseMatched:type" }, { "kind": "Content", "text": " extends true ? " }, { "kind": "Reference", "text": "GetCaseResult", "canonicalReference": "iceshrimp-sdk!~GetCaseResult:type" }, { "kind": "Content", "text": " : " }, { "kind": "Reference", "text": "IsCaseMatched", "canonicalReference": "iceshrimp-sdk!~IsCaseMatched:type" }, { "kind": "Content", "text": " extends true ? " }, { "kind": "Reference", "text": "GetCaseResult", "canonicalReference": "iceshrimp-sdk!~GetCaseResult:type" }, { "kind": "Content", "text": " : " }, { "kind": "Reference", "text": "IsCaseMatched", "canonicalReference": "iceshrimp-sdk!~IsCaseMatched:type" }, { "kind": "Content", "text": " extends true ? " }, { "kind": "Reference", "text": "GetCaseResult", "canonicalReference": "iceshrimp-sdk!~GetCaseResult:type" }, { "kind": "Content", "text": " : " }, { "kind": "Reference", "text": "IsCaseMatched", "canonicalReference": "iceshrimp-sdk!~IsCaseMatched:type" }, { "kind": "Content", "text": " extends true ? " }, { "kind": "Reference", "text": "GetCaseResult", "canonicalReference": "iceshrimp-sdk!~GetCaseResult:type" }, { "kind": "Content", "text": " : " }, { "kind": "Reference", "text": "IsCaseMatched", "canonicalReference": "iceshrimp-sdk!~IsCaseMatched:type" }, { "kind": "Content", "text": " extends true ? " }, { "kind": "Reference", "text": "GetCaseResult", "canonicalReference": "iceshrimp-sdk!~GetCaseResult:type" }, { "kind": "Content", "text": " : " }, { "kind": "Reference", "text": "IsCaseMatched", "canonicalReference": "iceshrimp-sdk!~IsCaseMatched:type" }, { "kind": "Content", "text": " extends true ? " }, { "kind": "Reference", "text": "GetCaseResult", "canonicalReference": "iceshrimp-sdk!~GetCaseResult:type" }, { "kind": "Content", "text": " : " }, { "kind": "Reference", "text": "IsCaseMatched", "canonicalReference": "iceshrimp-sdk!~IsCaseMatched:type" }, { "kind": "Content", "text": " extends true ? " }, { "kind": "Reference", "text": "GetCaseResult", "canonicalReference": "iceshrimp-sdk!~GetCaseResult:type" }, { "kind": "Content", "text": " : " }, { "kind": "Reference", "text": "IsCaseMatched", "canonicalReference": "iceshrimp-sdk!~IsCaseMatched:type" }, { "kind": "Content", "text": " extends true ? " }, { "kind": "Reference", "text": "GetCaseResult", "canonicalReference": "iceshrimp-sdk!~GetCaseResult:type" }, { "kind": "Content", "text": " : " }, { "kind": "Reference", "text": "Endpoints", "canonicalReference": "iceshrimp-sdk!Endpoints:type" }, { "kind": "Content", "text": "[E][\"res\"][\"$switch\"][\"$default\"] : " }, { "kind": "Reference", "text": "Endpoints", "canonicalReference": "iceshrimp-sdk!Endpoints:type" }, { "kind": "Content", "text": "[E][\"res\"]>" }, { "kind": "Content", "text": ";" } ], "typeParameters": [ { "typeParameterName": "E", "constraintTokenRange": { "startIndex": 1, "endIndex": 3 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "P", "constraintTokenRange": { "startIndex": 4, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 61 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "endpoint", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false }, { "parameterName": "params", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": true }, { "parameterName": "credential", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "request" } ], "implementsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!api.APIError:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type APIError = " }, { "kind": "Content", "text": "{\n id: string;\n code: string;\n message: string;\n kind: \"client\" | \"server\";\n info: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": ";\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/api.ts", "releaseTag": "Public", "name": "APIError", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!api.FetchLike:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type FetchLike = " }, { "kind": "Content", "text": "(input: string, init?: {\n method?: string;\n body?: string;\n credentials?: " }, { "kind": "Reference", "text": "RequestCredentials", "canonicalReference": "!RequestCredentials:type" }, { "kind": "Content", "text": ";\n cache?: " }, { "kind": "Reference", "text": "RequestCache", "canonicalReference": "!RequestCache:type" }, { "kind": "Content", "text": ";\n}) => " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<{\n status: number;\n json(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": ";\n}>" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/api.ts", "releaseTag": "Public", "name": "FetchLike", "typeTokenRange": { "startIndex": 1, "endIndex": 10 } }, { "kind": "Function", "canonicalReference": "iceshrimp-sdk!api.isAPIError:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare function isAPIError(reason: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "reason", "canonicalReference": "iceshrimp-sdk!~reason" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "APIError", "canonicalReference": "iceshrimp-sdk!api.APIError:type" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/api.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "reason", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isAPIError" } ] }, { "kind": "Class", "canonicalReference": "iceshrimp-sdk!ChannelConnection:class", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare abstract class Connection" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "> extends " }, { "kind": "Reference", "text": "EventEmitter", "canonicalReference": "eventemitter3!EventEmitter.EventEmitter" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/streaming.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "Channel", "constraintTokenRange": { "startIndex": 1, "endIndex": 5 }, "defaultTypeTokenRange": { "startIndex": 6, "endIndex": 7 } } ], "isAbstract": true, "name": "ChannelConnection", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "iceshrimp-sdk!ChannelConnection:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `Connection` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(stream: " }, { "kind": "Reference", "text": "Stream", "canonicalReference": "iceshrimp-sdk!Stream:class" }, { "kind": "Content", "text": ", channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", name?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "stream", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ] }, { "kind": "Property", "canonicalReference": "iceshrimp-sdk!ChannelConnection#channel:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "channel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "iceshrimp-sdk!ChannelConnection#dispose:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "abstract dispose(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": true, "name": "dispose" }, { "kind": "Property", "canonicalReference": "iceshrimp-sdk!ChannelConnection#id:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "abstract id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": true }, { "kind": "Property", "canonicalReference": "iceshrimp-sdk!ChannelConnection#inCount:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "inCount: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "inCount", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "iceshrimp-sdk!ChannelConnection#name:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "name?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "iceshrimp-sdk!ChannelConnection#outCount:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "outCount: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "outCount", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "iceshrimp-sdk!ChannelConnection#send:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "send(type: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ", body: " }, { "kind": "Content", "text": "Channel[\"receives\"][T]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "body", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "send" }, { "kind": "Property", "canonicalReference": "iceshrimp-sdk!ChannelConnection#stream:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected stream: " }, { "kind": "Reference", "text": "Stream", "canonicalReference": "iceshrimp-sdk!Stream:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "stream", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 8, "endIndex": 10 }, "implementsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!Channels:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type Channels = " }, { "kind": "Content", "text": "{\n main: {\n params: null;\n events: {\n notification: (payload: " }, { "kind": "Reference", "text": "Notification", "canonicalReference": "iceshrimp-sdk!entities.Notification_2:type" }, { "kind": "Content", "text": ") => void;\n mention: (payload: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": ") => void;\n reply: (payload: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": ") => void;\n renote: (payload: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": ") => void;\n follow: (payload: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": ") => void;\n followed: (payload: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": ") => void;\n unfollow: (payload: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": ") => void;\n meUpdated: (payload: " }, { "kind": "Reference", "text": "MeDetailed", "canonicalReference": "iceshrimp-sdk!entities.MeDetailed:type" }, { "kind": "Content", "text": ") => void;\n pageEvent: (payload: " }, { "kind": "Reference", "text": "PageEvent", "canonicalReference": "iceshrimp-sdk!entities.PageEvent:type" }, { "kind": "Content", "text": ") => void;\n urlUploadFinished: (payload: {\n marker: string;\n file: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": ";\n }) => void;\n readAllNotifications: () => void;\n unreadNotification: (payload: " }, { "kind": "Reference", "text": "Notification", "canonicalReference": "iceshrimp-sdk!entities.Notification_2:type" }, { "kind": "Content", "text": ") => void;\n unreadMention: (payload: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"]) => void;\n readAllUnreadMentions: () => void;\n unreadSpecifiedNote: (payload: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"]) => void;\n readAllUnreadSpecifiedNotes: () => void;\n readAllMessagingMessages: () => void;\n messagingMessage: (payload: " }, { "kind": "Reference", "text": "MessagingMessage", "canonicalReference": "iceshrimp-sdk!entities.MessagingMessage:type" }, { "kind": "Content", "text": ") => void;\n unreadMessagingMessage: (payload: " }, { "kind": "Reference", "text": "MessagingMessage", "canonicalReference": "iceshrimp-sdk!entities.MessagingMessage:type" }, { "kind": "Content", "text": ") => void;\n readAllAntennas: () => void;\n unreadAntenna: (payload: " }, { "kind": "Reference", "text": "Antenna", "canonicalReference": "iceshrimp-sdk!entities.Antenna:type" }, { "kind": "Content", "text": ") => void;\n readAllAnnouncements: () => void;\n readAllChannels: () => void;\n unreadChannel: (payload: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"]) => void;\n myTokenRegenerated: () => void;\n reversiNoInvites: () => void;\n reversiInvited: (payload: " }, { "kind": "Reference", "text": "FIXME", "canonicalReference": "iceshrimp-sdk!~FIXME:type" }, { "kind": "Content", "text": ") => void;\n signin: (payload: " }, { "kind": "Reference", "text": "FIXME", "canonicalReference": "iceshrimp-sdk!~FIXME:type" }, { "kind": "Content", "text": ") => void;\n registryUpdated: (payload: {\n scope?: string[];\n key: string;\n value: any | null;\n }) => void;\n driveFileCreated: (payload: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": ") => void;\n readAntenna: (payload: " }, { "kind": "Reference", "text": "Antenna", "canonicalReference": "iceshrimp-sdk!entities.Antenna:type" }, { "kind": "Content", "text": ") => void;\n };\n receives: null;\n };\n homeTimeline: {\n params: null;\n events: {\n note: (payload: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": ") => void;\n };\n receives: null;\n };\n localTimeline: {\n params: null;\n events: {\n note: (payload: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": ") => void;\n };\n receives: null;\n };\n hybridTimeline: {\n params: null;\n events: {\n note: (payload: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": ") => void;\n };\n receives: null;\n };\n recommendedTimeline: {\n params: null;\n events: {\n note: (payload: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": ") => void;\n };\n receives: null;\n };\n globalTimeline: {\n params: null;\n events: {\n note: (payload: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": ") => void;\n };\n receives: null;\n };\n antenna: {\n params: {\n antennaId: " }, { "kind": "Reference", "text": "Antenna", "canonicalReference": "iceshrimp-sdk!entities.Antenna:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n events: {\n note: (payload: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": ") => void;\n };\n receives: null;\n };\n messaging: {\n params: {\n otherparty?: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"] | null;\n group?: " }, { "kind": "Reference", "text": "UserGroup", "canonicalReference": "iceshrimp-sdk!entities.UserGroup:type" }, { "kind": "Content", "text": "[\"id\"] | null;\n };\n events: {\n message: (payload: " }, { "kind": "Reference", "text": "MessagingMessage", "canonicalReference": "iceshrimp-sdk!entities.MessagingMessage:type" }, { "kind": "Content", "text": ") => void;\n deleted: (payload: " }, { "kind": "Reference", "text": "MessagingMessage", "canonicalReference": "iceshrimp-sdk!entities.MessagingMessage:type" }, { "kind": "Content", "text": "[\"id\"]) => void;\n read: (payload: " }, { "kind": "Reference", "text": "MessagingMessage", "canonicalReference": "iceshrimp-sdk!entities.MessagingMessage:type" }, { "kind": "Content", "text": "[\"id\"][]) => void;\n typers: (payload: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[]) => void;\n };\n receives: {\n read: {\n id: " }, { "kind": "Reference", "text": "MessagingMessage", "canonicalReference": "iceshrimp-sdk!entities.MessagingMessage:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n };\n };\n serverStats: {\n params: null;\n events: {\n stats: (payload: " }, { "kind": "Reference", "text": "FIXME", "canonicalReference": "iceshrimp-sdk!~FIXME:type" }, { "kind": "Content", "text": ") => void;\n };\n receives: {\n requestLog: {\n id: string | number;\n length: number;\n };\n };\n };\n queueStats: {\n params: null;\n events: {\n stats: (payload: " }, { "kind": "Reference", "text": "FIXME", "canonicalReference": "iceshrimp-sdk!~FIXME:type" }, { "kind": "Content", "text": ") => void;\n };\n receives: {\n requestLog: {\n id: string | number;\n length: number;\n };\n };\n };\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/streaming.types.ts", "releaseTag": "Public", "name": "Channels", "typeTokenRange": { "startIndex": 1, "endIndex": 76 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!Endpoints:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type Endpoints = " }, { "kind": "Content", "text": "{\n \"admin/abuse-user-reports\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/delete-all-files-of-a-user\": {\n req: {\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"admin/delete-logs\": {\n req: " }, { "kind": "Reference", "text": "NoParams", "canonicalReference": "iceshrimp-sdk!~NoParams:type" }, { "kind": "Content", "text": ";\n res: null;\n };\n \"admin/get-index-stats\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/get-table-stats\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/invite\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/logs\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/meta\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/reset-password\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/resolve-abuse-user-report\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/resync-chart\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/send-email\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/server-info\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/show-moderation-logs\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/show-user\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/show-users\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/silence-user\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/suspend-user\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/unsilence-user\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/unsuspend-user\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/update-meta\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/vacuum\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/accounts/create\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/announcements/create\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/announcements/delete\": {\n req: {\n id: " }, { "kind": "Reference", "text": "Announcement", "canonicalReference": "iceshrimp-sdk!entities.Announcement:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"admin/announcements/list\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/announcements/update\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/drive/clean-remote-files\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/drive/cleanup\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/drive/files\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/drive/show-file\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/emoji/add\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/emoji/copy\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/emoji/list-remote\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/emoji/list\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/emoji/remove\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/emoji/update\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/federation/delete-all-files\": {\n req: {\n host: string;\n };\n res: null;\n };\n \"admin/federation/refresh-remote-instance-metadata\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/federation/remove-all-following\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/federation/update-instance\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/moderators/add\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/moderators/remove\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/promo/create\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/queue/clear\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/queue/deliver-delayed\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/queue/inbox-delayed\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/queue/jobs\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/queue/stats\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/relays/add\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/relays/list\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"admin/relays/remove\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n announcements: {\n req: {\n limit?: number;\n withUnreads?: boolean;\n sinceId?: " }, { "kind": "Reference", "text": "Announcement", "canonicalReference": "iceshrimp-sdk!entities.Announcement:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "Announcement", "canonicalReference": "iceshrimp-sdk!entities.Announcement:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "Announcement", "canonicalReference": "iceshrimp-sdk!entities.Announcement:type" }, { "kind": "Content", "text": "[];\n };\n \"antennas/create\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "Antenna", "canonicalReference": "iceshrimp-sdk!entities.Antenna:type" }, { "kind": "Content", "text": ";\n };\n \"antennas/delete\": {\n req: {\n antennaId: " }, { "kind": "Reference", "text": "Antenna", "canonicalReference": "iceshrimp-sdk!entities.Antenna:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"antennas/list\": {\n req: " }, { "kind": "Reference", "text": "NoParams", "canonicalReference": "iceshrimp-sdk!~NoParams:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "Antenna", "canonicalReference": "iceshrimp-sdk!entities.Antenna:type" }, { "kind": "Content", "text": "[];\n };\n \"antennas/notes\": {\n req: {\n antennaId: " }, { "kind": "Reference", "text": "Antenna", "canonicalReference": "iceshrimp-sdk!entities.Antenna:type" }, { "kind": "Content", "text": "[\"id\"];\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[];\n };\n \"antennas/show\": {\n req: {\n antennaId: " }, { "kind": "Reference", "text": "Antenna", "canonicalReference": "iceshrimp-sdk!entities.Antenna:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "Antenna", "canonicalReference": "iceshrimp-sdk!entities.Antenna:type" }, { "kind": "Content", "text": ";\n };\n \"antennas/update\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "Antenna", "canonicalReference": "iceshrimp-sdk!entities.Antenna:type" }, { "kind": "Content", "text": ";\n };\n \"antennas/mark-read\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "Antenna", "canonicalReference": "iceshrimp-sdk!entities.Antenna:type" }, { "kind": "Content", "text": ";\n };\n \"ap/get\": {\n req: {\n uri: string;\n };\n res: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": ";\n };\n \"ap/show\": {\n req: {\n uri: string;\n };\n res: {\n type: \"Note\";\n object: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": ";\n } | {\n type: \"User\";\n object: " }, { "kind": "Reference", "text": "UserDetailed", "canonicalReference": "iceshrimp-sdk!entities.UserDetailed:type" }, { "kind": "Content", "text": ";\n };\n };\n \"app/create\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "App", "canonicalReference": "iceshrimp-sdk!entities.App:type" }, { "kind": "Content", "text": ";\n };\n \"app/show\": {\n req: {\n appId: " }, { "kind": "Reference", "text": "App", "canonicalReference": "iceshrimp-sdk!entities.App:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "App", "canonicalReference": "iceshrimp-sdk!entities.App:type" }, { "kind": "Content", "text": ";\n };\n \"auth/accept\": {\n req: {\n token: string;\n };\n res: null;\n };\n \"auth/session/generate\": {\n req: {\n appSecret: string;\n };\n res: {\n token: string;\n url: string;\n };\n };\n \"auth/session/show\": {\n req: {\n token: string;\n };\n res: " }, { "kind": "Reference", "text": "AuthSession", "canonicalReference": "iceshrimp-sdk!entities.AuthSession:type" }, { "kind": "Content", "text": ";\n };\n \"auth/session/userkey\": {\n req: {\n appSecret: string;\n token: string;\n };\n res: {\n accessToken: string;\n user: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": ";\n };\n };\n \"blocking/create\": {\n req: {\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "UserDetailed", "canonicalReference": "iceshrimp-sdk!entities.UserDetailed:type" }, { "kind": "Content", "text": ";\n };\n \"blocking/delete\": {\n req: {\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "UserDetailed", "canonicalReference": "iceshrimp-sdk!entities.UserDetailed:type" }, { "kind": "Content", "text": ";\n };\n \"blocking/list\": {\n req: {\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "Blocking", "canonicalReference": "iceshrimp-sdk!entities.Blocking:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "Blocking", "canonicalReference": "iceshrimp-sdk!entities.Blocking:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "Blocking", "canonicalReference": "iceshrimp-sdk!entities.Blocking:type" }, { "kind": "Content", "text": "[];\n };\n \"channels/create\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"channels/featured\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"channels/follow\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"channels/followed\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"channels/owned\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"channels/pin-note\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"channels/show\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"channels/timeline\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"channels/unfollow\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"channels/update\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"charts/active-users\": {\n req: {\n span: \"day\" | \"hour\";\n limit?: number;\n offset?: number | null;\n };\n res: {\n local: {\n users: number[];\n };\n remote: {\n users: number[];\n };\n };\n };\n \"charts/drive\": {\n req: {\n span: \"day\" | \"hour\";\n limit?: number;\n offset?: number | null;\n };\n res: {\n local: {\n decCount: number[];\n decSize: number[];\n incCount: number[];\n incSize: number[];\n totalCount: number[];\n totalSize: number[];\n };\n remote: {\n decCount: number[];\n decSize: number[];\n incCount: number[];\n incSize: number[];\n totalCount: number[];\n totalSize: number[];\n };\n };\n };\n \"charts/federation\": {\n req: {\n span: \"day\" | \"hour\";\n limit?: number;\n offset?: number | null;\n };\n res: {\n instance: {\n dec: number[];\n inc: number[];\n total: number[];\n };\n };\n };\n \"charts/hashtag\": {\n req: {\n span: \"day\" | \"hour\";\n limit?: number;\n offset?: number | null;\n };\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"charts/instance\": {\n req: {\n span: \"day\" | \"hour\";\n limit?: number;\n offset?: number | null;\n host: string;\n };\n res: {\n drive: {\n decFiles: number[];\n decUsage: number[];\n incFiles: number[];\n incUsage: number[];\n totalFiles: number[];\n totalUsage: number[];\n };\n followers: {\n dec: number[];\n inc: number[];\n total: number[];\n };\n following: {\n dec: number[];\n inc: number[];\n total: number[];\n };\n notes: {\n dec: number[];\n inc: number[];\n total: number[];\n diffs: {\n normal: number[];\n renote: number[];\n reply: number[];\n };\n };\n requests: {\n failed: number[];\n received: number[];\n succeeded: number[];\n };\n users: {\n dec: number[];\n inc: number[];\n total: number[];\n };\n };\n };\n \"charts/network\": {\n req: {\n span: \"day\" | \"hour\";\n limit?: number;\n offset?: number | null;\n };\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"charts/notes\": {\n req: {\n span: \"day\" | \"hour\";\n limit?: number;\n offset?: number | null;\n };\n res: {\n local: {\n dec: number[];\n inc: number[];\n total: number[];\n diffs: {\n normal: number[];\n renote: number[];\n reply: number[];\n };\n };\n remote: {\n dec: number[];\n inc: number[];\n total: number[];\n diffs: {\n normal: number[];\n renote: number[];\n reply: number[];\n };\n };\n };\n };\n \"charts/user/drive\": {\n req: {\n span: \"day\" | \"hour\";\n limit?: number;\n offset?: number | null;\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: {\n decCount: number[];\n decSize: number[];\n incCount: number[];\n incSize: number[];\n totalCount: number[];\n totalSize: number[];\n };\n };\n \"charts/user/following\": {\n req: {\n span: \"day\" | \"hour\";\n limit?: number;\n offset?: number | null;\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"charts/user/notes\": {\n req: {\n span: \"day\" | \"hour\";\n limit?: number;\n offset?: number | null;\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: {\n dec: number[];\n inc: number[];\n total: number[];\n diffs: {\n normal: number[];\n renote: number[];\n reply: number[];\n };\n };\n };\n \"charts/user/reactions\": {\n req: {\n span: \"day\" | \"hour\";\n limit?: number;\n offset?: number | null;\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"charts/users\": {\n req: {\n span: \"day\" | \"hour\";\n limit?: number;\n offset?: number | null;\n };\n res: {\n local: {\n dec: number[];\n inc: number[];\n total: number[];\n };\n remote: {\n dec: number[];\n inc: number[];\n total: number[];\n };\n };\n };\n \"clips/add-note\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"clips/create\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"clips/delete\": {\n req: {\n clipId: " }, { "kind": "Reference", "text": "Clip", "canonicalReference": "iceshrimp-sdk!entities.Clip:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"clips/list\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"clips/notes\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"clips/show\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"clips/update\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n drive: {\n req: " }, { "kind": "Reference", "text": "NoParams", "canonicalReference": "iceshrimp-sdk!~NoParams:type" }, { "kind": "Content", "text": ";\n res: {\n capacity: number;\n usage: number;\n };\n };\n \"drive/files\": {\n req: {\n folderId?: " }, { "kind": "Reference", "text": "DriveFolder", "canonicalReference": "iceshrimp-sdk!entities.DriveFolder:type" }, { "kind": "Content", "text": "[\"id\"] | null;\n type?: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": "[\"type\"] | null;\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": "[];\n };\n \"drive/files/attached-notes\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"drive/files/check-existence\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"drive/files/create\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"drive/files/delete\": {\n req: {\n fileId: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"drive/files/find-by-hash\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"drive/files/find\": {\n req: {\n name: string;\n folderId?: " }, { "kind": "Reference", "text": "DriveFolder", "canonicalReference": "iceshrimp-sdk!entities.DriveFolder:type" }, { "kind": "Content", "text": "[\"id\"] | null;\n };\n res: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": "[];\n };\n \"drive/files/show\": {\n req: {\n fileId?: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": "[\"id\"];\n url?: string;\n };\n res: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": ";\n };\n \"drive/files/update\": {\n req: {\n fileId: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": "[\"id\"];\n folderId?: " }, { "kind": "Reference", "text": "DriveFolder", "canonicalReference": "iceshrimp-sdk!entities.DriveFolder:type" }, { "kind": "Content", "text": "[\"id\"] | null;\n name?: string;\n isSensitive?: boolean;\n comment?: string | null;\n };\n res: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": ";\n };\n \"drive/files/upload-from-url\": {\n req: {\n url: string;\n folderId?: " }, { "kind": "Reference", "text": "DriveFolder", "canonicalReference": "iceshrimp-sdk!entities.DriveFolder:type" }, { "kind": "Content", "text": "[\"id\"] | null;\n isSensitive?: boolean;\n comment?: string | null;\n marker?: string | null;\n force?: boolean;\n };\n res: null;\n };\n \"drive/folders\": {\n req: {\n folderId?: " }, { "kind": "Reference", "text": "DriveFolder", "canonicalReference": "iceshrimp-sdk!entities.DriveFolder:type" }, { "kind": "Content", "text": "[\"id\"] | null;\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "DriveFolder", "canonicalReference": "iceshrimp-sdk!entities.DriveFolder:type" }, { "kind": "Content", "text": "[];\n };\n \"drive/folders/create\": {\n req: {\n name?: string;\n parentId?: " }, { "kind": "Reference", "text": "DriveFolder", "canonicalReference": "iceshrimp-sdk!entities.DriveFolder:type" }, { "kind": "Content", "text": "[\"id\"] | null;\n };\n res: " }, { "kind": "Reference", "text": "DriveFolder", "canonicalReference": "iceshrimp-sdk!entities.DriveFolder:type" }, { "kind": "Content", "text": ";\n };\n \"drive/folders/delete\": {\n req: {\n folderId: " }, { "kind": "Reference", "text": "DriveFolder", "canonicalReference": "iceshrimp-sdk!entities.DriveFolder:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"drive/folders/find\": {\n req: {\n name: string;\n parentId?: " }, { "kind": "Reference", "text": "DriveFolder", "canonicalReference": "iceshrimp-sdk!entities.DriveFolder:type" }, { "kind": "Content", "text": "[\"id\"] | null;\n };\n res: " }, { "kind": "Reference", "text": "DriveFolder", "canonicalReference": "iceshrimp-sdk!entities.DriveFolder:type" }, { "kind": "Content", "text": "[];\n };\n \"drive/folders/show\": {\n req: {\n folderId: " }, { "kind": "Reference", "text": "DriveFolder", "canonicalReference": "iceshrimp-sdk!entities.DriveFolder:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "DriveFolder", "canonicalReference": "iceshrimp-sdk!entities.DriveFolder:type" }, { "kind": "Content", "text": ";\n };\n \"drive/folders/update\": {\n req: {\n folderId: " }, { "kind": "Reference", "text": "DriveFolder", "canonicalReference": "iceshrimp-sdk!entities.DriveFolder:type" }, { "kind": "Content", "text": "[\"id\"];\n name?: string;\n parentId?: " }, { "kind": "Reference", "text": "DriveFolder", "canonicalReference": "iceshrimp-sdk!entities.DriveFolder:type" }, { "kind": "Content", "text": "[\"id\"] | null;\n };\n res: " }, { "kind": "Reference", "text": "DriveFolder", "canonicalReference": "iceshrimp-sdk!entities.DriveFolder:type" }, { "kind": "Content", "text": ";\n };\n \"drive/stream\": {\n req: {\n type?: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": "[\"type\"] | null;\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": "[];\n };\n endpoint: {\n req: {\n endpoint: string;\n };\n res: {\n params: {\n name: string;\n type: string;\n }[];\n };\n };\n endpoints: {\n req: " }, { "kind": "Reference", "text": "NoParams", "canonicalReference": "iceshrimp-sdk!~NoParams:type" }, { "kind": "Content", "text": ";\n res: string[];\n };\n \"federation/dns\": {\n req: {\n host: string;\n };\n res: {\n a: string[];\n aaaa: string[];\n cname: string[];\n txt: string[];\n };\n };\n \"federation/followers\": {\n req: {\n host: string;\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "Following", "canonicalReference": "iceshrimp-sdk!entities.Following:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "Following", "canonicalReference": "iceshrimp-sdk!entities.Following:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "FollowingFolloweePopulated", "canonicalReference": "iceshrimp-sdk!entities.FollowingFolloweePopulated:type" }, { "kind": "Content", "text": "[];\n };\n \"federation/following\": {\n req: {\n host: string;\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "Following", "canonicalReference": "iceshrimp-sdk!entities.Following:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "Following", "canonicalReference": "iceshrimp-sdk!entities.Following:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "FollowingFolloweePopulated", "canonicalReference": "iceshrimp-sdk!entities.FollowingFolloweePopulated:type" }, { "kind": "Content", "text": "[];\n };\n \"federation/instances\": {\n req: {\n host?: string | null;\n blocked?: boolean | null;\n notResponding?: boolean | null;\n suspended?: boolean | null;\n federating?: boolean | null;\n subscribing?: boolean | null;\n publishing?: boolean | null;\n limit?: number;\n offset?: number;\n sort?: \"+pubSub\" | \"-pubSub\" | \"+notes\" | \"-notes\" | \"+users\" | \"-users\" | \"+following\" | \"-following\" | \"+followers\" | \"-followers\" | \"+caughtAt\" | \"-caughtAt\" | \"+lastCommunicatedAt\" | \"-lastCommunicatedAt\" | \"+driveUsage\" | \"-driveUsage\" | \"+driveFiles\" | \"-driveFiles\";\n };\n res: " }, { "kind": "Reference", "text": "Instance", "canonicalReference": "iceshrimp-sdk!entities.Instance:type" }, { "kind": "Content", "text": "[];\n };\n \"federation/show-instance\": {\n req: {\n host: string;\n };\n res: " }, { "kind": "Reference", "text": "Instance", "canonicalReference": "iceshrimp-sdk!entities.Instance:type" }, { "kind": "Content", "text": ";\n };\n \"federation/update-remote-user\": {\n req: {\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"federation/users\": {\n req: {\n host: string;\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "UserDetailed", "canonicalReference": "iceshrimp-sdk!entities.UserDetailed:type" }, { "kind": "Content", "text": "[];\n };\n \"following/create\": {\n req: {\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": ";\n };\n \"following/delete\": {\n req: {\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": ";\n };\n \"following/requests/accept\": {\n req: {\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"following/requests/cancel\": {\n req: {\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": ";\n };\n \"following/requests/list\": {\n req: " }, { "kind": "Reference", "text": "NoParams", "canonicalReference": "iceshrimp-sdk!~NoParams:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "FollowRequest", "canonicalReference": "iceshrimp-sdk!entities.FollowRequest:type" }, { "kind": "Content", "text": "[];\n };\n \"following/requests/reject\": {\n req: {\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"gallery/featured\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"gallery/popular\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"gallery/posts\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"gallery/posts/create\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"gallery/posts/delete\": {\n req: {\n postId: " }, { "kind": "Reference", "text": "GalleryPost", "canonicalReference": "iceshrimp-sdk!entities.GalleryPost:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"gallery/posts/like\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"gallery/posts/show\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"gallery/posts/unlike\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"gallery/posts/update\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"games/reversi/games\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"games/reversi/games/show\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"games/reversi/games/surrender\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"games/reversi/invitations\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"games/reversi/match\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"games/reversi/match/cancel\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"get-online-users-count\": {\n req: " }, { "kind": "Reference", "text": "NoParams", "canonicalReference": "iceshrimp-sdk!~NoParams:type" }, { "kind": "Content", "text": ";\n res: {\n count: number;\n };\n };\n \"hashtags/list\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"hashtags/search\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"hashtags/show\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"hashtags/trend\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"hashtags/users\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n i: {\n req: " }, { "kind": "Reference", "text": "NoParams", "canonicalReference": "iceshrimp-sdk!~NoParams:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": ";\n };\n \"i/apps\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/authorized-apps\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/change-password\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/delete-account\": {\n req: {\n password: string;\n };\n res: null;\n };\n \"i/export-blocking\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/export-following\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/export-mute\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/export-notes\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/export-user-lists\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/favorites\": {\n req: {\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "NoteFavorite", "canonicalReference": "iceshrimp-sdk!entities.NoteFavorite:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "NoteFavorite", "canonicalReference": "iceshrimp-sdk!entities.NoteFavorite:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "NoteFavorite", "canonicalReference": "iceshrimp-sdk!entities.NoteFavorite:type" }, { "kind": "Content", "text": "[];\n };\n \"i/gallery/likes\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/gallery/posts\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/import-following\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/import-user-lists\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/move\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/known-as\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/notifications\": {\n req: {\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "Notification", "canonicalReference": "iceshrimp-sdk!entities.Notification_2:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "Notification", "canonicalReference": "iceshrimp-sdk!entities.Notification_2:type" }, { "kind": "Content", "text": "[\"id\"];\n following?: boolean;\n markAsRead?: boolean;\n includeTypes?: " }, { "kind": "Reference", "text": "Notification", "canonicalReference": "iceshrimp-sdk!entities.Notification_2:type" }, { "kind": "Content", "text": "[\"type\"][];\n excludeTypes?: " }, { "kind": "Reference", "text": "Notification", "canonicalReference": "iceshrimp-sdk!entities.Notification_2:type" }, { "kind": "Content", "text": "[\"type\"][];\n };\n res: " }, { "kind": "Reference", "text": "Notification", "canonicalReference": "iceshrimp-sdk!entities.Notification_2:type" }, { "kind": "Content", "text": "[];\n };\n \"i/page-likes\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/pages\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/pin\": {\n req: {\n noteId: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "MeDetailed", "canonicalReference": "iceshrimp-sdk!entities.MeDetailed:type" }, { "kind": "Content", "text": ";\n };\n \"i/read-all-messaging-messages\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/read-all-unread-notes\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/read-announcement\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/regenerate-token\": {\n req: {\n password: string;\n };\n res: null;\n };\n \"i/registry/get-all\": {\n req: {\n scope?: string[];\n };\n res: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": ";\n };\n \"i/registry/get-detail\": {\n req: {\n key: string;\n scope?: string[];\n };\n res: {\n updatedAt: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": ";\n value: any;\n };\n };\n \"i/registry/get\": {\n req: {\n key: string;\n scope?: string[];\n };\n res: any;\n };\n \"i/registry/keys-with-type\": {\n req: {\n scope?: string[];\n };\n res: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": ";\n };\n \"i/registry/keys\": {\n req: {\n scope?: string[];\n };\n res: string[];\n };\n \"i/registry/remove\": {\n req: {\n key: string;\n scope?: string[];\n };\n res: null;\n };\n \"i/registry/scopes\": {\n req: " }, { "kind": "Reference", "text": "NoParams", "canonicalReference": "iceshrimp-sdk!~NoParams:type" }, { "kind": "Content", "text": ";\n res: string[][];\n };\n \"i/registry/set\": {\n req: {\n key: string;\n value: any;\n scope?: string[];\n };\n res: null;\n };\n \"i/revoke-token\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/signin-history\": {\n req: {\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "Signin", "canonicalReference": "iceshrimp-sdk!entities.Signin:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "Signin", "canonicalReference": "iceshrimp-sdk!entities.Signin:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "Signin", "canonicalReference": "iceshrimp-sdk!entities.Signin:type" }, { "kind": "Content", "text": "[];\n };\n \"i/unpin\": {\n req: {\n noteId: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "MeDetailed", "canonicalReference": "iceshrimp-sdk!entities.MeDetailed:type" }, { "kind": "Content", "text": ";\n };\n \"i/update-email\": {\n req: {\n password: string;\n email?: string | null;\n };\n res: " }, { "kind": "Reference", "text": "MeDetailed", "canonicalReference": "iceshrimp-sdk!entities.MeDetailed:type" }, { "kind": "Content", "text": ";\n };\n \"i/update\": {\n req: {\n name?: string | null;\n description?: string | null;\n lang?: string | null;\n location?: string | null;\n birthday?: string | null;\n avatarId?: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": "[\"id\"] | null;\n bannerId?: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": "[\"id\"] | null;\n fields?: {\n name: string;\n value: string;\n }[];\n isLocked?: boolean;\n isExplorable?: boolean;\n hideOnlineStatus?: boolean;\n carefulBot?: boolean;\n autoAcceptFollowed?: boolean;\n noCrawle?: boolean;\n preventAiLearning?: boolean;\n isBot?: boolean;\n isCat?: boolean;\n injectFeaturedNote?: boolean;\n receiveAnnouncementEmail?: boolean;\n alwaysMarkNsfw?: boolean;\n mutedWords?: string[][];\n mutingNotificationTypes?: " }, { "kind": "Reference", "text": "Notification", "canonicalReference": "iceshrimp-sdk!entities.Notification_2:type" }, { "kind": "Content", "text": "[\"type\"][];\n emailNotificationTypes?: string[];\n };\n res: " }, { "kind": "Reference", "text": "MeDetailed", "canonicalReference": "iceshrimp-sdk!entities.MeDetailed:type" }, { "kind": "Content", "text": ";\n };\n \"i/user-group-invites\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/2fa/done\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/2fa/key-done\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/2fa/password-less\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/2fa/register-key\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/2fa/register\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/2fa/update-key\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/2fa/remove-key\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"i/2fa/unregister\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"messaging/history\": {\n req: {\n limit?: number;\n group?: boolean;\n };\n res: " }, { "kind": "Reference", "text": "MessagingMessage", "canonicalReference": "iceshrimp-sdk!entities.MessagingMessage:type" }, { "kind": "Content", "text": "[];\n };\n \"messaging/messages\": {\n req: {\n userId?: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n groupId?: " }, { "kind": "Reference", "text": "UserGroup", "canonicalReference": "iceshrimp-sdk!entities.UserGroup:type" }, { "kind": "Content", "text": "[\"id\"];\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "MessagingMessage", "canonicalReference": "iceshrimp-sdk!entities.MessagingMessage:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "MessagingMessage", "canonicalReference": "iceshrimp-sdk!entities.MessagingMessage:type" }, { "kind": "Content", "text": "[\"id\"];\n markAsRead?: boolean;\n };\n res: " }, { "kind": "Reference", "text": "MessagingMessage", "canonicalReference": "iceshrimp-sdk!entities.MessagingMessage:type" }, { "kind": "Content", "text": "[];\n };\n \"messaging/messages/create\": {\n req: {\n userId?: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n groupId?: " }, { "kind": "Reference", "text": "UserGroup", "canonicalReference": "iceshrimp-sdk!entities.UserGroup:type" }, { "kind": "Content", "text": "[\"id\"];\n text?: string;\n fileId?: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "MessagingMessage", "canonicalReference": "iceshrimp-sdk!entities.MessagingMessage:type" }, { "kind": "Content", "text": ";\n };\n \"messaging/messages/delete\": {\n req: {\n messageId: " }, { "kind": "Reference", "text": "MessagingMessage", "canonicalReference": "iceshrimp-sdk!entities.MessagingMessage:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"messaging/messages/read\": {\n req: {\n messageId: " }, { "kind": "Reference", "text": "MessagingMessage", "canonicalReference": "iceshrimp-sdk!entities.MessagingMessage:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n meta: {\n req: {\n detail?: boolean;\n };\n res: {\n $switch: {\n $cases: [\n [\n {\n detail: true;\n },\n " }, { "kind": "Reference", "text": "DetailedInstanceMetadata", "canonicalReference": "iceshrimp-sdk!entities.DetailedInstanceMetadata:type" }, { "kind": "Content", "text": "\n ],\n [\n {\n detail: false;\n },\n " }, { "kind": "Reference", "text": "LiteInstanceMetadata", "canonicalReference": "iceshrimp-sdk!entities.LiteInstanceMetadata:type" }, { "kind": "Content", "text": "\n ],\n [\n {\n detail: boolean;\n },\n " }, { "kind": "Reference", "text": "LiteInstanceMetadata", "canonicalReference": "iceshrimp-sdk!entities.LiteInstanceMetadata:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "DetailedInstanceMetadata", "canonicalReference": "iceshrimp-sdk!entities.DetailedInstanceMetadata:type" }, { "kind": "Content", "text": "\n ]\n ];\n $default: " }, { "kind": "Reference", "text": "LiteInstanceMetadata", "canonicalReference": "iceshrimp-sdk!entities.LiteInstanceMetadata:type" }, { "kind": "Content", "text": ";\n };\n };\n };\n \"miauth/gen-token\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"mute/create\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"mute/delete\": {\n req: {\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"mute/list\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"renote-mute/create\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"renote-mute/delete\": {\n req: {\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"renote-mute/list\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"my/apps\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n notes: {\n req: {\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[];\n };\n \"notes/children\": {\n req: {\n noteId: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[];\n };\n \"notes/clips\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"notes/conversation\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"notes/create\": {\n req: " }, { "kind": "Reference", "text": "NoteSubmitReq", "canonicalReference": "iceshrimp-sdk!~NoteSubmitReq:type" }, { "kind": "Content", "text": ";\n res: {\n createdNote: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": ";\n };\n };\n \"notes/delete\": {\n req: {\n noteId: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"notes/edit\": {\n req: " }, { "kind": "Reference", "text": "NoteSubmitReq", "canonicalReference": "iceshrimp-sdk!~NoteSubmitReq:type" }, { "kind": "Content", "text": ";\n res: {\n createdNote: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": ";\n };\n };\n \"notes/favorites/create\": {\n req: {\n noteId: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"notes/favorites/delete\": {\n req: {\n noteId: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"notes/featured\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[];\n };\n \"notes/global-timeline\": {\n req: {\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n sinceDate?: number;\n untilDate?: number;\n };\n res: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[];\n };\n \"notes/recommended-timeline\": {\n req: {\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n sinceDate?: number;\n untilDate?: number;\n };\n res: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[];\n };\n \"notes/hybrid-timeline\": {\n req: {\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n sinceDate?: number;\n untilDate?: number;\n };\n res: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[];\n };\n \"notes/local-timeline\": {\n req: {\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n sinceDate?: number;\n untilDate?: number;\n };\n res: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[];\n };\n \"notes/mentions\": {\n req: {\n following?: boolean;\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[];\n };\n \"notes/polls/recommendation\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"notes/polls/vote\": {\n req: {\n noteId: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n choice: number;\n };\n res: null;\n };\n \"notes/reactions\": {\n req: {\n noteId: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n type?: string | null;\n limit?: number;\n };\n res: " }, { "kind": "Reference", "text": "NoteReaction", "canonicalReference": "iceshrimp-sdk!entities.NoteReaction:type" }, { "kind": "Content", "text": "[];\n };\n \"notes/reactions/create\": {\n req: {\n noteId: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n reaction: string;\n };\n res: null;\n };\n \"notes/reactions/delete\": {\n req: {\n noteId: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"notes/renotes\": {\n req: {\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n noteId: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[];\n };\n \"notes/replies\": {\n req: {\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n noteId: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[];\n };\n \"notes/search-by-tag\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"notes/search\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"notes/show\": {\n req: {\n noteId: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": ";\n };\n \"notes/state\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"notes/timeline\": {\n req: {\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n sinceDate?: number;\n untilDate?: number;\n };\n res: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[];\n };\n \"notes/unrenote\": {\n req: {\n noteId: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"notes/user-list-timeline\": {\n req: {\n listId: " }, { "kind": "Reference", "text": "UserList", "canonicalReference": "iceshrimp-sdk!entities.UserList:type" }, { "kind": "Content", "text": "[\"id\"];\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n sinceDate?: number;\n untilDate?: number;\n };\n res: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[];\n };\n \"notes/watching/create\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"notes/watching/delete\": {\n req: {\n noteId: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"notifications/create\": {\n req: {\n body: string;\n header?: string | null;\n icon?: string | null;\n };\n res: null;\n };\n \"notifications/mark-all-as-read\": {\n req: " }, { "kind": "Reference", "text": "NoParams", "canonicalReference": "iceshrimp-sdk!~NoParams:type" }, { "kind": "Content", "text": ";\n res: null;\n };\n \"notifications/read\": {\n req: {\n notificationId: " }, { "kind": "Reference", "text": "Notification", "canonicalReference": "iceshrimp-sdk!entities.Notification_2:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"page-push\": {\n req: {\n pageId: " }, { "kind": "Reference", "text": "Page", "canonicalReference": "iceshrimp-sdk!entities.Page:type" }, { "kind": "Content", "text": "[\"id\"];\n event: string;\n var?: any;\n };\n res: null;\n };\n \"pages/create\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "Page", "canonicalReference": "iceshrimp-sdk!entities.Page:type" }, { "kind": "Content", "text": ";\n };\n \"pages/delete\": {\n req: {\n pageId: " }, { "kind": "Reference", "text": "Page", "canonicalReference": "iceshrimp-sdk!entities.Page:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"pages/featured\": {\n req: " }, { "kind": "Reference", "text": "NoParams", "canonicalReference": "iceshrimp-sdk!~NoParams:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "Page", "canonicalReference": "iceshrimp-sdk!entities.Page:type" }, { "kind": "Content", "text": "[];\n };\n \"pages/like\": {\n req: {\n pageId: " }, { "kind": "Reference", "text": "Page", "canonicalReference": "iceshrimp-sdk!entities.Page:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"pages/show\": {\n req: {\n pageId?: " }, { "kind": "Reference", "text": "Page", "canonicalReference": "iceshrimp-sdk!entities.Page:type" }, { "kind": "Content", "text": "[\"id\"];\n name?: string;\n username?: string;\n };\n res: " }, { "kind": "Reference", "text": "Page", "canonicalReference": "iceshrimp-sdk!entities.Page:type" }, { "kind": "Content", "text": ";\n };\n \"pages/unlike\": {\n req: {\n pageId: " }, { "kind": "Reference", "text": "Page", "canonicalReference": "iceshrimp-sdk!entities.Page:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"pages/update\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: null;\n };\n ping: {\n req: " }, { "kind": "Reference", "text": "NoParams", "canonicalReference": "iceshrimp-sdk!~NoParams:type" }, { "kind": "Content", "text": ";\n res: {\n pong: number;\n };\n };\n \"pinned-users\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"promo/read\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"request-reset-password\": {\n req: {\n username: string;\n email: string;\n };\n res: null;\n };\n \"reset-password\": {\n req: {\n token: string;\n password: string;\n };\n res: null;\n };\n \"room/show\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"room/update\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n stats: {\n req: " }, { "kind": "Reference", "text": "NoParams", "canonicalReference": "iceshrimp-sdk!~NoParams:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "Stats", "canonicalReference": "iceshrimp-sdk!entities.Stats:type" }, { "kind": "Content", "text": ";\n };\n \"server-info\": {\n req: " }, { "kind": "Reference", "text": "NoParams", "canonicalReference": "iceshrimp-sdk!~NoParams:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "ServerInfo", "canonicalReference": "iceshrimp-sdk!entities.ServerInfo:type" }, { "kind": "Content", "text": ";\n };\n \"latest-version\": {\n req: " }, { "kind": "Reference", "text": "NoParams", "canonicalReference": "iceshrimp-sdk!~NoParams:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"sw/register\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"username/available\": {\n req: {\n username: string;\n };\n res: {\n available: boolean;\n };\n };\n users: {\n req: {\n limit?: number;\n offset?: number;\n sort?: " }, { "kind": "Reference", "text": "UserSorting", "canonicalReference": "iceshrimp-sdk!entities.UserSorting:type" }, { "kind": "Content", "text": ";\n origin?: " }, { "kind": "Reference", "text": "OriginType", "canonicalReference": "iceshrimp-sdk!entities.OriginType:type" }, { "kind": "Content", "text": ";\n };\n res: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[];\n };\n \"users/clips\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"users/followers\": {\n req: {\n userId?: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n username?: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"username\"];\n host?: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"host\"] | null;\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "Following", "canonicalReference": "iceshrimp-sdk!entities.Following:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "Following", "canonicalReference": "iceshrimp-sdk!entities.Following:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "FollowingFollowerPopulated", "canonicalReference": "iceshrimp-sdk!entities.FollowingFollowerPopulated:type" }, { "kind": "Content", "text": "[];\n };\n \"users/following\": {\n req: {\n userId?: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n username?: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"username\"];\n host?: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"host\"] | null;\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "Following", "canonicalReference": "iceshrimp-sdk!entities.Following:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "Following", "canonicalReference": "iceshrimp-sdk!entities.Following:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "FollowingFolloweePopulated", "canonicalReference": "iceshrimp-sdk!entities.FollowingFolloweePopulated:type" }, { "kind": "Content", "text": "[];\n };\n \"users/gallery/posts\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"users/get-frequently-replied-users\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"users/groups/create\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"users/groups/delete\": {\n req: {\n groupId: " }, { "kind": "Reference", "text": "UserGroup", "canonicalReference": "iceshrimp-sdk!entities.UserGroup:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"users/groups/invitations/accept\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"users/groups/invitations/reject\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"users/groups/invite\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"users/groups/joined\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"users/groups/owned\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"users/groups/pull\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"users/groups/show\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"users/groups/transfer\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"users/groups/update\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"users/lists/create\": {\n req: {\n name: string;\n };\n res: " }, { "kind": "Reference", "text": "UserList", "canonicalReference": "iceshrimp-sdk!entities.UserList:type" }, { "kind": "Content", "text": ";\n };\n \"users/lists/delete\": {\n req: {\n listId: " }, { "kind": "Reference", "text": "UserList", "canonicalReference": "iceshrimp-sdk!entities.UserList:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"users/lists/list\": {\n req: " }, { "kind": "Reference", "text": "NoParams", "canonicalReference": "iceshrimp-sdk!~NoParams:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "UserList", "canonicalReference": "iceshrimp-sdk!entities.UserList:type" }, { "kind": "Content", "text": "[];\n };\n \"users/lists/pull\": {\n req: {\n listId: " }, { "kind": "Reference", "text": "UserList", "canonicalReference": "iceshrimp-sdk!entities.UserList:type" }, { "kind": "Content", "text": "[\"id\"];\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"users/lists/push\": {\n req: {\n listId: " }, { "kind": "Reference", "text": "UserList", "canonicalReference": "iceshrimp-sdk!entities.UserList:type" }, { "kind": "Content", "text": "[\"id\"];\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: null;\n };\n \"users/lists/show\": {\n req: {\n listId: " }, { "kind": "Reference", "text": "UserList", "canonicalReference": "iceshrimp-sdk!entities.UserList:type" }, { "kind": "Content", "text": "[\"id\"];\n };\n res: " }, { "kind": "Reference", "text": "UserList", "canonicalReference": "iceshrimp-sdk!entities.UserList:type" }, { "kind": "Content", "text": ";\n };\n \"users/lists/update\": {\n req: {\n listId: " }, { "kind": "Reference", "text": "UserList", "canonicalReference": "iceshrimp-sdk!entities.UserList:type" }, { "kind": "Content", "text": "[\"id\"];\n name: string;\n };\n res: " }, { "kind": "Reference", "text": "UserList", "canonicalReference": "iceshrimp-sdk!entities.UserList:type" }, { "kind": "Content", "text": ";\n };\n \"users/notes\": {\n req: {\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n limit?: number;\n sinceId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n untilId?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n sinceDate?: number;\n untilDate?: number;\n };\n res: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[];\n };\n \"users/pages\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"users/recommendation\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"users/relation\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"users/report-abuse\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"users/search-by-username-and-host\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"users/search\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n \"users/show\": {\n req: " }, { "kind": "Reference", "text": "ShowUserReq", "canonicalReference": "iceshrimp-sdk!~ShowUserReq:type" }, { "kind": "Content", "text": " | {\n userIds: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"][];\n };\n res: {\n $switch: {\n $cases: [[{\n userIds: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"][];\n }, " }, { "kind": "Reference", "text": "UserDetailed", "canonicalReference": "iceshrimp-sdk!entities.UserDetailed:type" }, { "kind": "Content", "text": "[]]];\n $default: " }, { "kind": "Reference", "text": "UserDetailed", "canonicalReference": "iceshrimp-sdk!entities.UserDetailed:type" }, { "kind": "Content", "text": ";\n };\n };\n };\n \"users/stats\": {\n req: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n res: " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO:type" }, { "kind": "Content", "text": ";\n };\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/api.types.ts", "releaseTag": "Public", "name": "Endpoints", "typeTokenRange": { "startIndex": 1, "endIndex": 1140 } }, { "kind": "Namespace", "canonicalReference": "iceshrimp-sdk!entities:namespace", "docComment": "", "excerptTokens": [], "fileUrlPath": "src/index.ts", "releaseTag": "None", "name": "entities", "preserveMemberOrder": false, "members": [ { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.Announcement:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type Announcement = " }, { "kind": "Content", "text": "{\n id: " }, { "kind": "Reference", "text": "ID", "canonicalReference": "iceshrimp-sdk!entities.ID:type" }, { "kind": "Content", "text": ";\n createdAt: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": ";\n updatedAt: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": " | null;\n text: string;\n title: string;\n imageUrl: string | null;\n isRead?: boolean;\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "Announcement", "typeTokenRange": { "startIndex": 1, "endIndex": 8 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.Antenna:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type Antenna = " }, { "kind": "Content", "text": "{\n id: " }, { "kind": "Reference", "text": "ID", "canonicalReference": "iceshrimp-sdk!entities.ID:type" }, { "kind": "Content", "text": ";\n createdAt: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": ";\n name: string;\n keywords: string[][];\n excludeKeywords: string[][];\n src: \"home\" | \"all\" | \"users\" | \"list\" | \"group\" | \"instances\";\n userListId: " }, { "kind": "Reference", "text": "ID", "canonicalReference": "iceshrimp-sdk!entities.ID:type" }, { "kind": "Content", "text": " | null;\n userGroupId: " }, { "kind": "Reference", "text": "ID", "canonicalReference": "iceshrimp-sdk!entities.ID:type" }, { "kind": "Content", "text": " | null;\n users: string[];\n instances: string[];\n caseSensitive: boolean;\n notify: boolean;\n withReplies: boolean;\n withFile: boolean;\n hasUnreadNote: boolean;\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "Antenna", "typeTokenRange": { "startIndex": 1, "endIndex": 10 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.App:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type App = " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO_2:type" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "App", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.AuthSession:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type AuthSession = " }, { "kind": "Content", "text": "{\n id: " }, { "kind": "Reference", "text": "ID", "canonicalReference": "iceshrimp-sdk!entities.ID:type" }, { "kind": "Content", "text": ";\n app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "iceshrimp-sdk!entities.App:type" }, { "kind": "Content", "text": ";\n token: string;\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "AuthSession", "typeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.Blocking:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type Blocking = " }, { "kind": "Content", "text": "{\n id: " }, { "kind": "Reference", "text": "ID", "canonicalReference": "iceshrimp-sdk!entities.ID:type" }, { "kind": "Content", "text": ";\n createdAt: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": ";\n blockeeId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n blockee: " }, { "kind": "Reference", "text": "UserDetailed", "canonicalReference": "iceshrimp-sdk!entities.UserDetailed:type" }, { "kind": "Content", "text": ";\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "Blocking", "typeTokenRange": { "startIndex": 1, "endIndex": 10 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.Channel:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type Channel = " }, { "kind": "Content", "text": "{\n id: " }, { "kind": "Reference", "text": "ID", "canonicalReference": "iceshrimp-sdk!entities.ID:type" }, { "kind": "Content", "text": ";\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "Channel", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.Clip:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type Clip = " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO_2:type" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "Clip", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.CustomEmoji:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type CustomEmoji = " }, { "kind": "Content", "text": "{\n id: string;\n name: string;\n url: string;\n category: string;\n aliases: string[];\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "CustomEmoji", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.DateString:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type DateString = " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "DateString", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.DetailedInstanceMetadata:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type DetailedInstanceMetadata = " }, { "kind": "Reference", "text": "LiteInstanceMetadata", "canonicalReference": "iceshrimp-sdk!entities.LiteInstanceMetadata:type" }, { "kind": "Content", "text": " & {\n features: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": ";\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "DetailedInstanceMetadata", "typeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type DriveFile = " }, { "kind": "Content", "text": "{\n id: " }, { "kind": "Reference", "text": "ID", "canonicalReference": "iceshrimp-sdk!entities.ID:type" }, { "kind": "Content", "text": ";\n createdAt: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": ";\n isSensitive: boolean;\n name: string;\n thumbnailUrl: string;\n url: string;\n type: string;\n size: number;\n md5: string;\n blurhash: string;\n comment: string | null;\n properties: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": ";\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "DriveFile", "typeTokenRange": { "startIndex": 1, "endIndex": 8 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.DriveFolder:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type DriveFolder = " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO_2:type" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "DriveFolder", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.Following:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type Following = " }, { "kind": "Content", "text": "{\n id: " }, { "kind": "Reference", "text": "ID", "canonicalReference": "iceshrimp-sdk!entities.ID:type" }, { "kind": "Content", "text": ";\n createdAt: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": ";\n followerId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n followeeId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "Following", "typeTokenRange": { "startIndex": 1, "endIndex": 10 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.FollowingFolloweePopulated:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type FollowingFolloweePopulated = " }, { "kind": "Reference", "text": "Following", "canonicalReference": "iceshrimp-sdk!entities.Following:type" }, { "kind": "Content", "text": " & {\n followee: " }, { "kind": "Reference", "text": "UserDetailed", "canonicalReference": "iceshrimp-sdk!entities.UserDetailed:type" }, { "kind": "Content", "text": ";\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "FollowingFolloweePopulated", "typeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.FollowingFollowerPopulated:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type FollowingFollowerPopulated = " }, { "kind": "Reference", "text": "Following", "canonicalReference": "iceshrimp-sdk!entities.Following:type" }, { "kind": "Content", "text": " & {\n follower: " }, { "kind": "Reference", "text": "UserDetailed", "canonicalReference": "iceshrimp-sdk!entities.UserDetailed:type" }, { "kind": "Content", "text": ";\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "FollowingFollowerPopulated", "typeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.FollowRequest:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type FollowRequest = " }, { "kind": "Content", "text": "{\n id: " }, { "kind": "Reference", "text": "ID", "canonicalReference": "iceshrimp-sdk!entities.ID:type" }, { "kind": "Content", "text": ";\n follower: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": ";\n followee: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": ";\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "FollowRequest", "typeTokenRange": { "startIndex": 1, "endIndex": 8 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.GalleryPost:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type GalleryPost = " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO_2:type" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "GalleryPost", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.ID:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type ID = " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "ID", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.Instance:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type Instance = " }, { "kind": "Content", "text": "{\n id: " }, { "kind": "Reference", "text": "ID", "canonicalReference": "iceshrimp-sdk!entities.ID:type" }, { "kind": "Content", "text": ";\n caughtAt: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": ";\n host: string;\n usersCount: number;\n notesCount: number;\n followingCount: number;\n followersCount: number;\n driveUsage: number;\n driveFiles: number;\n latestRequestSentAt: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": " | null;\n latestStatus: number | null;\n latestRequestReceivedAt: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": " | null;\n lastCommunicatedAt: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": ";\n isNotResponding: boolean;\n isSuspended: boolean;\n softwareName: string | null;\n softwareVersion: string | null;\n openRegistrations: boolean | null;\n name: string | null;\n description: string | null;\n maintainerName: string | null;\n maintainerEmail: string | null;\n iconUrl: string | null;\n faviconUrl: string | null;\n themeColor: string | null;\n infoUpdatedAt: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": " | null;\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "Instance", "typeTokenRange": { "startIndex": 1, "endIndex": 14 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.InstanceMetadata:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type InstanceMetadata = " }, { "kind": "Reference", "text": "LiteInstanceMetadata", "canonicalReference": "iceshrimp-sdk!entities.LiteInstanceMetadata:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "DetailedInstanceMetadata", "canonicalReference": "iceshrimp-sdk!entities.DetailedInstanceMetadata:type" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "InstanceMetadata", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.LiteInstanceMetadata:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type LiteInstanceMetadata = " }, { "kind": "Content", "text": "{\n maintainerName: string | null;\n maintainerEmail: string | null;\n version: string;\n name: string | null;\n uri: string;\n description: string | null;\n tosUrl: string | null;\n disableRegistration: boolean;\n disableLocalTimeline: boolean;\n disableRecommendedTimeline: boolean;\n disableGlobalTimeline: boolean;\n driveCapacityPerLocalUserMb: number;\n driveCapacityPerRemoteUserMb: number;\n enableHcaptcha: boolean;\n hcaptchaSiteKey: string | null;\n enableRecaptcha: boolean;\n recaptchaSiteKey: string | null;\n swPublickey: string | null;\n maxNoteTextLength: number;\n enableEmail: boolean;\n enableGithubIntegration: boolean;\n enableDiscordIntegration: boolean;\n searchEngine: string;\n emojis: " }, { "kind": "Reference", "text": "CustomEmoji", "canonicalReference": "iceshrimp-sdk!entities.CustomEmoji:type" }, { "kind": "Content", "text": "[];\n images: {\n error: string;\n notFound: string;\n info: string;\n };\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "LiteInstanceMetadata", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.MeDetailed:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type MeDetailed = " }, { "kind": "Reference", "text": "UserDetailed", "canonicalReference": "iceshrimp-sdk!entities.UserDetailed:type" }, { "kind": "Content", "text": " & {\n avatarId: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": "[\"id\"];\n bannerId: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": "[\"id\"];\n autoAcceptFollowed: boolean;\n alwaysMarkNsfw: boolean;\n carefulBot: boolean;\n emailNotificationTypes: string[];\n hasPendingReceivedFollowRequest: boolean;\n hasUnreadAnnouncement: boolean;\n hasUnreadAntenna: boolean;\n hasUnreadChannel: boolean;\n hasUnreadMentions: boolean;\n hasUnreadMessagingMessage: boolean;\n hasUnreadNotification: boolean;\n hasUnreadSpecifiedNotes: boolean;\n hideOnlineStatus: boolean;\n injectFeaturedNote: boolean;\n integrations: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": ";\n isDeleted: boolean;\n isExplorable: boolean;\n mutedWords: string[][];\n mutingNotificationTypes: string[];\n noCrawle: boolean;\n preventAiLearning: boolean;\n receiveAnnouncementEmail: boolean;\n usePasswordLessLogin: boolean;\n [other: string]: any;\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "MeDetailed", "typeTokenRange": { "startIndex": 1, "endIndex": 9 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.MessagingMessage:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type MessagingMessage = " }, { "kind": "Content", "text": "{\n id: " }, { "kind": "Reference", "text": "ID", "canonicalReference": "iceshrimp-sdk!entities.ID:type" }, { "kind": "Content", "text": ";\n createdAt: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": ";\n file: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": " | null;\n fileId: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": "[\"id\"] | null;\n isRead: boolean;\n reads: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"][];\n text: string | null;\n user: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": ";\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n recipient?: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": " | null;\n recipientId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"] | null;\n group?: " }, { "kind": "Reference", "text": "UserGroup", "canonicalReference": "iceshrimp-sdk!entities.UserGroup:type" }, { "kind": "Content", "text": " | null;\n groupId: " }, { "kind": "Reference", "text": "UserGroup", "canonicalReference": "iceshrimp-sdk!entities.UserGroup:type" }, { "kind": "Content", "text": "[\"id\"] | null;\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "MessagingMessage", "typeTokenRange": { "startIndex": 1, "endIndex": 24 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.Note:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type Note = " }, { "kind": "Content", "text": "{\n id: " }, { "kind": "Reference", "text": "ID", "canonicalReference": "iceshrimp-sdk!entities.ID:type" }, { "kind": "Content", "text": ";\n createdAt: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": ";\n text: string | null;\n cw: string | null;\n user: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": ";\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n reply?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": ";\n replyId: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n renote?: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": ";\n renoteId: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n files: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": "[];\n fileIds: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": "[\"id\"][];\n visibility: \"public\" | \"home\" | \"followers\" | \"specified\";\n visibleUserIds?: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"][];\n localOnly?: boolean;\n channel?: " }, { "kind": "Reference", "text": "Channel", "canonicalReference": "iceshrimp-sdk!entities.Channel:type" }, { "kind": "Content", "text": "[\"id\"];\n myReaction?: string;\n isRenoted?: boolean;\n reactions: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": ";\n renoteCount: number;\n repliesCount: number;\n poll?: {\n expiresAt: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": " | null;\n multiple: boolean;\n choices: {\n isVoted: boolean;\n text: string;\n votes: number;\n }[];\n };\n emojis: {\n name: string;\n url: string;\n }[];\n uri?: string;\n url?: string;\n updatedAt?: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": ";\n isHidden?: boolean;\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "Note", "typeTokenRange": { "startIndex": 1, "endIndex": 32 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.NoteFavorite:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type NoteFavorite = " }, { "kind": "Content", "text": "{\n id: " }, { "kind": "Reference", "text": "ID", "canonicalReference": "iceshrimp-sdk!entities.ID:type" }, { "kind": "Content", "text": ";\n createdAt: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": ";\n noteId: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[\"id\"];\n note: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": ";\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "NoteFavorite", "typeTokenRange": { "startIndex": 1, "endIndex": 10 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.NoteReaction:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type NoteReaction = " }, { "kind": "Content", "text": "{\n id: " }, { "kind": "Reference", "text": "ID", "canonicalReference": "iceshrimp-sdk!entities.ID:type" }, { "kind": "Content", "text": ";\n createdAt: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": ";\n user: " }, { "kind": "Reference", "text": "UserLite", "canonicalReference": "iceshrimp-sdk!entities.UserLite:type" }, { "kind": "Content", "text": ";\n type: string;\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "NoteReaction", "typeTokenRange": { "startIndex": 1, "endIndex": 8 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.Notification:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type Notification = " }, { "kind": "Content", "text": "{\n id: " }, { "kind": "Reference", "text": "ID", "canonicalReference": "iceshrimp-sdk!entities.ID:type" }, { "kind": "Content", "text": ";\n createdAt: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": ";\n isRead: boolean;\n} & ({\n type: \"reaction\";\n reaction: string;\n user: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": ";\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n note: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": ";\n} | {\n type: \"reply\";\n user: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": ";\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n note: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": ";\n} | {\n type: \"renote\";\n user: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": ";\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n note: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": ";\n} | {\n type: \"quote\";\n user: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": ";\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n note: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": ";\n} | {\n type: \"mention\";\n user: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": ";\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n note: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": ";\n} | {\n type: \"pollVote\";\n user: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": ";\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n note: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": ";\n} | {\n type: \"follow\";\n user: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": ";\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n} | {\n type: \"followRequestAccepted\";\n user: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": ";\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n} | {\n type: \"receiveFollowRequest\";\n user: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": ";\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n} | {\n type: \"groupInvited\";\n invitation: " }, { "kind": "Reference", "text": "UserGroup", "canonicalReference": "iceshrimp-sdk!entities.UserGroup:type" }, { "kind": "Content", "text": ";\n user: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": ";\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n} | {\n type: \"app\";\n header?: string | null;\n body: string;\n icon?: string | null;\n})" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "Notification", "typeTokenRange": { "startIndex": 1, "endIndex": 60 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.OriginType:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type OriginType = " }, { "kind": "Content", "text": "\"combined\" | \"local\" | \"remote\"" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "OriginType", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.Page:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type Page = " }, { "kind": "Content", "text": "{\n id: " }, { "kind": "Reference", "text": "ID", "canonicalReference": "iceshrimp-sdk!entities.ID:type" }, { "kind": "Content", "text": ";\n createdAt: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": ";\n updatedAt: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": ";\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n user: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": ";\n content: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "[];\n variables: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "[];\n title: string;\n name: string;\n summary: string | null;\n hideTitleWhenPinned: boolean;\n alignCenter: boolean;\n font: string;\n script: string;\n eyeCatchingImageId: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": "[\"id\"] | null;\n eyeCatchingImage: " }, { "kind": "Reference", "text": "DriveFile", "canonicalReference": "iceshrimp-sdk!entities.DriveFile:type" }, { "kind": "Content", "text": " | null;\n attachedFiles: any;\n likedCount: number;\n isLiked?: boolean;\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "Page", "typeTokenRange": { "startIndex": 1, "endIndex": 20 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.PageEvent:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type PageEvent = " }, { "kind": "Content", "text": "{\n pageId: " }, { "kind": "Reference", "text": "Page", "canonicalReference": "iceshrimp-sdk!entities.Page:type" }, { "kind": "Content", "text": "[\"id\"];\n event: string;\n var: any;\n userId: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"];\n user: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": ";\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "PageEvent", "typeTokenRange": { "startIndex": 1, "endIndex": 8 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.ServerInfo:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type ServerInfo = " }, { "kind": "Content", "text": "{\n machine: string;\n cpu: {\n model: string;\n cores: number;\n };\n mem: {\n total: number;\n };\n fs: {\n total: number;\n used: number;\n };\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "ServerInfo", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.Signin:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type Signin = " }, { "kind": "Content", "text": "{\n id: " }, { "kind": "Reference", "text": "ID", "canonicalReference": "iceshrimp-sdk!entities.ID:type" }, { "kind": "Content", "text": ";\n createdAt: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": ";\n ip: string;\n headers: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": ";\n success: boolean;\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "Signin", "typeTokenRange": { "startIndex": 1, "endIndex": 8 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.Stats:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type Stats = " }, { "kind": "Content", "text": "{\n notesCount: number;\n originalNotesCount: number;\n usersCount: number;\n originalUsersCount: number;\n instances: number;\n driveUsageLocal: number;\n driveUsageRemote: number;\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "Stats", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.User:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type User = " }, { "kind": "Reference", "text": "UserLite", "canonicalReference": "iceshrimp-sdk!entities.UserLite:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "UserDetailed", "canonicalReference": "iceshrimp-sdk!entities.UserDetailed:type" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "User", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.UserDetailed:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type UserDetailed = " }, { "kind": "Reference", "text": "UserLite", "canonicalReference": "iceshrimp-sdk!entities.UserLite:type" }, { "kind": "Content", "text": " & {\n bannerBlurhash: string | null;\n bannerColor: string | null;\n bannerUrl: string | null;\n birthday: string | null;\n createdAt: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": ";\n description: string | null;\n ffVisibility: \"public\" | \"followers\" | \"private\";\n fields: {\n name: string;\n value: string;\n verified?: boolean;\n }[];\n followersCount: number;\n followingCount: number;\n hasPendingFollowRequestFromYou: boolean;\n hasPendingFollowRequestToYou: boolean;\n isAdmin: boolean;\n isBlocked: boolean;\n isBlocking: boolean;\n isBot: boolean;\n isCat: boolean;\n isFollowed: boolean;\n isFollowing: boolean;\n isLocked: boolean;\n isModerator: boolean;\n isMuted: boolean;\n isRenoteMuted: boolean;\n isSilenced: boolean;\n isSuspended: boolean;\n lang: string | null;\n lastFetchedAt?: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": ";\n location: string | null;\n notesCount: number;\n pinnedNoteIds: " }, { "kind": "Reference", "text": "ID", "canonicalReference": "iceshrimp-sdk!entities.ID:type" }, { "kind": "Content", "text": "[];\n pinnedNotes: " }, { "kind": "Reference", "text": "Note", "canonicalReference": "iceshrimp-sdk!entities.Note:type" }, { "kind": "Content", "text": "[];\n pinnedPage: " }, { "kind": "Reference", "text": "Page", "canonicalReference": "iceshrimp-sdk!entities.Page:type" }, { "kind": "Content", "text": " | null;\n pinnedPageId: string | null;\n publicReactions: boolean;\n securityKeys: boolean;\n twoFactorEnabled: boolean;\n updatedAt: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": " | null;\n uri: string | null;\n url: string | null;\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "UserDetailed", "typeTokenRange": { "startIndex": 1, "endIndex": 15 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.UserGroup:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type UserGroup = " }, { "kind": "Reference", "text": "TODO", "canonicalReference": "iceshrimp-sdk!~TODO_2:type" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "UserGroup", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.UserList:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type UserList = " }, { "kind": "Content", "text": "{\n id: " }, { "kind": "Reference", "text": "ID", "canonicalReference": "iceshrimp-sdk!entities.ID:type" }, { "kind": "Content", "text": ";\n createdAt: " }, { "kind": "Reference", "text": "DateString", "canonicalReference": "iceshrimp-sdk!entities.DateString:type" }, { "kind": "Content", "text": ";\n name: string;\n userIds: " }, { "kind": "Reference", "text": "User", "canonicalReference": "iceshrimp-sdk!entities.User:type" }, { "kind": "Content", "text": "[\"id\"][];\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "UserList", "typeTokenRange": { "startIndex": 1, "endIndex": 8 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.UserLite:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type UserLite = " }, { "kind": "Content", "text": "{\n id: " }, { "kind": "Reference", "text": "ID", "canonicalReference": "iceshrimp-sdk!entities.ID:type" }, { "kind": "Content", "text": ";\n username: string;\n host: string | null;\n name: string;\n onlineStatus: \"online\" | \"active\" | \"offline\" | \"unknown\";\n avatarUrl: string;\n avatarBlurhash: string;\n alsoKnownAs: string[];\n movedToUri: any;\n emojis: {\n name: string;\n url: string;\n }[];\n instance?: {\n name: " }, { "kind": "Reference", "text": "Instance", "canonicalReference": "iceshrimp-sdk!entities.Instance:type" }, { "kind": "Content", "text": "[\"name\"];\n softwareName: " }, { "kind": "Reference", "text": "Instance", "canonicalReference": "iceshrimp-sdk!entities.Instance:type" }, { "kind": "Content", "text": "[\"softwareName\"];\n softwareVersion: " }, { "kind": "Reference", "text": "Instance", "canonicalReference": "iceshrimp-sdk!entities.Instance:type" }, { "kind": "Content", "text": "[\"softwareVersion\"];\n iconUrl: " }, { "kind": "Reference", "text": "Instance", "canonicalReference": "iceshrimp-sdk!entities.Instance:type" }, { "kind": "Content", "text": "[\"iconUrl\"];\n faviconUrl: " }, { "kind": "Reference", "text": "Instance", "canonicalReference": "iceshrimp-sdk!entities.Instance:type" }, { "kind": "Content", "text": "[\"faviconUrl\"];\n themeColor: " }, { "kind": "Reference", "text": "Instance", "canonicalReference": "iceshrimp-sdk!entities.Instance:type" }, { "kind": "Content", "text": "[\"themeColor\"];\n };\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "UserLite", "typeTokenRange": { "startIndex": 1, "endIndex": 16 } }, { "kind": "TypeAlias", "canonicalReference": "iceshrimp-sdk!entities.UserSorting:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type UserSorting = " }, { "kind": "Content", "text": "\"+follower\" | \"-follower\" | \"+createdAt\" | \"-createdAt\" | \"+updatedAt\" | \"-updatedAt\"" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities.ts", "releaseTag": "Public", "name": "UserSorting", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } } ] }, { "kind": "Variable", "canonicalReference": "iceshrimp-sdk!ffVisibility:var", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "ffVisibility: " }, { "kind": "Content", "text": "readonly [\"public\", \"followers\", \"private\"]" } ], "fileUrlPath": "src/index.ts", "isReadonly": true, "releaseTag": "Public", "name": "ffVisibility", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Variable", "canonicalReference": "iceshrimp-sdk!noteVisibilities:var", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "noteVisibilities: " }, { "kind": "Content", "text": "readonly [\"public\", \"home\", \"followers\", \"specified\"]" } ], "fileUrlPath": "src/index.ts", "isReadonly": true, "releaseTag": "Public", "name": "noteVisibilities", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Variable", "canonicalReference": "iceshrimp-sdk!notificationTypes:var", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "notificationTypes: " }, { "kind": "Content", "text": "readonly [\"follow\", \"mention\", \"reply\", \"renote\", \"quote\", \"reaction\", \"pollVote\", \"pollEnded\", \"receiveFollowRequest\", \"followRequestAccepted\", \"groupInvited\", \"app\"]" } ], "fileUrlPath": "src/index.ts", "isReadonly": true, "releaseTag": "Public", "name": "notificationTypes", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Variable", "canonicalReference": "iceshrimp-sdk!permissions:var", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "permissions: " }, { "kind": "Content", "text": "string[]" } ], "fileUrlPath": "src/index.ts", "isReadonly": true, "releaseTag": "Public", "name": "permissions", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Class", "canonicalReference": "iceshrimp-sdk!Stream:class", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export default class Stream extends " }, { "kind": "Reference", "text": "EventEmitter", "canonicalReference": "eventemitter3!EventEmitter.EventEmitter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "StreamEvents", "canonicalReference": "iceshrimp-sdk!~StreamEvents:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/streaming.ts", "releaseTag": "Public", "isAbstract": false, "name": "Stream", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "iceshrimp-sdk!Stream:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `Stream` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(origin: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", user: " }, { "kind": "Content", "text": "{\n token: string;\n } | null" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Content", "text": "{\n WebSocket?: any;\n }" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "origin", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ] }, { "kind": "Method", "canonicalReference": "iceshrimp-sdk!Stream#close:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "close(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "close" }, { "kind": "Method", "canonicalReference": "iceshrimp-sdk!Stream#disconnectToChannel:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "disconnectToChannel(connection: " }, { "kind": "Reference", "text": "NonSharedConnection", "canonicalReference": "iceshrimp-sdk!~NonSharedConnection:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "connection", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "disconnectToChannel" }, { "kind": "Method", "canonicalReference": "iceshrimp-sdk!Stream#removeSharedConnection:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeSharedConnection(connection: " }, { "kind": "Reference", "text": "SharedConnection", "canonicalReference": "iceshrimp-sdk!~SharedConnection:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "connection", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeSharedConnection" }, { "kind": "Method", "canonicalReference": "iceshrimp-sdk!Stream#removeSharedConnectionPool:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeSharedConnectionPool(pool: " }, { "kind": "Reference", "text": "Pool", "canonicalReference": "iceshrimp-sdk!~Pool:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "pool", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeSharedConnectionPool" }, { "kind": "Method", "canonicalReference": "iceshrimp-sdk!Stream#send:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "send(typeOrPayload: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ", payload?: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "typeOrPayload", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "payload", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "send" }, { "kind": "Property", "canonicalReference": "iceshrimp-sdk!Stream#state:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "state: " }, { "kind": "Content", "text": "\"initializing\" | \"reconnecting\" | \"connected\"" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "state", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "iceshrimp-sdk!Stream#useChannel:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "useChannel(channel: " }, { "kind": "Content", "text": "C" }, { "kind": "Content", "text": ", params?: " }, { "kind": "Reference", "text": "Channels", "canonicalReference": "iceshrimp-sdk!Channels:type" }, { "kind": "Content", "text": "[C][\"params\"]" }, { "kind": "Content", "text": ", name?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Connection", "canonicalReference": "iceshrimp-sdk!ChannelConnection:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Channels", "canonicalReference": "iceshrimp-sdk!Channels:type" }, { "kind": "Content", "text": "[C]>" }, { "kind": "Content", "text": ";" } ], "typeParameters": [ { "typeParameterName": "C", "constraintTokenRange": { "startIndex": 1, "endIndex": 3 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 15 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": false }, { "parameterName": "params", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 8 }, "isOptional": true }, { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "useChannel" } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 5 }, "implementsTokenRanges": [] } ] } ] }