artalk
    Preparing search index...

    Interface Api

    interface Api {
        auth: {
            applyDataMerge: (
                data: HandlerRequestAuthDataMergeApply,
                params?: RequestParams,
            ) => Promise<
                HttpResponse<
                    HandlerResponseAuthDataMergeApply,
                    HandlerMap & { msg?: string },
                >,
            >;
            checkDataMerge: (
                params?: RequestParams,
            ) => Promise<
                HttpResponse<
                    HandlerResponseAuthDataMergeCheck,
                    HandlerMap & { msg?: string },
                >,
            >;
            loginByEmail: (
                data: HandlerRequestAuthEmailLogin,
                params?: RequestParams,
            ) => Promise<
                HttpResponse<HandlerResponseUserLogin, HandlerMap & { msg?: string }>,
            >;
            registerByEmail: (
                data: HandlerRequestAuthEmailRegister,
                params?: RequestParams,
            ) => Promise<
                HttpResponse<HandlerResponseUserLogin, HandlerMap & { msg?: string }>,
            >;
            sendVerifyEmail: (
                data: HandlerRequestAuthEmailSend,
                params?: RequestParams,
            ) => Promise<
                HttpResponse<
                    HandlerMap & { msg?: string },
                    HandlerMap & { msg?: string },
                >,
            >;
        };
        baseUrl: string;
        cache: {
            flushCache: (
                params?: RequestParams,
            ) => Promise<
                HttpResponse<
                    HandlerMap & { msg?: string },
                    HandlerMap & { msg?: string },
                >,
            >;
            warmUpCache: (
                params?: RequestParams,
            ) => Promise<
                HttpResponse<
                    HandlerMap & { msg?: string },
                    HandlerMap & { msg?: string },
                >,
            >;
        };
        captcha: {
            getCaptcha: (
                params?: RequestParams,
            ) => Promise<
                HttpResponse<HandlerResponseCaptchaGet, HandlerMap & { msg?: string }>,
            >;
            getCaptchaStatus: (
                params?: RequestParams,
            ) => Promise<HttpResponse<HandlerResponseCaptchaStatus, any>>;
            verifyCaptcha: (
                data: HandlerParamsCaptchaVerify,
                params?: RequestParams,
            ) => Promise<HttpResponse<HandlerMap, HandlerMap & { img_data?: string }>>;
        };
        comments: {
            createComment: (
                comment: HandlerParamsCommentCreate,
                params?: RequestParams,
            ) => Promise<
                HttpResponse<
                    HandlerResponseCommentCreate,
                    HandlerMap & { msg?: string },
                >,
            >;
            deleteComment: (
                id: number,
                params?: RequestParams,
            ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>;
            getComment: (
                id: number,
                params?: RequestParams,
            ) => Promise<
                HttpResponse<HandlerResponseCommentGet, HandlerMap & { msg?: string }>,
            >;
            getComments: (
                query: {
                    email?: string;
                    flat_mode?: boolean;
                    limit?: number;
                    name?: string;
                    offset?: number;
                    page_key: string;
                    scope?: "page" | "user" | "site";
                    search?: string;
                    site_name?: string;
                    sort_by?: "date_asc" | "date_desc" | "vote";
                    type?: "all" | "pending" | "mentions" | "mine";
                    view_only_admin?: boolean;
                },
                params?: RequestParams,
            ) => Promise<
                HttpResponse<
                    HandlerResponseCommentList,
                    HandlerMap & { msg?: string },
                >,
            >;
            updateComment: (
                id: number,
                comment: HandlerParamsCommentUpdate,
                params?: RequestParams,
            ) => Promise<
                HttpResponse<
                    HandlerResponseCommentUpdate,
                    HandlerMap & { msg?: string },
                >,
            >;
        };
        conf: {
            conf: (
                params?: RequestParams,
            ) => Promise<HttpResponse<CommonConfData, any>>;
            getDomain: (
                query?: { url?: string },
                params?: RequestParams,
            ) => Promise<HttpResponse<HandlerResponseConfDomain, any>>;
            getSocialLoginProviders: (
                params?: RequestParams,
            ) => Promise<
                HttpResponse<
                    HandlerResponseConfAuthProviders,
                    HandlerMap & { msg?: string },
                >,
            >;
        };
        notifies: {
            getNotifies: (
                query: { email: string; name: string },
                params?: RequestParams,
            ) => Promise<
                HttpResponse<HandlerResponseNotifyList, HandlerMap & { msg?: string }>,
            >;
            markAllNotifyRead: (
                options: HandlerParamsNotifyReadAll,
                params?: RequestParams,
            ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>;
            markNotifyRead: (
                commentId: number,
                notifyKey: string,
                params?: RequestParams,
            ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>;
        };
        pages: {
            deletePage: (
                id: number,
                params?: RequestParams,
            ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>;
            fetchAllPages: (
                options: HandlerParamsPageFetchAll,
                params?: RequestParams,
            ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>;
            fetchPage: (
                id: number,
                params?: RequestParams,
            ) => Promise<
                HttpResponse<HandlerResponsePageFetch, HandlerMap & { msg?: string }>,
            >;
            getPageFetchStatus: (
                params?: RequestParams,
            ) => Promise<HttpResponse<HandlerResponsePageFetchStatus, any>>;
            getPages: (
                query?: {
                    limit?: number;
                    offset?: number;
                    search?: string;
                    site_name?: string;
                },
                params?: RequestParams,
            ) => Promise<
                HttpResponse<HandlerResponsePageList, HandlerMap & { msg?: string }>,
            >;
            logPv: (
                page: HandlerParamsPagePV,
                params?: RequestParams,
            ) => Promise<HttpResponse<HandlerResponsePagePV, any>>;
            updatePage: (
                id: number,
                page: HandlerParamsPageUpdate,
                params?: RequestParams,
            ) => Promise<
                HttpResponse<HandlerResponsePageUpdate, HandlerMap & { msg?: string }>,
            >;
        };
        sendEmail: {
            sendEmail: (
                email: HandlerParamsEmailSend,
                params?: RequestParams,
            ) => Promise<
                HttpResponse<HandlerMap, HandlerMap | HandlerMap & { msg?: string }>,
            >;
        };
        settings: {
            applySettings: (
                settings: HandlerParamsSettingApply,
                params?: RequestParams,
            ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>;
            getSettings: (
                params?: RequestParams,
            ) => Promise<
                HttpResponse<HandlerResponseSettingGet, HandlerMap & { msg?: string }>,
            >;
            getSettingsTemplate: (
                locale: string,
                params?: RequestParams,
            ) => Promise<HttpResponse<HandlerResponseSettingTemplate, any>>;
        };
        sites: {
            createSite: (
                site: HandlerParamsSiteCreate,
                params?: RequestParams,
            ) => Promise<
                HttpResponse<HandlerResponseSiteCreate, HandlerMap & { msg?: string }>,
            >;
            deleteSite: (
                id: number,
                params?: RequestParams,
            ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>;
            getSites: (
                params?: RequestParams,
            ) => Promise<HttpResponse<HandlerResponseSiteList, any>>;
            updateSite: (
                id: number,
                site: HandlerParamsSiteUpdate,
                params?: RequestParams,
            ) => Promise<HttpResponse<HandlerResponseSiteUpdate, any>>;
        };
        sso: {
            authSsoExchange: (
                body: HandlerParamsAuthSSOExchange,
                params?: RequestParams,
            ) => Promise<
                HttpResponse<HandlerResponseUserLogin, HandlerMap & { msg?: string }>,
            >;
        };
        stats: {
            getStats: (
                type:
                    | "page_comment"
                    | "page_pv"
                    | "latest_comments"
                    | "latest_pages"
                    | "pv_most_pages"
                    | "comment_most_pages"
                    | "site_pv"
                    | "site_comment"
                    | "rand_comments"
                    | "rand_pages",
                query?: { limit?: number; page_keys?: string; site_name?: string },
                params?: RequestParams,
            ) => Promise<
                HttpResponse<CommonJSONResult, HandlerMap & { msg?: string }>,
            >;
        };
        transfer: {
            exportArtrans: (
                params?: RequestParams,
            ) => Promise<
                HttpResponse<
                    HandlerResponseTransferExport,
                    HandlerMap & { msg?: string },
                >,
            >;
            importArtrans: (
                data: HandlerParamsTransferImport,
                params?: RequestParams,
            ) => Promise<HttpResponse<string, any>>;
            uploadArtrans: (
                data: { file: File },
                params?: RequestParams,
            ) => Promise<
                HttpResponse<
                    HandlerResponseTransferUpload & { filename?: string },
                    HandlerMap & { msg?: string },
                >,
            >;
        };
        upload: {
            upload: (
                data: { file: File },
                params?: RequestParams,
            ) => Promise<
                HttpResponse<HandlerResponseUpload, HandlerMap & { msg?: string }>,
            >;
        };
        user: {
            getUser: (
                query?: { email?: string; name?: string },
                params?: RequestParams,
            ) => Promise<
                HttpResponse<HandlerResponseUserInfo, HandlerMap & { msg?: string }>,
            >;
            getUserStatus: (
                query?: { email?: string; name?: string },
                params?: RequestParams,
            ) => Promise<HttpResponse<HandlerResponseUserStatus, any>>;
            login: (
                user: HandlerParamsUserLogin,
                params?: RequestParams,
            ) => Promise<
                HttpResponse<
                    HandlerResponseUserLogin,
                    | HandlerMap & { data?: { need_name_select?: (...)[] }; msg?: string }
                    | HandlerMap & { msg?: string },
                >,
            >;
            updateProfile: (
                data: HandlerRequestUserInfoUpdate,
                params?: RequestParams,
            ) => Promise<
                HttpResponse<
                    HandlerResponseUserInfoUpdate,
                    HandlerMap & { msg?: string },
                >,
            >;
        };
        users: {
            createUser: (
                user: HandlerParamsUserCreate,
                params?: RequestParams,
            ) => Promise<
                HttpResponse<HandlerResponseUserCreate, HandlerMap & { msg?: string }>,
            >;
            deleteUser: (
                id: number,
                params?: RequestParams,
            ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>;
            getUsers: (
                type?: "all" | "admin" | "in_conf",
                query?: { limit?: number; offset?: number; search?: string },
                params?: RequestParams,
            ) => Promise<
                HttpResponse<
                    HandlerResponseAdminUserList,
                    HandlerMap & { msg?: string },
                >,
            >;
            updateUser: (
                id: number,
                user: HandlerParamsUserUpdate,
                params?: RequestParams,
            ) => Promise<
                HttpResponse<HandlerResponseUserUpdate, HandlerMap & { msg?: string }>,
            >;
        };
        version: {
            getVersion: (
                params?: RequestParams,
            ) => Promise<HttpResponse<CommonApiVersionData, any>>;
        };
        votes: {
            createVote: (
                targetName: "page" | "comment",
                targetId: number,
                choice: "up" | "down",
                vote: HandlerParamsVoteCreate,
                params?: RequestParams,
            ) => Promise<
                HttpResponse<HandlerResponseVote, HandlerMap & { msg?: string }>,
            >;
            getVote: (
                targetName: "page" | "comment",
                targetId: number,
                params?: RequestParams,
            ) => Promise<
                HttpResponse<HandlerResponseVote, HandlerMap & { msg?: string }>,
            >;
            syncVotes: (
                params?: RequestParams,
            ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>;
        };
        abortRequest(cancelToken: CancelToken): void;
        addArrayQueryParam(query: QueryParamsType, key: string): any;
        addQueryParam(query: QueryParamsType, key: string): string;
        addQueryParams(rawQuery?: QueryParamsType): string;
        createAbortSignal(cancelToken: CancelToken): AbortSignal | undefined;
        encodeQueryParam(key: string, value: any): string;
        getUserFields(): { email: string; name: string } | undefined;
        mergeRequestParams(
            params1: RequestParams,
            params2?: RequestParams,
        ): RequestParams;
        request<T = any, E = any>(
            __namedParameters: FullRequestParams,
        ): Promise<HttpResponse<T, E>>;
        setSecurityData(data: void | null): void;
        toQueryString(rawQuery?: QueryParamsType): string;
    }

    Hierarchy

    • Api<void>
      • Api
    Index
    auth baseUrl cache captcha comments conf notifies pages sendEmail settings sites sso stats transfer upload user users version votes
    abortRequest addArrayQueryParam addQueryParam addQueryParams createAbortSignal encodeQueryParam getUserFields mergeRequestParams request setSecurityData toQueryString
    auth: {
        applyDataMerge: (
            data: HandlerRequestAuthDataMergeApply,
            params?: RequestParams,
        ) => Promise<
            HttpResponse<
                HandlerResponseAuthDataMergeApply,
                HandlerMap & { msg?: string },
            >,
        >;
        checkDataMerge: (
            params?: RequestParams,
        ) => Promise<
            HttpResponse<
                HandlerResponseAuthDataMergeCheck,
                HandlerMap & { msg?: string },
            >,
        >;
        loginByEmail: (
            data: HandlerRequestAuthEmailLogin,
            params?: RequestParams,
        ) => Promise<
            HttpResponse<HandlerResponseUserLogin, HandlerMap & { msg?: string }>,
        >;
        registerByEmail: (
            data: HandlerRequestAuthEmailRegister,
            params?: RequestParams,
        ) => Promise<
            HttpResponse<HandlerResponseUserLogin, HandlerMap & { msg?: string }>,
        >;
        sendVerifyEmail: (
            data: HandlerRequestAuthEmailSend,
            params?: RequestParams,
        ) => Promise<
            HttpResponse<
                HandlerMap & { msg?: string },
                HandlerMap & { msg?: string },
            >,
        >;
    } = ...

    Type Declaration

    • applyDataMerge: (
          data: HandlerRequestAuthDataMergeApply,
          params?: RequestParams,
      ) => Promise<
          HttpResponse<
              HandlerResponseAuthDataMergeApply,
              HandlerMap & { msg?: string },
          >,
      >

      This function is to solve the problem of multiple users with the same email address, should be called after user login and then check, and perform data merge.

      Auth

      ApplyDataMerge

      POST:/auth/merge

      200 HandlerResponseAuthDataMergeApply OK

      400 `(HandlerMap & { msg?: string,

      })Bad Request @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    • checkDataMerge: (
          params?: RequestParams,
      ) => Promise<
          HttpResponse<
              HandlerResponseAuthDataMergeCheck,
              HandlerMap & { msg?: string },
          >,
      >

      Get all users with same email, if there are more than one user with same email, need merge

      Auth

      CheckDataMerge

      GET:/auth/merge

      200 HandlerResponseAuthDataMergeCheck OK

      400 `(HandlerMap & { msg?: string,

      })Bad Request @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    • loginByEmail: (
          data: HandlerRequestAuthEmailLogin,
          params?: RequestParams,
      ) => Promise<
          HttpResponse<HandlerResponseUserLogin, HandlerMap & { msg?: string }>,
      >

      Login by email with verify code (Need send email verify code first) or password

      Auth

      LoginByEmail

      POST:/auth/email/login

      200 HandlerResponseUserLogin OK

      400 `(HandlerMap & { msg?: string,

      })Bad Request @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    • registerByEmail: (
          data: HandlerRequestAuthEmailRegister,
          params?: RequestParams,
      ) => Promise<
          HttpResponse<HandlerResponseUserLogin, HandlerMap & { msg?: string }>,
      >

      Register by email and verify code (if user exists, will update user, like forget or change password. Need send email verify code first)

      Auth

      RegisterByEmail

      POST:/auth/email/register

      200 HandlerResponseUserLogin OK

      400 `(HandlerMap & { msg?: string,

      })Bad Request @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    • sendVerifyEmail: (
          data: HandlerRequestAuthEmailSend,
          params?: RequestParams,
      ) => Promise<
          HttpResponse<
              HandlerMap & { msg?: string },
              HandlerMap & { msg?: string },
          >,
      >

      Send email including verify code to user

      Auth

      SendVerifyEmail

      POST:/auth/email/send

      200 `(HandlerMap & { msg?: string,

      })OK @response400 (HandlerMap & { msg?: string,

      })Bad Request @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    baseUrl: string = '/api/v2'
    cache: {
        flushCache: (
            params?: RequestParams,
        ) => Promise<
            HttpResponse<
                HandlerMap & { msg?: string },
                HandlerMap & { msg?: string },
            >,
        >;
        warmUpCache: (
            params?: RequestParams,
        ) => Promise<
            HttpResponse<
                HandlerMap & { msg?: string },
                HandlerMap & { msg?: string },
            >,
        >;
    } = ...

    Type Declaration

    • flushCache: (
          params?: RequestParams,
      ) => Promise<
          HttpResponse<
              HandlerMap & { msg?: string },
              HandlerMap & { msg?: string },
          >,
      >

      Flush all cache on the server

      Cache

      FlushCache

      POST:/cache/flush

      200 `(HandlerMap & { msg?: string,

      })OK @response400 (HandlerMap & { msg?: string,

      })Bad Request @response403 (HandlerMap & { msg?: string,

      })` Forbidden

    • warmUpCache: (
          params?: RequestParams,
      ) => Promise<
          HttpResponse<
              HandlerMap & { msg?: string },
              HandlerMap & { msg?: string },
          >,
      >

      Cache warming helps you to pre-load the cache to improve the performance of the first request

      Cache

      WarmUpCache

      POST:/cache/warm_up

      200 `(HandlerMap & { msg?: string,

      })OK @response400 (HandlerMap & { msg?: string,

      })Bad Request @response403 (HandlerMap & { msg?: string,

      })` Forbidden

    captcha: {
        getCaptcha: (
            params?: RequestParams,
        ) => Promise<
            HttpResponse<HandlerResponseCaptchaGet, HandlerMap & { msg?: string }>,
        >;
        getCaptchaStatus: (
            params?: RequestParams,
        ) => Promise<HttpResponse<HandlerResponseCaptchaStatus, any>>;
        verifyCaptcha: (
            data: HandlerParamsCaptchaVerify,
            params?: RequestParams,
        ) => Promise<HttpResponse<HandlerMap, HandlerMap & { img_data?: string }>>;
    } = ...

    Type Declaration

    • getCaptcha: (
          params?: RequestParams,
      ) => Promise<
          HttpResponse<HandlerResponseCaptchaGet, HandlerMap & { msg?: string }>,
      >

      Get a base64 encoded captcha image or a HTML page to verify for user

      Captcha

      GetCaptcha

      GET:/captcha

      200 HandlerResponseCaptchaGet OK

      500 `(HandlerMap & { msg?: string,

      })` Internal Server Error

    • getCaptchaStatus: (
          params?: RequestParams,
      ) => Promise<HttpResponse<HandlerResponseCaptchaStatus, any>>

      Get the status of the user's captcha verification

      Captcha

      GetCaptchaStatus

      GET:/captcha/status

      200 HandlerResponseCaptchaStatus OK

    • verifyCaptcha: (
          data: HandlerParamsCaptchaVerify,
          params?: RequestParams,
      ) => Promise<HttpResponse<HandlerMap, HandlerMap & { img_data?: string }>>

      Verify user enters correct captcha code

      Captcha

      VerifyCaptcha

      POST:/captcha/verify

      200 HandlerMap OK

      403 `(HandlerMap & { img_data?: string,

      })` Forbidden

    comments: {
        createComment: (
            comment: HandlerParamsCommentCreate,
            params?: RequestParams,
        ) => Promise<
            HttpResponse<
                HandlerResponseCommentCreate,
                HandlerMap & { msg?: string },
            >,
        >;
        deleteComment: (
            id: number,
            params?: RequestParams,
        ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>;
        getComment: (
            id: number,
            params?: RequestParams,
        ) => Promise<
            HttpResponse<HandlerResponseCommentGet, HandlerMap & { msg?: string }>,
        >;
        getComments: (
            query: {
                email?: string;
                flat_mode?: boolean;
                limit?: number;
                name?: string;
                offset?: number;
                page_key: string;
                scope?: "page" | "user" | "site";
                search?: string;
                site_name?: string;
                sort_by?: "date_asc" | "date_desc" | "vote";
                type?: "all" | "pending" | "mentions" | "mine";
                view_only_admin?: boolean;
            },
            params?: RequestParams,
        ) => Promise<
            HttpResponse<HandlerResponseCommentList, HandlerMap & { msg?: string }>,
        >;
        updateComment: (
            id: number,
            comment: HandlerParamsCommentUpdate,
            params?: RequestParams,
        ) => Promise<
            HttpResponse<
                HandlerResponseCommentUpdate,
                HandlerMap & { msg?: string },
            >,
        >;
    } = ...

    Type Declaration

    • createComment: (
          comment: HandlerParamsCommentCreate,
          params?: RequestParams,
      ) => Promise<
          HttpResponse<
              HandlerResponseCommentCreate,
              HandlerMap & { msg?: string },
          >,
      >

      Create a new comment

      Comment

      CreateComment

      POST:/comments

      200 HandlerResponseCommentCreate OK

      400 `(HandlerMap & { msg?: string,

      })Bad Request @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    • deleteComment: (
          id: number,
          params?: RequestParams,
      ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>

      Delete a specific comment

      Comment

      DeleteComment

      DELETE:/comments/{id}

      200 HandlerMap OK

      403 `(HandlerMap & { msg?: string,

      })Forbidden @response404 (HandlerMap & { msg?: string,

      })Not Found @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    • getComment: (
          id: number,
          params?: RequestParams,
      ) => Promise<
          HttpResponse<HandlerResponseCommentGet, HandlerMap & { msg?: string }>,
      >

      Get the detail of a comment by comment id

      Comment

      GetComment

      GET:/comments/{id}

      200 HandlerResponseCommentGet OK

      404 `(HandlerMap & { msg?: string,

      })Not Found @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    • getComments: (
          query: {
              email?: string;
              flat_mode?: boolean;
              limit?: number;
              name?: string;
              offset?: number;
              page_key: string;
              scope?: "page" | "user" | "site";
              search?: string;
              site_name?: string;
              sort_by?: "date_asc" | "date_desc" | "vote";
              type?: "all" | "pending" | "mentions" | "mine";
              view_only_admin?: boolean;
          },
          params?: RequestParams,
      ) => Promise<
          HttpResponse<HandlerResponseCommentList, HandlerMap & { msg?: string }>,
      >

      Get a list of comments by some conditions

      Comment

      GetComments

      GET:/comments

      200 HandlerResponseCommentList OK

      500 `(HandlerMap & { msg?: string,

      })` Internal Server Error

    • updateComment: (
          id: number,
          comment: HandlerParamsCommentUpdate,
          params?: RequestParams,
      ) => Promise<
          HttpResponse<
              HandlerResponseCommentUpdate,
              HandlerMap & { msg?: string },
          >,
      >

      Update a specific comment

      Comment

      UpdateComment

      PUT:/comments/{id}

      200 HandlerResponseCommentUpdate OK

      400 `(HandlerMap & { msg?: string,

      })Bad Request @response403 (HandlerMap & { msg?: string,

      })Forbidden @response404 (HandlerMap & { msg?: string,

      })Not Found @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    conf: {
        conf: (
            params?: RequestParams,
        ) => Promise<HttpResponse<CommonConfData, any>>;
        getDomain: (
            query?: { url?: string },
            params?: RequestParams,
        ) => Promise<HttpResponse<HandlerResponseConfDomain, any>>;
        getSocialLoginProviders: (
            params?: RequestParams,
        ) => Promise<
            HttpResponse<
                HandlerResponseConfAuthProviders,
                HandlerMap & { msg?: string },
            >,
        >;
    } = ...

    Type Declaration

    • conf: (params?: RequestParams) => Promise<HttpResponse<CommonConfData, any>>

      Get System Configs for UI

      System

      Conf

      GET:/conf

      200 CommonConfData OK

    • getDomain: (
          query?: { url?: string },
          params?: RequestParams,
      ) => Promise<HttpResponse<HandlerResponseConfDomain, any>>

      Get Domain Info

      System

      GetDomain

      GET:/conf/domain

      200 HandlerResponseConfDomain OK

    • getSocialLoginProviders: (
          params?: RequestParams,
      ) => Promise<
          HttpResponse<
              HandlerResponseConfAuthProviders,
              HandlerMap & { msg?: string },
          >,
      >

      Get social login providers

      System

      GetSocialLoginProviders

      GET:/conf/auth/providers

      200 HandlerResponseConfAuthProviders OK

      404 `(HandlerMap & { msg?: string,

      })` Not Found

    notifies: {
        getNotifies: (
            query: { email: string; name: string },
            params?: RequestParams,
        ) => Promise<
            HttpResponse<HandlerResponseNotifyList, HandlerMap & { msg?: string }>,
        >;
        markAllNotifyRead: (
            options: HandlerParamsNotifyReadAll,
            params?: RequestParams,
        ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>;
        markNotifyRead: (
            commentId: number,
            notifyKey: string,
            params?: RequestParams,
        ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>;
    } = ...

    Type Declaration

    • getNotifies: (
          query: { email: string; name: string },
          params?: RequestParams,
      ) => Promise<
          HttpResponse<HandlerResponseNotifyList, HandlerMap & { msg?: string }>,
      >

      Get a list of notifies for user

      Notify

      GetNotifies

      GET:/notifies

      200 HandlerResponseNotifyList OK

      400 `(HandlerMap & { msg?: string,

      })Bad Request @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    • markAllNotifyRead: (
          options: HandlerParamsNotifyReadAll,
          params?: RequestParams,
      ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>

      Mark all notifies as read for user

      Notify

      MarkAllNotifyRead

      POST:/notifies/read

      200 HandlerMap OK

      400 `(HandlerMap & { msg?: string,

      })Bad Request @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    • markNotifyRead: (
          commentId: number,
          notifyKey: string,
          params?: RequestParams,
      ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>

      Mark specific notification as read for user

      Notify

      MarkNotifyRead

      POST:/notifies/{comment_id}/{notify_key}

      200 HandlerMap OK

      400 `(HandlerMap & { msg?: string,

      })Bad Request @response404 (HandlerMap & { msg?: string,

      })Not Found @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    pages: {
        deletePage: (
            id: number,
            params?: RequestParams,
        ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>;
        fetchAllPages: (
            options: HandlerParamsPageFetchAll,
            params?: RequestParams,
        ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>;
        fetchPage: (
            id: number,
            params?: RequestParams,
        ) => Promise<
            HttpResponse<HandlerResponsePageFetch, HandlerMap & { msg?: string }>,
        >;
        getPageFetchStatus: (
            params?: RequestParams,
        ) => Promise<HttpResponse<HandlerResponsePageFetchStatus, any>>;
        getPages: (
            query?: {
                limit?: number;
                offset?: number;
                search?: string;
                site_name?: string;
            },
            params?: RequestParams,
        ) => Promise<
            HttpResponse<HandlerResponsePageList, HandlerMap & { msg?: string }>,
        >;
        logPv: (
            page: HandlerParamsPagePV,
            params?: RequestParams,
        ) => Promise<HttpResponse<HandlerResponsePagePV, any>>;
        updatePage: (
            id: number,
            page: HandlerParamsPageUpdate,
            params?: RequestParams,
        ) => Promise<
            HttpResponse<HandlerResponsePageUpdate, HandlerMap & { msg?: string }>,
        >;
    } = ...

    Type Declaration

    • deletePage: (
          id: number,
          params?: RequestParams,
      ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>

      Delete a specific page

      Page

      DeletePage

      DELETE:/pages/{id}

      200 HandlerMap OK

      403 `(HandlerMap & { msg?: string,

      })Forbidden @response404 (HandlerMap & { msg?: string,

      })Not Found @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    • fetchAllPages: (
          options: HandlerParamsPageFetchAll,
          params?: RequestParams,
      ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>

      Fetch the data of all pages

      Page

      FetchAllPages

      POST:/pages/fetch

      200 HandlerMap OK

      400 `(HandlerMap & { msg?: string,

      })Bad Request @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    • fetchPage: (
          id: number,
          params?: RequestParams,
      ) => Promise<
          HttpResponse<HandlerResponsePageFetch, HandlerMap & { msg?: string }>,
      >

      Fetch the data of a specific page

      Page

      FetchPage

      POST:/pages/{id}/fetch

      200 HandlerResponsePageFetch OK

      404 `(HandlerMap & { msg?: string,

      })Not Found @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    • getPageFetchStatus: (
          params?: RequestParams,
      ) => Promise<HttpResponse<HandlerResponsePageFetchStatus, any>>

      Get the status of the task of fetching all pages

      Page

      GetPageFetchStatus

      GET:/pages/fetch/status

      200 HandlerResponsePageFetchStatus OK

    • getPages: (
          query?: {
              limit?: number;
              offset?: number;
              search?: string;
              site_name?: string;
          },
          params?: RequestParams,
      ) => Promise<
          HttpResponse<HandlerResponsePageList, HandlerMap & { msg?: string }>,
      >

      Get a list of pages by some conditions

      Page

      GetPages

      GET:/pages

      200 HandlerResponsePageList OK

      403 `(HandlerMap & { msg?: string,

      })` Forbidden

    • logPv: (
          page: HandlerParamsPagePV,
          params?: RequestParams,
      ) => Promise<HttpResponse<HandlerResponsePagePV, any>>

      Increase and get the number of page views

      Page

      LogPv

      POST:/pages/pv

      200 HandlerResponsePagePV OK

    • updatePage: (
          id: number,
          page: HandlerParamsPageUpdate,
          params?: RequestParams,
      ) => Promise<
          HttpResponse<HandlerResponsePageUpdate, HandlerMap & { msg?: string }>,
      >

      Update a specific page

      Page

      UpdatePage

      PUT:/pages/{id}

      200 HandlerResponsePageUpdate OK

      400 `(HandlerMap & { msg?: string,

      })Bad Request @response403 (HandlerMap & { msg?: string,

      })Forbidden @response404 (HandlerMap & { msg?: string,

      })Not Found @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    sendEmail: {
        sendEmail: (
            email: HandlerParamsEmailSend,
            params?: RequestParams,
        ) => Promise<
            HttpResponse<HandlerMap, HandlerMap | HandlerMap & { msg?: string }>,
        >;
    } = ...

    Type Declaration

    • sendEmail: (
          email: HandlerParamsEmailSend,
          params?: RequestParams,
      ) => Promise<
          HttpResponse<HandlerMap, HandlerMap | HandlerMap & { msg?: string }>,
      >

      Send an email to test the email sender

      System

      SendEmail

      POST:/send_email

      200 HandlerMap OK

      403 `(HandlerMap & { msg?: string,

      })Forbidden @response500 HandlerMap` Internal Server Error

    settings: {
        applySettings: (
            settings: HandlerParamsSettingApply,
            params?: RequestParams,
        ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>;
        getSettings: (
            params?: RequestParams,
        ) => Promise<
            HttpResponse<HandlerResponseSettingGet, HandlerMap & { msg?: string }>,
        >;
        getSettingsTemplate: (
            locale: string,
            params?: RequestParams,
        ) => Promise<HttpResponse<HandlerResponseSettingTemplate, any>>;
    } = ...

    Type Declaration

    • applySettings: (
          settings: HandlerParamsSettingApply,
          params?: RequestParams,
      ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>

      Apply settings and restart the server

      System

      ApplySettings

      PUT:/settings

      200 HandlerMap OK

      403 `(HandlerMap & { msg?: string,

      })Forbidden @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    • getSettings: (
          params?: RequestParams,
      ) => Promise<
          HttpResponse<HandlerResponseSettingGet, HandlerMap & { msg?: string }>,
      >

      Get settings from app config file

      System

      GetSettings

      GET:/settings

      200 HandlerResponseSettingGet OK

      403 `(HandlerMap & { msg?: string,

      })Forbidden @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    • getSettingsTemplate: (
          locale: string,
          params?: RequestParams,
      ) => Promise<HttpResponse<HandlerResponseSettingTemplate, any>>

      Get config templates in different languages for rendering the settings page in the frontend

      System

      GetSettingsTemplate

      GET:/settings/template/{locale}

      200 HandlerResponseSettingTemplate OK

    sites: {
        createSite: (
            site: HandlerParamsSiteCreate,
            params?: RequestParams,
        ) => Promise<
            HttpResponse<HandlerResponseSiteCreate, HandlerMap & { msg?: string }>,
        >;
        deleteSite: (
            id: number,
            params?: RequestParams,
        ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>;
        getSites: (
            params?: RequestParams,
        ) => Promise<HttpResponse<HandlerResponseSiteList, any>>;
        updateSite: (
            id: number,
            site: HandlerParamsSiteUpdate,
            params?: RequestParams,
        ) => Promise<HttpResponse<HandlerResponseSiteUpdate, any>>;
    } = ...

    Type Declaration

    • createSite: (
          site: HandlerParamsSiteCreate,
          params?: RequestParams,
      ) => Promise<
          HttpResponse<HandlerResponseSiteCreate, HandlerMap & { msg?: string }>,
      >

      Create a new site

      Site

      CreateSite

      POST:/sites

      200 HandlerResponseSiteCreate OK

      400 `(HandlerMap & { msg?: string,

      })Bad Request @response403 (HandlerMap & { msg?: string,

      })Forbidden @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    • deleteSite: (
          id: number,
          params?: RequestParams,
      ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>

      Delete a specific site

      Site

      DeleteSite

      DELETE:/sites/{id}

      200 HandlerMap OK

      403 `(HandlerMap & { msg?: string,

      })Forbidden @response404 (HandlerMap & { msg?: string,

      })Not Found @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    • getSites: (params?: RequestParams) => Promise<HttpResponse<HandlerResponseSiteList, any>>

      Get a list of sites by some conditions

      Site

      GetSites

      GET:/sites

      200 HandlerResponseSiteList OK

    • updateSite: (
          id: number,
          site: HandlerParamsSiteUpdate,
          params?: RequestParams,
      ) => Promise<HttpResponse<HandlerResponseSiteUpdate, any>>

      Update a specific site

      Site

      UpdateSite

      PUT:/sites/{id}

      200 HandlerResponseSiteUpdate OK

    sso: {
        authSsoExchange: (
            body: HandlerParamsAuthSSOExchange,
            params?: RequestParams,
        ) => Promise<
            HttpResponse<HandlerResponseUserLogin, HandlerMap & { msg?: string }>,
        >;
    } = ...

    Type Declaration

    • authSsoExchange: (
          body: HandlerParamsAuthSSOExchange,
          params?: RequestParams,
      ) => Promise<
          HttpResponse<HandlerResponseUserLogin, HandlerMap & { msg?: string }>,
      >

      Validates a third-party OIDC access token by calling the issuer's /userinfo endpoint, requires a verified email claim, then mints an Artalk session JWT. Use when the surrounding application already runs OIDC and you want Artalk comments to inherit that session without showing Artalk's own login UI.

      Auth

      AuthSsoExchange

      POST:/sso/exchange

      200 HandlerResponseUserLogin OK

      400 `(HandlerMap & { msg?: string,

      })Bad Request @response401 (HandlerMap & { msg?: string,

      })Unauthorized @response404 (HandlerMap & { msg?: string,

      })Not Found @response500 (HandlerMap & { msg?: string,

      })Internal Server Error @response502 (HandlerMap & { msg?: string,

      })Bad Gateway @response503 (HandlerMap & { msg?: string,

      })` Service Unavailable

    stats: {
        getStats: (
            type:
                | "page_comment"
                | "page_pv"
                | "latest_comments"
                | "latest_pages"
                | "pv_most_pages"
                | "comment_most_pages"
                | "site_pv"
                | "site_comment"
                | "rand_comments"
                | "rand_pages",
            query?: { limit?: number; page_keys?: string; site_name?: string },
            params?: RequestParams,
        ) => Promise<HttpResponse<CommonJSONResult, HandlerMap & { msg?: string }>>;
    } = ...

    Type Declaration

    • getStats: (
          type:
              | "page_comment"
              | "page_pv"
              | "latest_comments"
              | "latest_pages"
              | "pv_most_pages"
              | "comment_most_pages"
              | "site_pv"
              | "site_comment"
              | "rand_comments"
              | "rand_pages",
          query?: { limit?: number; page_keys?: string; site_name?: string },
          params?: RequestParams,
      ) => Promise<HttpResponse<CommonJSONResult, HandlerMap & { msg?: string }>>

      Get the statistics of various data analysis

      Statistic

      GetStats

      GET:/stats/{type}

      200 CommonJSONResult OK

      400 `(HandlerMap & { msg?: string,

      })Bad Request @response403 (HandlerMap & { msg?: string,

      })Forbidden @response404 (HandlerMap & { msg?: string,

      })Not Found @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    transfer: {
        exportArtrans: (
            params?: RequestParams,
        ) => Promise<
            HttpResponse<
                HandlerResponseTransferExport,
                HandlerMap & { msg?: string },
            >,
        >;
        importArtrans: (
            data: HandlerParamsTransferImport,
            params?: RequestParams,
        ) => Promise<HttpResponse<string, any>>;
        uploadArtrans: (
            data: { file: File },
            params?: RequestParams,
        ) => Promise<
            HttpResponse<
                HandlerResponseTransferUpload & { filename?: string },
                HandlerMap & { msg?: string },
            >,
        >;
    } = ...

    Type Declaration

    • exportArtrans: (
          params?: RequestParams,
      ) => Promise<
          HttpResponse<
              HandlerResponseTransferExport,
              HandlerMap & { msg?: string },
          >,
      >

      Export data from Artalk

      Transfer

      ExportArtrans

      GET:/transfer/export

      200 HandlerResponseTransferExport OK

      500 `(HandlerMap & { msg?: string,

      })` Internal Server Error

    • importArtrans: (
          data: HandlerParamsTransferImport,
          params?: RequestParams,
      ) => Promise<HttpResponse<string, any>>

      Import data to Artalk

      Transfer

      ImportArtrans

      POST:/transfer/import

      200 string OK

    • uploadArtrans: (
          data: { file: File },
          params?: RequestParams,
      ) => Promise<
          HttpResponse<
              HandlerResponseTransferUpload & { filename?: string },
              HandlerMap & { msg?: string },
          >,
      >

      Upload a file to prepare to import

      Transfer

      UploadArtrans

      POST:/transfer/upload

      200 `(HandlerResponseTransferUpload & { filename?: string,

      })OK @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    upload: {
        upload: (
            data: { file: File },
            params?: RequestParams,
        ) => Promise<
            HttpResponse<HandlerResponseUpload, HandlerMap & { msg?: string }>,
        >;
    } = ...

    Type Declaration

    • upload: (
          data: { file: File },
          params?: RequestParams,
      ) => Promise<
          HttpResponse<HandlerResponseUpload, HandlerMap & { msg?: string }>,
      >

      Upload file from this endpoint

      Upload

      Upload

      POST:/upload

      200 HandlerResponseUpload OK

      400 `(HandlerMap & { msg?: string,

      })Bad Request @response403 (HandlerMap & { msg?: string,

      })Forbidden @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    user: {
        getUser: (
            query?: { email?: string; name?: string },
            params?: RequestParams,
        ) => Promise<
            HttpResponse<HandlerResponseUserInfo, HandlerMap & { msg?: string }>,
        >;
        getUserStatus: (
            query?: { email?: string; name?: string },
            params?: RequestParams,
        ) => Promise<HttpResponse<HandlerResponseUserStatus, any>>;
        login: (
            user: HandlerParamsUserLogin,
            params?: RequestParams,
        ) => Promise<
            HttpResponse<
                HandlerResponseUserLogin,
                | HandlerMap & { data?: { need_name_select?: (...)[] }; msg?: string }
                | HandlerMap & { msg?: string },
            >,
        >;
        updateProfile: (
            data: HandlerRequestUserInfoUpdate,
            params?: RequestParams,
        ) => Promise<
            HttpResponse<
                HandlerResponseUserInfoUpdate,
                HandlerMap & { msg?: string },
            >,
        >;
    } = ...

    Type Declaration

    • getUser: (
          query?: { email?: string; name?: string },
          params?: RequestParams,
      ) => Promise<
          HttpResponse<HandlerResponseUserInfo, HandlerMap & { msg?: string }>,
      >

      Get user info to prepare for login or check current user status

      Auth

      GetUser

      GET:/user

      200 HandlerResponseUserInfo OK

      400 `(HandlerMap & { msg?: string,

      })` Bad Request

    • getUserStatus: (
          query?: { email?: string; name?: string },
          params?: RequestParams,
      ) => Promise<HttpResponse<HandlerResponseUserStatus, any>>

      Get user login status by header Authorization

      Auth

      GetUserStatus

      GET:/user/status

      200 HandlerResponseUserStatus OK

    • login: (
          user: HandlerParamsUserLogin,
          params?: RequestParams,
      ) => Promise<
          HttpResponse<
              HandlerResponseUserLogin,
              | HandlerMap & { data?: { need_name_select?: (...)[] }; msg?: string }
              | HandlerMap & { msg?: string },
          >,
      >

      Login user by name or email

      Auth

      Login

      POST:/user/access_token

      200 HandlerResponseUserLogin OK

      400 `(HandlerMap & { data?: { need_name_select?: (string)[],

      }, msg?: string,

      })Multiple users with the same email address are matched @response401 (HandlerMap & { msg?: string,

      })Unauthorized @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    • updateProfile: (
          data: HandlerRequestUserInfoUpdate,
          params?: RequestParams,
      ) => Promise<
          HttpResponse<
              HandlerResponseUserInfoUpdate,
              HandlerMap & { msg?: string },
          >,
      >

      Update user profile when user is logged in

      Auth

      UpdateProfile

      POST:/user

      200 HandlerResponseUserInfoUpdate OK

      400 `(HandlerMap & { msg?: string,

      })Bad Request @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    users: {
        createUser: (
            user: HandlerParamsUserCreate,
            params?: RequestParams,
        ) => Promise<
            HttpResponse<HandlerResponseUserCreate, HandlerMap & { msg?: string }>,
        >;
        deleteUser: (
            id: number,
            params?: RequestParams,
        ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>;
        getUsers: (
            type?: "all" | "admin" | "in_conf",
            query?: { limit?: number; offset?: number; search?: string },
            params?: RequestParams,
        ) => Promise<
            HttpResponse<
                HandlerResponseAdminUserList,
                HandlerMap & { msg?: string },
            >,
        >;
        updateUser: (
            id: number,
            user: HandlerParamsUserUpdate,
            params?: RequestParams,
        ) => Promise<
            HttpResponse<HandlerResponseUserUpdate, HandlerMap & { msg?: string }>,
        >;
    } = ...

    Type Declaration

    • createUser: (
          user: HandlerParamsUserCreate,
          params?: RequestParams,
      ) => Promise<
          HttpResponse<HandlerResponseUserCreate, HandlerMap & { msg?: string }>,
      >

      Create a new user

      User

      CreateUser

      POST:/users

      200 HandlerResponseUserCreate OK

      400 `(HandlerMap & { msg?: string,

      })Bad Request @response403 (HandlerMap & { msg?: string,

      })Forbidden @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    • deleteUser: (
          id: number,
          params?: RequestParams,
      ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>

      Delete a specific user

      User

      DeleteUser

      DELETE:/users/{id}

      200 HandlerMap OK

      403 `(HandlerMap & { msg?: string,

      })Forbidden @response404 (HandlerMap & { msg?: string,

      })Not Found @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    • getUsers: (
          type?: "all" | "admin" | "in_conf",
          query?: { limit?: number; offset?: number; search?: string },
          params?: RequestParams,
      ) => Promise<
          HttpResponse<
              HandlerResponseAdminUserList,
              HandlerMap & { msg?: string },
          >,
      >

      Get a list of users by some conditions

      User

      GetUsers

      GET:/users/{type}

      200 HandlerResponseAdminUserList OK

      403 `(HandlerMap & { msg?: string,

      })` Forbidden

    • updateUser: (
          id: number,
          user: HandlerParamsUserUpdate,
          params?: RequestParams,
      ) => Promise<
          HttpResponse<HandlerResponseUserUpdate, HandlerMap & { msg?: string }>,
      >

      Update a specific user

      User

      UpdateUser

      PUT:/users/{id}

      200 HandlerResponseUserUpdate OK

      400 `(HandlerMap & { msg?: string,

      })Bad Request @response403 (HandlerMap & { msg?: string,

      })Forbidden @response404 (HandlerMap & { msg?: string,

      })Not Found @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    version: {
        getVersion: (
            params?: RequestParams,
        ) => Promise<HttpResponse<CommonApiVersionData, any>>;
    } = ...

    Type Declaration

    • getVersion: (params?: RequestParams) => Promise<HttpResponse<CommonApiVersionData, any>>

      Get the version of Artalk

      System

      GetVersion

      GET:/version

      200 CommonApiVersionData OK

    votes: {
        createVote: (
            targetName: "page" | "comment",
            targetId: number,
            choice: "up" | "down",
            vote: HandlerParamsVoteCreate,
            params?: RequestParams,
        ) => Promise<
            HttpResponse<HandlerResponseVote, HandlerMap & { msg?: string }>,
        >;
        getVote: (
            targetName: "page" | "comment",
            targetId: number,
            params?: RequestParams,
        ) => Promise<
            HttpResponse<HandlerResponseVote, HandlerMap & { msg?: string }>,
        >;
        syncVotes: (
            params?: RequestParams,
        ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>;
    } = ...

    Type Declaration

    • createVote: (
          targetName: "page" | "comment",
          targetId: number,
          choice: "up" | "down",
          vote: HandlerParamsVoteCreate,
          params?: RequestParams,
      ) => Promise<
          HttpResponse<HandlerResponseVote, HandlerMap & { msg?: string }>,
      >

      Create a new vote for a specific comment or page

      Vote

      CreateVote

      POST:/votes/{target_name}/{target_id}/{choice}

      200 HandlerResponseVote OK

      403 `(HandlerMap & { msg?: string,

      })Forbidden @response404 (HandlerMap & { msg?: string,

      })Not Found @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    • getVote: (
          targetName: "page" | "comment",
          targetId: number,
          params?: RequestParams,
      ) => Promise<
          HttpResponse<HandlerResponseVote, HandlerMap & { msg?: string }>,
      >

      Get vote status for a specific comment or page

      Vote

      GetVote

      GET:/votes/{target_name}/{target_id}

      200 HandlerResponseVote OK

      400 `(HandlerMap & { msg?: string,

      })Bad Request @response403 (HandlerMap & { msg?: string,

      })Forbidden @response404 (HandlerMap & { msg?: string,

      })Not Found @response500 (HandlerMap & { msg?: string,

      })` Internal Server Error

    • syncVotes: (
          params?: RequestParams,
      ) => Promise<HttpResponse<HandlerMap, HandlerMap & { msg?: string }>>

      Sync the number of votes in the comments or pages data tables to keep them the same as the votes table

      Vote

      SyncVotes

      POST:/votes/sync

      200 HandlerMap OK

      403 `(HandlerMap & { msg?: string,

      })` Forbidden

    • Parameters

      • cancelToken: CancelToken

      Returns void

    • Parameters

      • query: QueryParamsType
      • key: string

      Returns any

    • Parameters

      • query: QueryParamsType
      • key: string

      Returns string

    • Parameters

      • OptionalrawQuery: QueryParamsType

      Returns string

    • Parameters

      • cancelToken: CancelToken

      Returns AbortSignal | undefined

    • Parameters

      • key: string
      • value: any

      Returns string

    • Get user info as params for request

      Returns { email: string; name: string } | undefined

      Request params with user info

    • Parameters

      • params1: RequestParams
      • Optionalparams2: RequestParams

      Returns RequestParams

    • Type Parameters

      • T = any
      • E = any

      Parameters

      • __namedParameters: FullRequestParams

      Returns Promise<HttpResponse<T, E>>

    • Parameters

      • data: void | null

      Returns void

    • Parameters

      • OptionalrawQuery: QueryParamsType

      Returns string

    Settings
    Member Visibility

    On This Page
    Properties
    Methods