Interface Endpoints

Hierarchy

  • Endpoints

Properties

admin/abuse-user-reports: {
    req: {
        forwarded: boolean;
        limit: number;
        reporterOrigin: "conbined" | "local" | "remote";
        state: null | string;
        targetUserOrigin: "conbined" | "local" | "remote";
    };
    res: {
        assigneeId: string;
        comment: string;
        createdAt: string;
        id: string;
        reporter: IUserLite;
        reporterId: string;
        resolved: boolean;
        targetUser: IUserLite;
        targetUserId: string;
    }[];
}

Type declaration

  • req: {
        forwarded: boolean;
        limit: number;
        reporterOrigin: "conbined" | "local" | "remote";
        state: null | string;
        targetUserOrigin: "conbined" | "local" | "remote";
    }
    • forwarded: boolean
    • limit: number
    • reporterOrigin: "conbined" | "local" | "remote"
    • state: null | string
    • targetUserOrigin: "conbined" | "local" | "remote"
  • res: {
        assigneeId: string;
        comment: string;
        createdAt: string;
        id: string;
        reporter: IUserLite;
        reporterId: string;
        resolved: boolean;
        targetUser: IUserLite;
        targetUserId: string;
    }[]
following/create: {
    req: {
        userId: string;
    };
    res: IUserLite;
}

Type declaration

  • req: {
        userId: string;
    }
    • userId: string
  • res: IUserLite
i: {
    req: NoParams;
    res: IUserDetailed;
}

Type declaration

notes/create: {
    req: {
        cw: null | string;
        localOnly: boolean;
        poll: null | {
            choices: string[];
            expiredAfter: null | number;
            expiresAt: null | number;
            multiple: boolean;
        };
        reactionAcceptance: null | "likeOnly" | "nonSensitiveOnly" | "likeOnlyForRemote" | "nonSensitiveOnlyForRemote";
        renoteId: null | string;
        replyId: null | string;
        text: null | string;
        visibility: NoteVisibility;
        visibleUserIds: string[];
    };
    res: {
        createdNote: INote;
    };
}

Type declaration

  • req: {
        cw: null | string;
        localOnly: boolean;
        poll: null | {
            choices: string[];
            expiredAfter: null | number;
            expiresAt: null | number;
            multiple: boolean;
        };
        reactionAcceptance: null | "likeOnly" | "nonSensitiveOnly" | "likeOnlyForRemote" | "nonSensitiveOnlyForRemote";
        renoteId: null | string;
        replyId: null | string;
        text: null | string;
        visibility: NoteVisibility;
        visibleUserIds: string[];
    }
    • cw: null | string
    • localOnly: boolean
    • poll: null | {
          choices: string[];
          expiredAfter: null | number;
          expiresAt: null | number;
          multiple: boolean;
      }
    • reactionAcceptance: null | "likeOnly" | "nonSensitiveOnly" | "likeOnlyForRemote" | "nonSensitiveOnlyForRemote"
    • renoteId: null | string
    • replyId: null | string
    • text: null | string
    • visibility: NoteVisibility
    • visibleUserIds: string[]
  • res: {
        createdNote: INote;
    }
notes/reactions: {
    req: {
        limit: null | number;
        noteId: string;
        offset: number;
        sinceId: null | string;
        type: null | string;
        untilId: null | string;
    };
    res: {
        createdAt: string;
        id: string;
        reaction: string;
        user: IUserLite;
    }[];
}

Type declaration

  • req: {
        limit: null | number;
        noteId: string;
        offset: number;
        sinceId: null | string;
        type: null | string;
        untilId: null | string;
    }
    • limit: null | number
    • noteId: string
    • offset: number
    • sinceId: null | string
    • type: null | string
    • untilId: null | string
  • res: {
        createdAt: string;
        id: string;
        reaction: string;
        user: IUserLite;
    }[]
notes/reactions/create: {
    req: {
        noteId: string;
        reaction: string;
    };
    res: void;
}

Type declaration

  • req: {
        noteId: string;
        reaction: string;
    }
    • noteId: string
    • reaction: string
  • res: void
notes/reactions/delete: {
    req: {
        noteId: string;
        reaction: string;
    };
    res: void;
}

Type declaration

  • req: {
        noteId: string;
        reaction: string;
    }
    • noteId: string
    • reaction: string
  • res: void
users/notes: {
    req: {
        excludeNsfw: boolean;
        fileType?: string[];
        includeMyRenotes: boolean;
        includeReplies: boolean;
        limit: number;
        sinceDate: number;
        sinceId: null | string;
        untilDate: number;
        untilId: null | string;
        userId: string;
        withFiles: boolean;
    };
    res: INote[];
}

Type declaration

  • req: {
        excludeNsfw: boolean;
        fileType?: string[];
        includeMyRenotes: boolean;
        includeReplies: boolean;
        limit: number;
        sinceDate: number;
        sinceId: null | string;
        untilDate: number;
        untilId: null | string;
        userId: string;
        withFiles: boolean;
    }
    • excludeNsfw: boolean
    • Optional fileType?: string[]
    • includeMyRenotes: boolean
    • includeReplies: boolean
    • limit: number
    • sinceDate: number
    • sinceId: null | string
    • untilDate: number
    • untilId: null | string
    • userId: string
    • withFiles: boolean
  • res: INote[]
users/show: {
    req: {
        host: null | string;
        userId: null | string;
        userIds?: string[];
        username: null | string;
    };
    res: IUserDetailed;
}

Type declaration

  • req: {
        host: null | string;
        userId: null | string;
        userIds?: string[];
        username: null | string;
    }
    • host: null | string
    • userId: null | string
    • Optional userIds?: string[]
    • username: null | string
  • res: IUserDetailed

Generated using TypeDoc