zoot-plus-client@0.1.0-SNAPSHOT.1011.sha.c05c908

A TypeScript SDK client for the localhost API.

Usage

First, install the SDK from npm.

npm install zoot-plus-client --save

Next, try it out.

import {
  Configuration,
  ArkLevelControllerApi,
} from 'zoot-plus-client';
import type { GetLevelsRequest } from 'zoot-plus-client';

async function example() {
  console.log("🚀 Testing zoot-plus-client SDK...");
  const api = new ArkLevelControllerApi();

  try {
    const data = await api.getLevels();
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to http://localhost:8848

Class	Method	HTTP request	Description
ArkLevelControllerApi	getLevels	GET /arknights/level	获取关卡数据
CommentAreaApi	deleteComments	POST /comments/delete	删除评论
CommentAreaApi	modifyStatus1	GET /comments/status	设置通知接收状态
CommentAreaApi	queriesCommentsArea	GET /comments/query	分页查询评论
CommentAreaApi	ratesComments	POST /comments/rating	为评论点赞
CommentAreaApi	sendComments	POST /comments/add	发送评论
CommentAreaApi	toppingComments	POST /comments/topping	为评论置顶/取消置顶
CopilotControllerApi	banComments	GET /copilot/ban	禁用评论区/开启评论区
CopilotControllerApi	deleteCopilot	POST /copilot/delete	删除作业
CopilotControllerApi	getCopilotById	GET /copilot/get/{id}	获取作业
CopilotControllerApi	modifyStatus	GET /copilot/status	修改通知状态
CopilotControllerApi	queriesCopilot	GET /copilot/query	分页查询作业，提供登录凭据时查询用户自己的作业
CopilotControllerApi	ratesCopilotOperation	POST /copilot/rating	为作业评分
CopilotControllerApi	updateCopilot	POST /copilot/update	更新作业
CopilotControllerApi	uploadCopilot	POST /copilot/upload	上传作业
CopilotSetApi	addCopilotIds	POST /set/add	添加作业集作业列表
CopilotSetApi	createSet	POST /set/create	创建作业集
CopilotSetApi	deleteCopilotSet	POST /set/delete	删除作业集
CopilotSetApi	getSet	GET /set/get	查询作业集详情
CopilotSetApi	querySets	POST /set/query	查询作业集列表
CopilotSetApi	removeCopilotIds	POST /set/remove	添加作业集作业列表
CopilotSetApi	updateCopilotSet	POST /set/update	更新作业集信息
CopilotUserApi	getBatchUserInfo	GET /user/batch	批量获取用户信息
CopilotUserApi	getMe	GET /user/me	获取当前登录用户信息
CopilotUserApi	getUserInfo	GET /user/info	查询用户信息
CopilotUserApi	login	POST /user/login	用户登录
CopilotUserApi	passwordReset	POST /user/password/reset	重置密码
CopilotUserApi	passwordResetRequest	POST /user/password/reset_request	发送用于重置密码的验证码
CopilotUserApi	refresh	POST /user/refresh	刷新token
CopilotUserApi	register	POST /user/register	用户注册
CopilotUserApi	searchUsers	GET /user/search	用户模糊搜索
CopilotUserApi	sendRegistrationToken	POST /user/sendRegistrationToken	注册时发送验证码
CopilotUserApi	updateInfo	POST /user/update/info	更新用户详细信息
CopilotUserApi	updatePassword	POST /user/update/password	修改当前用户密码
SiteMessageApi	list	GET /message/list	分页查询站内信
SiteMessageApi	read	POST /message/read/{id}	标记单条站内信已读
SiteMessageApi	readAll	POST /message/readAll	标记全部站内信已读
SiteMessageApi	unreadCount	GET /message/unreadCount	查询未读站内信数量
SystemApi	getIntraProcessCacheStat	GET /cache/stat	返回进程内缓存统计信息
SystemApi	getSystemVersion	GET /version	Gets the current version of the server.
SystemApi	test	GET /	Tests if the server is ready.
UserFollowApi	follow	POST /follow/follow/{followUserId}	关注用户
UserFollowApi	getFansList	GET /follow/fansList	获取粉丝列表
UserFollowApi	getFollowingList	GET /follow/followingList	获取关注列表
UserFollowApi	getStatus	GET /follow/status/{followUserId}	查询关注状态
UserFollowApi	specialFollow	POST /follow/special/{followUserId}	设置特别关注
UserFollowApi	unfollow	POST /follow/unfollow/{followUserId}	取消关注
WebhookApi	levelOpenStatusUpdate	POST /webhook/levels/open-status/sync
WebhookApi	levelsUpdate	POST /webhook/levels/sync

Models

• ArkLevelInfo
• CacheStatInfo
• CommentsAddDTO
• CommentsAreaInfo
• CommentsDeleteDTO
• CommentsInfo
• CommentsRatingDTO
• CommentsToppingDTO
• CommonIdReqLong
• CopilotCUDRequest
• CopilotDeleteRequest
• CopilotInfo
• CopilotPageInfo
• CopilotRatingReq
• CopilotSetCreateReq
• CopilotSetListRes
• CopilotSetModCopilotsReq
• CopilotSetQuery
• CopilotSetRes
• CopilotSetStatus
• CopilotSetUpdateReq
• FollowStatusInfo
• GitInfo
• LoginDTO
• MaaLoginRsp
• MaaResult
• MaaResultBoolean
• MaaResultCommentsAreaInfo
• MaaResultCopilotInfo
• MaaResultCopilotPageInfo
• MaaResultCopilotSetRes
• MaaResultFollowStatusInfo
• MaaResultInteger
• MaaResultListArkLevelInfo
• MaaResultListMaaUserInfo
• MaaResultLong
• MaaResultMaaLoginRsp
• MaaResultMaaSystemInfo
• MaaResultMaaUserInfo
• MaaResultMapStringCacheStatInfo
• MaaResultPagedDTOCopilotSetListRes
• MaaResultPagedDTOMaaUserInfo
• MaaResultPagedDTOSiteMessageInfo
• MaaResultString
• MaaResultUnit
• MaaResultUnreadMessageCountInfo
• MaaSystemInfo
• MaaUserInfo
• PagedDTOCopilotSetListRes
• PagedDTOMaaUserInfo
• PagedDTOSiteMessageInfo
• PasswordResetDTO
• PasswordResetVCodeDTO
• PasswordUpdateDTO
• PrtsCUDRequest
• RefreshReq
• RegisterDTO
• SendRegistrationTokenDTO
• SiteMessageInfo
• SubCommentsInfo
• UnreadMessageCountInfo
• UploadCopilotRequest
• UserInfoUpdateDTO
• VideoCUDRequest

Authorization

Authentication schemes defined for the API:

Jwt

• Type: HTTP Bearer Token authentication

API_Key

• Type: API key
• API key parameter name: X-API-Key
• Location: HTTP header

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

• API version: v2.0.0
• Package version: 0.1.0-SNAPSHOT.1011.sha.c05c908
• Generator version: 7.23.0
• Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

• Environments
  • Node.js
  • Webpack
  • Browserify
• Language levels
  • ES5 - you must have a Promises/A+ library installed
  • ES6
• Module systems
  • CommonJS
  • ES6 module system

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License

GNU Affero General Public License v3.0