5285 lines
116 KiB
TypeScript
5285 lines
116 KiB
TypeScript
/* tslint:disable */
|
||
/* eslint-disable */
|
||
/**
|
||
* 用户中心接口文档 - version 0.0.1
|
||
*
|
||
* UserBase 用户中心 OpenAPI 文档（springdoc-openapi）
|
||
*
|
||
* OpenAPI version: 3.0.1
|
||
*
|
||
*
|
||
* NOTE: This file is auto generated by the alova's vscode plugin.
|
||
*
|
||
* https://alova.js.org/devtools/vscode
|
||
*
|
||
* **Do not edit the file manually.**
|
||
*/
|
||
import type { $$userConfigMap, alovaInstance } from './index';
|
||
import type apiDefinitions from './apiDefinitions';
|
||
|
||
type CollapsedAlova = typeof alovaInstance;
|
||
type UserMethodConfigMap = typeof $$userConfigMap;
|
||
|
||
export interface SysUserQuery {
|
||
groupId?: number;
|
||
withSub?: number;
|
||
name?: string;
|
||
disabled?: number;
|
||
}
|
||
export interface BasePageQuery {
|
||
pageIndex?: number;
|
||
pageSize?: number;
|
||
keyword?: string;
|
||
}
|
||
export interface SysGroupQuery {
|
||
name?: string;
|
||
parentId?: number;
|
||
}
|
||
export interface PushRecordQuery {
|
||
appKey?: number;
|
||
interfacePath?: string;
|
||
success?: number;
|
||
startTime?: string;
|
||
endTime?: string;
|
||
}
|
||
export interface Sort {
|
||
sort?: string[];
|
||
}
|
||
export interface SysOperationLogQuery {
|
||
logLevel?: number;
|
||
userId?: number;
|
||
username?: string;
|
||
requestUri?: string;
|
||
requestIp?: string;
|
||
operationType?: string;
|
||
statusCode?: number;
|
||
success?: boolean;
|
||
keyword?: string;
|
||
startTime?: string;
|
||
endTime?: string;
|
||
}
|
||
export interface SysAppRoleQuery {
|
||
name?: string;
|
||
appId?: number;
|
||
allAppFlag?: boolean;
|
||
disabled?: boolean;
|
||
}
|
||
export interface AppModuleQuery {
|
||
appId?: number;
|
||
name?: string;
|
||
parentId?: number;
|
||
}
|
||
export interface AppCategoryQuery {
|
||
name?: string;
|
||
}
|
||
export interface ApplicationInfoQuery {
|
||
name?: string;
|
||
categoryId?: number;
|
||
}
|
||
export interface ChangeGroupsRequest {
|
||
userIds: number[];
|
||
groupIds: number[];
|
||
}
|
||
export interface BatchDeleteRequest {
|
||
userIds: number[];
|
||
groupId: number;
|
||
}
|
||
export interface BatchChangeStatusRequest {
|
||
userIds: number[];
|
||
disabled: boolean;
|
||
}
|
||
export interface SysUserRequest {
|
||
id: number;
|
||
groupId: number;
|
||
account: string;
|
||
password: string;
|
||
confirmPassword?: string;
|
||
realName?: string;
|
||
phone?: string;
|
||
birthday?: string;
|
||
idcard?: string;
|
||
email?: string;
|
||
gender?: number;
|
||
profilePicture?: string;
|
||
roles?: number[];
|
||
disabled?: number;
|
||
expired?: boolean;
|
||
}
|
||
export interface SysGroupSortRequest {
|
||
pid: number;
|
||
ids: number[];
|
||
}
|
||
export interface SysGroupMoveRequest {
|
||
moveId: number;
|
||
pid: number;
|
||
}
|
||
export interface BatchItem {
|
||
name: string;
|
||
}
|
||
export interface SysGroupBatchRequest {
|
||
pid: number;
|
||
type: number;
|
||
items: BatchItem[];
|
||
}
|
||
export interface SysGroupRequest {
|
||
id?: number;
|
||
name: string;
|
||
parentId: number;
|
||
type: number;
|
||
sort?: number;
|
||
}
|
||
export interface PushTestRequest {
|
||
appId?: number;
|
||
interfacePath?: string;
|
||
targetIds?: number[];
|
||
}
|
||
export interface IdentitySwitchRequest {
|
||
roleId: number;
|
||
schoolId: number;
|
||
}
|
||
export interface SchoolAppAuthzRequest {
|
||
schid: number;
|
||
appid: number;
|
||
mode: number;
|
||
}
|
||
export interface GroupModuleAuthzItem {
|
||
groupId: number;
|
||
appId: number;
|
||
moduleId: number;
|
||
mode: number;
|
||
isAll: number;
|
||
}
|
||
export interface ModulePermItem {
|
||
moduleId: number;
|
||
inheritFlag?: boolean;
|
||
}
|
||
export interface GroupModulePermRequest {
|
||
groupId: number;
|
||
perms?: ModulePermItem[];
|
||
}
|
||
export interface GroupAppAssignRequest {
|
||
groupId: number;
|
||
appIds?: number[];
|
||
}
|
||
export interface UserAppRoleBindRequest {
|
||
userId: number;
|
||
roleIds?: number[];
|
||
}
|
||
export interface AppRoleUserBindRequest {
|
||
roleId: number;
|
||
userIds?: number[];
|
||
}
|
||
export interface AppRoleModuleAssignRequest {
|
||
roleId: number;
|
||
moduleIds?: number[];
|
||
}
|
||
export interface SysAppRoleRequest {
|
||
id: number;
|
||
name: string;
|
||
appId?: number;
|
||
allAppFlag: boolean;
|
||
remark?: string;
|
||
disabled?: boolean;
|
||
}
|
||
export interface AppCategoryRequest {
|
||
id: number;
|
||
name: string;
|
||
sortNo?: number;
|
||
}
|
||
export interface AppModuleRequest {
|
||
id: number;
|
||
appId: number;
|
||
parentId?: number;
|
||
name: string;
|
||
customId: string;
|
||
path?: string;
|
||
sortNo?: number;
|
||
}
|
||
export interface ApplicationInfoRequest {
|
||
id: number;
|
||
name: string;
|
||
categoryId: number;
|
||
desc?: string;
|
||
clients?: number[];
|
||
pcUrl?: string;
|
||
pcIcon?: string;
|
||
appUrl?: string;
|
||
appIcon?: string;
|
||
officialAccountUrl?: string;
|
||
dingtalkUrl?: string;
|
||
}
|
||
export interface SysUserMoveRequest {
|
||
userId: number;
|
||
groupId: number;
|
||
schoolId: number;
|
||
}
|
||
export interface SysGroupVo {
|
||
id?: number;
|
||
name?: string;
|
||
type?: number;
|
||
sort?: number;
|
||
children?: SysGroupVo[];
|
||
}
|
||
export interface IdentityCurrentVo {
|
||
roleId?: number;
|
||
roleName?: string;
|
||
schoolId?: number;
|
||
schoolName?: string;
|
||
fallback?: boolean;
|
||
}
|
||
export interface IdentityOptionVo {
|
||
roleId?: number;
|
||
roleName?: string;
|
||
schoolId?: number;
|
||
schoolName?: string;
|
||
isMain?: boolean;
|
||
}
|
||
export interface AppItem {
|
||
id?: number;
|
||
name?: string;
|
||
}
|
||
export interface AppAuthzCategoryVo {
|
||
id?: number;
|
||
name?: string;
|
||
app?: AppItem[];
|
||
}
|
||
export interface BoaGroup {
|
||
id?: number;
|
||
name?: string;
|
||
parentId?: number;
|
||
type?: number;
|
||
sort?: number;
|
||
children?: BoaGroup[];
|
||
}
|
||
export interface ChangeSortNoRequest {
|
||
groupId: number;
|
||
sortNo?: number;
|
||
}
|
||
export interface PushSettingRequest {
|
||
pushBaseUrl?: string;
|
||
pushEnabled?: number;
|
||
pushEventTypes?: string;
|
||
pushSchoolIds?: string;
|
||
pushRoleIds?: string;
|
||
pushSecret?: string;
|
||
}
|
||
export interface FailItem {
|
||
row?: number;
|
||
reason?: string;
|
||
}
|
||
export interface BatchImportResult {
|
||
total?: number;
|
||
success?: number;
|
||
fail?: number;
|
||
fails?: FailItem[];
|
||
}
|
||
export interface BoaUser {
|
||
id?: number;
|
||
account?: string;
|
||
name?: string;
|
||
idcard?: string;
|
||
phone?: string;
|
||
email?: string;
|
||
gender?: number;
|
||
profilePicture?: string;
|
||
type?: number;
|
||
status?: number;
|
||
dept?: BoaGroup;
|
||
school?: BoaGroup;
|
||
bureau?: BoaGroup;
|
||
groups?: BoaGroup[];
|
||
roleIds?: number[];
|
||
currentRoleId?: number;
|
||
schools?: BoaGroup[];
|
||
}
|
||
export interface SysUserVo {
|
||
id?: number;
|
||
account?: string;
|
||
birthday?: string;
|
||
realName?: string;
|
||
phone?: string;
|
||
idcard?: string;
|
||
email?: string;
|
||
gender?: number;
|
||
profilePicture?: string;
|
||
roles?: number[];
|
||
disabled?: number;
|
||
type?: number;
|
||
sortNo?: number;
|
||
expired?: boolean;
|
||
createTime?: string;
|
||
updateTime?: string;
|
||
}
|
||
export interface BasePageResultSysUserVo {
|
||
total?: number;
|
||
content?: SysUserVo[];
|
||
pageIndex?: number;
|
||
pageSize?: number;
|
||
totalPages?: number;
|
||
hasNext?: boolean;
|
||
}
|
||
export interface PushRecordListVo {
|
||
id?: number;
|
||
subscriberAppKey?: number;
|
||
appName?: string;
|
||
interfacePath?: string;
|
||
interfaceLabel?: string;
|
||
requestUrl?: string;
|
||
signT?: string;
|
||
httpStatus?: number;
|
||
respCode?: number;
|
||
respMsg?: string;
|
||
success?: number;
|
||
attemptNo?: number;
|
||
costMs?: number;
|
||
triggerType?: string;
|
||
createdAt?: string;
|
||
}
|
||
export interface BasePageResultPushRecordListVo {
|
||
total?: number;
|
||
content?: PushRecordListVo[];
|
||
pageIndex?: number;
|
||
pageSize?: number;
|
||
totalPages?: number;
|
||
hasNext?: boolean;
|
||
}
|
||
export interface SysOperationLogListVo {
|
||
id?: number;
|
||
logLevel?: number;
|
||
userId?: number;
|
||
username?: string;
|
||
requestIp?: string;
|
||
requestUri?: string;
|
||
requestMethod?: string;
|
||
operationType?: string;
|
||
classMethod?: string;
|
||
requestParams?: string;
|
||
statusCode?: number;
|
||
costTime?: number;
|
||
userAgent?: string;
|
||
errorMsg?: string;
|
||
createTime?: string;
|
||
}
|
||
export interface BasePageResultSysOperationLogListVo {
|
||
total?: number;
|
||
content?: SysOperationLogListVo[];
|
||
pageIndex?: number;
|
||
pageSize?: number;
|
||
totalPages?: number;
|
||
hasNext?: boolean;
|
||
}
|
||
export interface UserRoleVo {
|
||
id?: number;
|
||
name?: string;
|
||
allAppFlag?: boolean;
|
||
appId?: number;
|
||
appName?: string;
|
||
disabled?: boolean;
|
||
}
|
||
export interface UserPermissionModuleVo {
|
||
id?: number;
|
||
parentId?: number;
|
||
name?: string;
|
||
customId?: string;
|
||
path?: string;
|
||
level?: number;
|
||
sortNo?: number;
|
||
}
|
||
export interface UserPermissionAppVo {
|
||
id?: number;
|
||
name?: string;
|
||
appKey?: number;
|
||
pcIcon?: string;
|
||
sortNo?: number;
|
||
modules?: UserPermissionModuleVo[];
|
||
}
|
||
export interface UserPermissionCategoryVo {
|
||
id?: number;
|
||
name?: string;
|
||
sortNo?: number;
|
||
apps?: UserPermissionAppVo[];
|
||
}
|
||
export interface UserGroupNodeVo {
|
||
id?: number;
|
||
name?: string;
|
||
own?: boolean;
|
||
children?: UserGroupNodeVo[];
|
||
}
|
||
export interface UserPermissionUserVo {
|
||
id?: number;
|
||
account?: string;
|
||
realName?: string;
|
||
isMain?: number;
|
||
groupPath?: string;
|
||
}
|
||
export interface GroupAuthzModuleVo {
|
||
id?: number;
|
||
parentId?: number;
|
||
name?: string;
|
||
customId?: string;
|
||
path?: string;
|
||
level?: number;
|
||
sortNo?: number;
|
||
checked?: boolean;
|
||
inheritFlag?: boolean;
|
||
}
|
||
export interface GroupAuthzAppVo {
|
||
id?: number;
|
||
name?: string;
|
||
appKey?: number;
|
||
pcIcon?: string;
|
||
categoryId?: number;
|
||
sortNo?: number;
|
||
modules?: GroupAuthzModuleVo[];
|
||
}
|
||
export interface GroupAuthzCategoryVo {
|
||
id?: number;
|
||
name?: string;
|
||
apps?: GroupAuthzAppVo[];
|
||
}
|
||
export interface GroupAppVo {
|
||
id?: number;
|
||
name?: string;
|
||
categoryId?: number;
|
||
appKey?: number;
|
||
pcIcon?: string;
|
||
checked?: boolean;
|
||
}
|
||
export type AutowireCapableBeanFactory = object;
|
||
export interface Environment {
|
||
activeProfiles?: string[];
|
||
defaultProfiles?: string[];
|
||
}
|
||
export type BeanFactory = object;
|
||
export interface ApplicationContext {
|
||
parent?: ApplicationContext;
|
||
id?: string;
|
||
displayName?: string;
|
||
applicationName?: string;
|
||
autowireCapableBeanFactory?: AutowireCapableBeanFactory;
|
||
startupDate?: number;
|
||
environment?: Environment;
|
||
beanDefinitionCount?: number;
|
||
beanDefinitionNames?: string[];
|
||
parentBeanFactory?: BeanFactory;
|
||
classLoader?: {
|
||
parent?: {
|
||
defaultAssertionStatus?: boolean;
|
||
};
|
||
defaultAssertionStatus?: boolean;
|
||
};
|
||
}
|
||
export interface RedirectView {
|
||
applicationContext?: ApplicationContext;
|
||
servletContext?: {
|
||
classLoader?: {
|
||
parent?: {
|
||
defaultAssertionStatus?: boolean;
|
||
};
|
||
defaultAssertionStatus?: boolean;
|
||
};
|
||
attributeNames?: object;
|
||
majorVersion?: number;
|
||
contextPath?: string;
|
||
/**
|
||
* @deprecated
|
||
*/
|
||
servletNames?: object;
|
||
minorVersion?: number;
|
||
initParameterNames?: object;
|
||
sessionTimeout?: number;
|
||
serverInfo?: string;
|
||
/**
|
||
* @deprecated
|
||
*/
|
||
servlets?: object;
|
||
requestCharacterEncoding?: string;
|
||
filterRegistrations?: Record<
|
||
string,
|
||
{
|
||
urlPatternMappings?: string[];
|
||
servletNameMappings?: string[];
|
||
name?: string;
|
||
className?: string;
|
||
initParameters?: Record<string, string>;
|
||
}
|
||
>;
|
||
servletContextName?: string;
|
||
sessionTrackingModes?: ('COOKIE' | 'URL' | 'SSL')[];
|
||
effectiveMinorVersion?: number;
|
||
defaultSessionTrackingModes?: ('COOKIE' | 'URL' | 'SSL')[];
|
||
servletRegistrations?: Record<
|
||
string,
|
||
{
|
||
mappings?: string[];
|
||
runAsRole?: string;
|
||
name?: string;
|
||
className?: string;
|
||
initParameters?: Record<string, string>;
|
||
}
|
||
>;
|
||
effectiveMajorVersion?: number;
|
||
virtualServerName?: string;
|
||
sessionCookieConfig?: {
|
||
name?: string;
|
||
path?: string;
|
||
comment?: string;
|
||
domain?: string;
|
||
secure?: boolean;
|
||
maxAge?: number;
|
||
httpOnly?: boolean;
|
||
};
|
||
jspConfigDescriptor?: {
|
||
taglibs?: Array<{
|
||
taglibURI?: string;
|
||
taglibLocation?: string;
|
||
}>;
|
||
jspPropertyGroups?: Array<{
|
||
buffer?: string;
|
||
urlPatterns?: string[];
|
||
defaultContentType?: string;
|
||
elIgnored?: string;
|
||
pageEncoding?: string;
|
||
isXml?: string;
|
||
includeCodas?: string[];
|
||
trimDirectiveWhitespaces?: string;
|
||
includePreludes?: string[];
|
||
scriptingInvalid?: string;
|
||
errorOnUndeclaredNamespace?: string;
|
||
deferredSyntaxAllowedAsLiteral?: string;
|
||
}>;
|
||
};
|
||
responseCharacterEncoding?: string;
|
||
effectiveSessionTrackingModes?: ('COOKIE' | 'URL' | 'SSL')[];
|
||
};
|
||
contentType?: string;
|
||
requestContextAttribute?: string;
|
||
staticAttributes?: Record<string, object>;
|
||
exposePathVariables?: boolean;
|
||
exposeContextBeansAsAttributes?: boolean;
|
||
exposedContextBeanNames?: string[];
|
||
beanName?: string;
|
||
url?: string;
|
||
contextRelative?: boolean;
|
||
http10Compatible?: boolean;
|
||
exposeModelAttributes?: boolean;
|
||
encodingScheme?: string;
|
||
statusCode?:
|
||
| '100 CONTINUE'
|
||
| '101 SWITCHING_PROTOCOLS'
|
||
| '102 PROCESSING'
|
||
| '103 CHECKPOINT'
|
||
| '200 OK'
|
||
| '201 CREATED'
|
||
| '202 ACCEPTED'
|
||
| '203 NON_AUTHORITATIVE_INFORMATION'
|
||
| '204 NO_CONTENT'
|
||
| '205 RESET_CONTENT'
|
||
| '206 PARTIAL_CONTENT'
|
||
| '207 MULTI_STATUS'
|
||
| '208 ALREADY_REPORTED'
|
||
| '226 IM_USED'
|
||
| '300 MULTIPLE_CHOICES'
|
||
| '301 MOVED_PERMANENTLY'
|
||
| '302 FOUND'
|
||
| '302 MOVED_TEMPORARILY'
|
||
| '303 SEE_OTHER'
|
||
| '304 NOT_MODIFIED'
|
||
| '305 USE_PROXY'
|
||
| '307 TEMPORARY_REDIRECT'
|
||
| '308 PERMANENT_REDIRECT'
|
||
| '400 BAD_REQUEST'
|
||
| '401 UNAUTHORIZED'
|
||
| '402 PAYMENT_REQUIRED'
|
||
| '403 FORBIDDEN'
|
||
| '404 NOT_FOUND'
|
||
| '405 METHOD_NOT_ALLOWED'
|
||
| '406 NOT_ACCEPTABLE'
|
||
| '407 PROXY_AUTHENTICATION_REQUIRED'
|
||
| '408 REQUEST_TIMEOUT'
|
||
| '409 CONFLICT'
|
||
| '410 GONE'
|
||
| '411 LENGTH_REQUIRED'
|
||
| '412 PRECONDITION_FAILED'
|
||
| '413 PAYLOAD_TOO_LARGE'
|
||
| '413 REQUEST_ENTITY_TOO_LARGE'
|
||
| '414 URI_TOO_LONG'
|
||
| '414 REQUEST_URI_TOO_LONG'
|
||
| '415 UNSUPPORTED_MEDIA_TYPE'
|
||
| '416 REQUESTED_RANGE_NOT_SATISFIABLE'
|
||
| '417 EXPECTATION_FAILED'
|
||
| '418 I_AM_A_TEAPOT'
|
||
| '419 INSUFFICIENT_SPACE_ON_RESOURCE'
|
||
| '420 METHOD_FAILURE'
|
||
| '421 DESTINATION_LOCKED'
|
||
| '422 UNPROCESSABLE_ENTITY'
|
||
| '423 LOCKED'
|
||
| '424 FAILED_DEPENDENCY'
|
||
| '425 TOO_EARLY'
|
||
| '426 UPGRADE_REQUIRED'
|
||
| '428 PRECONDITION_REQUIRED'
|
||
| '429 TOO_MANY_REQUESTS'
|
||
| '431 REQUEST_HEADER_FIELDS_TOO_LARGE'
|
||
| '451 UNAVAILABLE_FOR_LEGAL_REASONS'
|
||
| '500 INTERNAL_SERVER_ERROR'
|
||
| '501 NOT_IMPLEMENTED'
|
||
| '502 BAD_GATEWAY'
|
||
| '503 SERVICE_UNAVAILABLE'
|
||
| '504 GATEWAY_TIMEOUT'
|
||
| '505 HTTP_VERSION_NOT_SUPPORTED'
|
||
| '506 VARIANT_ALSO_NEGOTIATES'
|
||
| '507 INSUFFICIENT_STORAGE'
|
||
| '508 LOOP_DETECTED'
|
||
| '509 BANDWIDTH_LIMIT_EXCEEDED'
|
||
| '510 NOT_EXTENDED'
|
||
| '511 NETWORK_AUTHENTICATION_REQUIRED';
|
||
expandUriTemplateVariables?: boolean;
|
||
propagateQueryParams?: boolean;
|
||
hosts?: string[];
|
||
redirectView?: boolean;
|
||
propagateQueryProperties?: boolean;
|
||
attributes?: Record<string, string>;
|
||
attributesMap?: Record<string, object>;
|
||
attributesCSV?: string;
|
||
}
|
||
export interface AppRoleUserVo {
|
||
id?: number;
|
||
account?: string;
|
||
realName?: string;
|
||
}
|
||
export interface AppRoleAuthzModuleVo {
|
||
id?: number;
|
||
parentId?: number;
|
||
name?: string;
|
||
customId?: string;
|
||
path?: string;
|
||
level?: number;
|
||
sortNo?: number;
|
||
checked?: boolean;
|
||
}
|
||
export interface AppRoleAuthzAppVo {
|
||
id?: number;
|
||
name?: string;
|
||
appKey?: number;
|
||
pcIcon?: string;
|
||
sortNo?: number;
|
||
modules?: AppRoleAuthzModuleVo[];
|
||
}
|
||
export interface SysAppRoleVo {
|
||
id?: number;
|
||
name?: string;
|
||
appId?: number;
|
||
appName?: string;
|
||
allAppFlag?: boolean;
|
||
remark?: string;
|
||
disabled?: boolean;
|
||
}
|
||
export interface BasePageResultSysAppRoleVo {
|
||
total?: number;
|
||
content?: SysAppRoleVo[];
|
||
pageIndex?: number;
|
||
pageSize?: number;
|
||
totalPages?: number;
|
||
hasNext?: boolean;
|
||
}
|
||
export interface AppModuleVo {
|
||
id?: number;
|
||
appId?: number;
|
||
parentId?: number;
|
||
name?: string;
|
||
customId?: string;
|
||
path?: string;
|
||
level?: number;
|
||
sortNo?: number;
|
||
children?: AppModuleVo[];
|
||
}
|
||
export interface PushSettingVo {
|
||
id?: number;
|
||
appKey?: number;
|
||
name?: string;
|
||
pushBaseUrl?: string;
|
||
pushEnabled?: number;
|
||
pushEventTypes?: string;
|
||
pushSchoolIds?: string;
|
||
pushRoleIds?: string;
|
||
pushSecret?: string;
|
||
}
|
||
export interface AppCategoryVo {
|
||
id?: number;
|
||
name?: string;
|
||
sortNo?: number;
|
||
}
|
||
export interface ApplicationInfoSortVo {
|
||
id?: number;
|
||
name?: string;
|
||
sortNo?: number;
|
||
}
|
||
export interface ApplicationInfoVo {
|
||
id?: number;
|
||
name?: string;
|
||
categoryId?: number;
|
||
sortNo?: number;
|
||
desc?: string;
|
||
appKey?: number;
|
||
appSecret?: string;
|
||
clients?: number[];
|
||
pcUrl?: string;
|
||
pcIcon?: string;
|
||
appUrl?: string;
|
||
appIcon?: string;
|
||
officialAccountUrl?: string;
|
||
dingtalkUrl?: string;
|
||
}
|
||
export interface BasePageResultApplicationInfoVo {
|
||
total?: number;
|
||
content?: ApplicationInfoVo[];
|
||
pageIndex?: number;
|
||
pageSize?: number;
|
||
totalPages?: number;
|
||
hasNext?: boolean;
|
||
}
|
||
export interface BoaModule {
|
||
id?: number;
|
||
parentId?: number;
|
||
customId?: string;
|
||
name?: string;
|
||
path?: string;
|
||
level?: number;
|
||
sortNo?: number;
|
||
icon?: string;
|
||
}
|
||
declare global {
|
||
interface Apis {
|
||
SysUser: {
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/sysuser/Enable/{id}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* id: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
enable<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
pathParams: {
|
||
id: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'SysUser.enable', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/sysuser/Edit/{id}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* id: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* id: number
|
||
* groupId: number
|
||
* account: string
|
||
* password: string
|
||
* confirmPassword?: string
|
||
* realName?: string
|
||
* phone?: string
|
||
* birthday?: string
|
||
* idcard?: string
|
||
* email?: string
|
||
* gender?: number
|
||
* profilePicture?: string
|
||
* // [items] start
|
||
* // [items] end
|
||
* roles?: number[]
|
||
* disabled?: number
|
||
* expired?: boolean
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
edit<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
pathParams: {
|
||
id: number;
|
||
};
|
||
data: SysUserRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'SysUser.edit', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/sysuser/Disable/{id}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* id: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
disable<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
pathParams: {
|
||
id: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'SysUser.disable', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/sysuser/DeleteFromGroup/{userId}/{groupId}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* userId: number
|
||
* groupId: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
deleteFromGroup<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
pathParams: {
|
||
userId: number;
|
||
groupId: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'SysUser.deleteFromGroup', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/sysuser/ChangeSortNo/{userId}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* userId: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* groupId: number
|
||
* sortNo?: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
changeSortNo<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
pathParams: {
|
||
userId: number;
|
||
};
|
||
data: ChangeSortNoRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'SysUser.changeSortNo', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/sysuser/ChangeGroups
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* // [items] start
|
||
* // [items] end
|
||
* userIds: number[]
|
||
* // [items] start
|
||
* // [items] end
|
||
* groupIds: number[]
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
changeGroups<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
data: ChangeGroupsRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'SysUser.changeGroups', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/sysuser/BatchImport
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* file: Blob
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = {
|
||
* total?: number
|
||
* success?: number
|
||
* fail?: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* fails?: Array<{
|
||
* row?: number
|
||
* reason?: string
|
||
* }>
|
||
* }
|
||
* ```
|
||
*/
|
||
batchImport<
|
||
Config extends Alova2MethodConfig<BatchImportResult> & {
|
||
data: {
|
||
file: Blob;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<BatchImportResult, 'SysUser.batchImport', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/sysuser/BatchDelete
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* // [items] start
|
||
* // [items] end
|
||
* userIds: number[]
|
||
* groupId: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
batchDelete<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
data: BatchDeleteRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'SysUser.batchDelete', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/sysuser/BatchChangeStatus
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* // [items] start
|
||
* // [items] end
|
||
* userIds: number[]
|
||
* disabled: boolean
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
batchChangeStatus<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
data: BatchChangeStatusRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'SysUser.batchChangeStatus', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/sysuser/Add
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* id: number
|
||
* groupId: number
|
||
* account: string
|
||
* password: string
|
||
* confirmPassword?: string
|
||
* realName?: string
|
||
* phone?: string
|
||
* birthday?: string
|
||
* idcard?: string
|
||
* email?: string
|
||
* gender?: number
|
||
* profilePicture?: string
|
||
* // [items] start
|
||
* // [items] end
|
||
* roles?: number[]
|
||
* disabled?: number
|
||
* expired?: boolean
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = number
|
||
* ```
|
||
*/
|
||
add<
|
||
Config extends Alova2MethodConfig<number> & {
|
||
data: SysUserRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<number, 'SysUser.add', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/sysuser/List
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* query: {
|
||
* groupId?: number
|
||
* withSub?: number
|
||
* name?: string
|
||
* disabled?: number
|
||
* }
|
||
* pageQuery: {
|
||
* pageIndex?: number
|
||
* pageSize?: number
|
||
* keyword?: string
|
||
* }
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = {
|
||
* total?: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* content?: Array<{
|
||
* id?: number
|
||
* account?: string
|
||
* birthday?: string
|
||
* realName?: string
|
||
* phone?: string
|
||
* idcard?: string
|
||
* email?: string
|
||
* gender?: number
|
||
* profilePicture?: string
|
||
* // [items] start
|
||
* // [items] end
|
||
* roles?: number[]
|
||
* disabled?: number
|
||
* type?: number
|
||
* sortNo?: number
|
||
* expired?: boolean
|
||
* createTime?: string
|
||
* updateTime?: string
|
||
* }>
|
||
* pageIndex?: number
|
||
* pageSize?: number
|
||
* totalPages?: number
|
||
* hasNext?: boolean
|
||
* }
|
||
* ```
|
||
*/
|
||
list<
|
||
Config extends Alova2MethodConfig<BasePageResultSysUserVo> & {
|
||
params: {
|
||
query: SysUserQuery;
|
||
pageQuery: BasePageQuery;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<BasePageResultSysUserVo, 'SysUser.list', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/sysuser/Groups/{userId}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* userId: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = number[]
|
||
* ```
|
||
*/
|
||
getUserGroups<
|
||
Config extends Alova2MethodConfig<number[]> & {
|
||
pathParams: {
|
||
userId: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<number[], 'SysUser.getUserGroups', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/sysuser/Export
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* groupId?: number
|
||
* withSub?: number
|
||
* name?: string
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
export_<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
params: {
|
||
groupId?: number;
|
||
withSub?: number;
|
||
name?: string;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'SysUser.export_', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/sysuser/DownloadTemplate
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* groupId?: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
downloadTemplate<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
params: {
|
||
groupId?: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'SysUser.downloadTemplate', Config>;
|
||
};
|
||
SysGroup: {
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/sysgroup/SortChildren
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* pid: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* ids: number[]
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
sortChildren<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
data: SysGroupSortRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'SysGroup.sortChildren', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/sysgroup/Move
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* moveId: number
|
||
* pid: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
move<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
data: SysGroupMoveRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'SysGroup.move', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/sysgroup/Edit/{id}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* id: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* id?: number
|
||
* name: string
|
||
* parentId: number
|
||
* type: number
|
||
* sort?: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
edit_1<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
pathParams: {
|
||
id: number;
|
||
};
|
||
data: SysGroupRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'SysGroup.edit_1', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/sysgroup/Delete/{id}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* id: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
delete_<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
pathParams: {
|
||
id: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'SysGroup.delete_', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/sysgroup/BatchAdd
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* pid: number
|
||
* type: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* items: Array<{
|
||
* name: string
|
||
* }>
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
batchAdd<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
data: SysGroupBatchRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'SysGroup.batchAdd', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/sysgroup/Add
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* id?: number
|
||
* name: string
|
||
* parentId: number
|
||
* type: number
|
||
* sort?: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
add_1<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
data: SysGroupRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'SysGroup.add_1', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/sysgroup/List
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* query: {
|
||
* name?: string
|
||
* parentId?: number
|
||
* }
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.[]
|
||
* // [items] end
|
||
* children?: SysGroupVo[]
|
||
* }>
|
||
* ```
|
||
*/
|
||
list_1<
|
||
Config extends Alova2MethodConfig<SysGroupVo[]> & {
|
||
params: {
|
||
query: SysGroupQuery;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<SysGroupVo[], 'SysGroup.list_1', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/sysgroup/GetTree
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.[]
|
||
* // [items] end
|
||
* children?: SysGroupVo[]
|
||
* }>
|
||
* ```
|
||
*/
|
||
getTree<Config extends Alova2MethodConfig<SysGroupVo[]>>(
|
||
config?: Config
|
||
): Alova2Method<SysGroupVo[], 'SysGroup.getTree', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/sysgroup/GetSchoolTree
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.[]
|
||
* // [items] end
|
||
* children?: SysGroupVo[]
|
||
* }>
|
||
* ```
|
||
*/
|
||
getSchoolTree<Config extends Alova2MethodConfig<SysGroupVo[]>>(
|
||
config?: Config
|
||
): Alova2Method<SysGroupVo[], 'SysGroup.getSchoolTree', Config>;
|
||
};
|
||
PushSubscription: {
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/push/Test
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* appId?: number
|
||
* interfacePath?: string
|
||
* // [items] start
|
||
* // [items] end
|
||
* targetIds?: number[]
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Record<string, object>
|
||
* ```
|
||
*/
|
||
test<
|
||
Config extends Alova2MethodConfig<Record<string, object>> & {
|
||
data: PushTestRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<Record<string, object>, 'PushSubscription.test', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/push/Retry/{id}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* id: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
retry<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
pathParams: {
|
||
id: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'PushSubscription.retry', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/push/RecordList
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* query: {
|
||
* appKey?: number
|
||
* interfacePath?: string
|
||
* success?: number
|
||
* startTime?: string
|
||
* endTime?: string
|
||
* }
|
||
* pageQuery: {
|
||
* pageIndex?: number
|
||
* pageSize?: number
|
||
* keyword?: string
|
||
* }
|
||
* sort: {
|
||
* // [items] start
|
||
* // [items] end
|
||
* sort?: string[]
|
||
* }
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = {
|
||
* total?: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* content?: Array<{
|
||
* id?: number
|
||
* subscriberAppKey?: number
|
||
* appName?: string
|
||
* interfacePath?: string
|
||
* interfaceLabel?: string
|
||
* requestUrl?: string
|
||
* signT?: string
|
||
* httpStatus?: number
|
||
* respCode?: number
|
||
* respMsg?: string
|
||
* success?: number
|
||
* attemptNo?: number
|
||
* costMs?: number
|
||
* triggerType?: string
|
||
* createdAt?: string
|
||
* }>
|
||
* pageIndex?: number
|
||
* pageSize?: number
|
||
* totalPages?: number
|
||
* hasNext?: boolean
|
||
* }
|
||
* ```
|
||
*/
|
||
recordList<
|
||
Config extends Alova2MethodConfig<BasePageResultPushRecordListVo> & {
|
||
params: {
|
||
query: PushRecordQuery;
|
||
pageQuery: BasePageQuery;
|
||
sort: Sort;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<BasePageResultPushRecordListVo, 'PushSubscription.recordList', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/push/Download/{id}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* id: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Blob
|
||
* ```
|
||
*/
|
||
download<
|
||
Config extends Alova2MethodConfig<Blob> & {
|
||
pathParams: {
|
||
id: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<Blob, 'PushSubscription.download', Config>;
|
||
};
|
||
Identity: {
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/identity/switch
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* roleId: number
|
||
* schoolId: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = {
|
||
* roleId?: number
|
||
* roleName?: string
|
||
* schoolId?: number
|
||
* schoolName?: string
|
||
* fallback?: boolean
|
||
* }
|
||
* ```
|
||
*/
|
||
switchIdentity<
|
||
Config extends Alova2MethodConfig<IdentityCurrentVo> & {
|
||
data: IdentitySwitchRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<IdentityCurrentVo, 'Identity.switchIdentity', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/identity/current
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = {
|
||
* roleId?: number
|
||
* roleName?: string
|
||
* schoolId?: number
|
||
* schoolName?: string
|
||
* fallback?: boolean
|
||
* }
|
||
* ```
|
||
*/
|
||
current<Config extends Alova2MethodConfig<IdentityCurrentVo>>(
|
||
config?: Config
|
||
): Alova2Method<IdentityCurrentVo, 'Identity.current', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/identity/available
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Array<{
|
||
* roleId?: number
|
||
* roleName?: string
|
||
* schoolId?: number
|
||
* schoolName?: string
|
||
* isMain?: boolean
|
||
* }>
|
||
* ```
|
||
*/
|
||
available<Config extends Alova2MethodConfig<IdentityOptionVo[]>>(
|
||
config?: Config
|
||
): Alova2Method<IdentityOptionVo[], 'Identity.available', Config>;
|
||
};
|
||
GroupAuthz: {
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/groupauthz/SetSchoolApp
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* schid: number
|
||
* appid: number
|
||
* mode: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
setSchoolApp<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
data: SchoolAppAuthzRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'GroupAuthz.setSchoolApp', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/groupauthz/SetGroupModule
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = Array<{
|
||
* groupId: number
|
||
* appId: number
|
||
* moduleId: number
|
||
* mode: number
|
||
* isAll: number
|
||
* }>
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
setGroupModule<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
data: GroupModuleAuthzItem[];
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'GroupAuthz.setGroupModule', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/groupauthz/SaveModulePerms
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* groupId: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* perms?: Array<{
|
||
* moduleId: number
|
||
* inheritFlag?: boolean
|
||
* }>
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
saveModulePerms<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
data: GroupModulePermRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'GroupAuthz.saveModulePerms', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/groupauthz/AssignApps
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* groupId: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* appIds?: number[]
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
assignApps<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
data: GroupAppAssignRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'GroupAuthz.assignApps', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/groupauthz/UserRoles
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* userId: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* allAppFlag?: boolean
|
||
* appId?: number
|
||
* appName?: string
|
||
* disabled?: boolean
|
||
* }>
|
||
* ```
|
||
*/
|
||
userRoles<
|
||
Config extends Alova2MethodConfig<UserRoleVo[]> & {
|
||
params: {
|
||
userId: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<UserRoleVo[], 'GroupAuthz.userRoles', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/groupauthz/UserPermissionTree
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* userId: number
|
||
* groupId?: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* sortNo?: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* apps?: Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* appKey?: number
|
||
* pcIcon?: string
|
||
* sortNo?: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* modules?: Array<{
|
||
* id?: number
|
||
* parentId?: number
|
||
* name?: string
|
||
* customId?: string
|
||
* path?: string
|
||
* level?: number
|
||
* sortNo?: number
|
||
* }>
|
||
* }>
|
||
* }>
|
||
* ```
|
||
*/
|
||
userPermissionTree<
|
||
Config extends Alova2MethodConfig<UserPermissionCategoryVo[]> & {
|
||
params: {
|
||
userId: number;
|
||
groupId?: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<UserPermissionCategoryVo[], 'GroupAuthz.userPermissionTree', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/groupauthz/UserGroupTree
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* userId: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* own?: boolean
|
||
* // [items] start
|
||
* // [cycle] $.[]
|
||
* // [items] end
|
||
* children?: UserGroupNodeVo[]
|
||
* }>
|
||
* ```
|
||
*/
|
||
userGroupTree<
|
||
Config extends Alova2MethodConfig<UserGroupNodeVo[]> & {
|
||
params: {
|
||
userId: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<UserGroupNodeVo[], 'GroupAuthz.userGroupTree', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/groupauthz/SearchUsers
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* keyword: string
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Array<{
|
||
* id?: number
|
||
* account?: string
|
||
* realName?: string
|
||
* isMain?: number
|
||
* groupPath?: string
|
||
* }>
|
||
* ```
|
||
*/
|
||
searchUsers<
|
||
Config extends Alova2MethodConfig<UserPermissionUserVo[]> & {
|
||
params: {
|
||
keyword: string;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<UserPermissionUserVo[], 'GroupAuthz.searchUsers', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/groupauthz/HasModulePerm
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* userId: number
|
||
* moduleId: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = boolean
|
||
* ```
|
||
*/
|
||
hasModulePerm<
|
||
Config extends Alova2MethodConfig<boolean> & {
|
||
params: {
|
||
userId: number;
|
||
moduleId: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<boolean, 'GroupAuthz.hasModulePerm', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/groupauthz/GroupUsers
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* groupId: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Array<{
|
||
* id?: number
|
||
* account?: string
|
||
* realName?: string
|
||
* isMain?: number
|
||
* groupPath?: string
|
||
* }>
|
||
* ```
|
||
*/
|
||
groupUsers<
|
||
Config extends Alova2MethodConfig<UserPermissionUserVo[]> & {
|
||
params: {
|
||
groupId: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<UserPermissionUserVo[], 'GroupAuthz.groupUsers', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/groupauthz/GroupModuleTree
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* groupId: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* appKey?: number
|
||
* pcIcon?: string
|
||
* categoryId?: number
|
||
* sortNo?: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* modules?: Array<{
|
||
* id?: number
|
||
* parentId?: number
|
||
* name?: string
|
||
* customId?: string
|
||
* path?: string
|
||
* level?: number
|
||
* sortNo?: number
|
||
* checked?: boolean
|
||
* inheritFlag?: boolean
|
||
* }>
|
||
* }>
|
||
* ```
|
||
*/
|
||
groupModuleTree<
|
||
Config extends Alova2MethodConfig<GroupAuthzAppVo[]> & {
|
||
params: {
|
||
groupId: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<GroupAuthzAppVo[], 'GroupAuthz.groupModuleTree', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/groupauthz/GroupModuleTreeByCategory
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* groupId: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* // [items] start
|
||
* // [items] end
|
||
* apps?: Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* appKey?: number
|
||
* pcIcon?: string
|
||
* categoryId?: number
|
||
* sortNo?: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* modules?: Array<{
|
||
* id?: number
|
||
* parentId?: number
|
||
* name?: string
|
||
* customId?: string
|
||
* path?: string
|
||
* level?: number
|
||
* sortNo?: number
|
||
* checked?: boolean
|
||
* inheritFlag?: boolean
|
||
* }>
|
||
* }>
|
||
* }>
|
||
* ```
|
||
*/
|
||
groupModuleTreeByCategory<
|
||
Config extends Alova2MethodConfig<GroupAuthzCategoryVo[]> & {
|
||
params: {
|
||
groupId: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<GroupAuthzCategoryVo[], 'GroupAuthz.groupModuleTreeByCategory', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/groupauthz/GroupAppList
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* groupId: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* categoryId?: number
|
||
* appKey?: number
|
||
* pcIcon?: string
|
||
* checked?: boolean
|
||
* }>
|
||
* ```
|
||
*/
|
||
groupAppList<
|
||
Config extends Alova2MethodConfig<GroupAppVo[]> & {
|
||
params: {
|
||
groupId: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<GroupAppVo[], 'GroupAuthz.groupAppList', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/groupauthz/GetSchoolAppId
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* nodeId: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = number[]
|
||
* ```
|
||
*/
|
||
getSchoolAppId<
|
||
Config extends Alova2MethodConfig<number[]> & {
|
||
params: {
|
||
nodeId: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<number[], 'GroupAuthz.getSchoolAppId', Config>;
|
||
};
|
||
Base: {
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/base/UploadFile
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* type?: string
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* file: Blob
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = string
|
||
* ```
|
||
*/
|
||
uploadFile<
|
||
Config extends Alova2MethodConfig<string> & {
|
||
params: {
|
||
type?: string;
|
||
};
|
||
data: {
|
||
file: Blob;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<string, 'Base.uploadFile', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/base/RedirectTo/{id}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* id: string
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = {
|
||
* applicationContext?: {
|
||
* // [cycle] $.applicationContext
|
||
* parent?: ApplicationContext
|
||
* id?: string
|
||
* displayName?: string
|
||
* applicationName?: string
|
||
* autowireCapableBeanFactory?: object
|
||
* startupDate?: number
|
||
* environment?: {
|
||
* // [items] start
|
||
* // [items] end
|
||
* activeProfiles?: string[]
|
||
* // [items] start
|
||
* // [items] end
|
||
* defaultProfiles?: string[]
|
||
* }
|
||
* beanDefinitionCount?: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* beanDefinitionNames?: string[]
|
||
* parentBeanFactory?: object
|
||
* classLoader?: {
|
||
* parent?: {
|
||
* defaultAssertionStatus?: boolean
|
||
* }
|
||
* defaultAssertionStatus?: boolean
|
||
* }
|
||
* }
|
||
* servletContext?: {
|
||
* classLoader?: {
|
||
* parent?: {
|
||
* defaultAssertionStatus?: boolean
|
||
* }
|
||
* defaultAssertionStatus?: boolean
|
||
* }
|
||
* attributeNames?: object
|
||
* majorVersion?: number
|
||
* contextPath?: string
|
||
* // [deprecated]
|
||
* servletNames?: object
|
||
* minorVersion?: number
|
||
* initParameterNames?: object
|
||
* sessionTimeout?: number
|
||
* serverInfo?: string
|
||
* // [deprecated]
|
||
* servlets?: object
|
||
* requestCharacterEncoding?: string
|
||
* filterRegistrations?: Record<
|
||
* string,
|
||
* {
|
||
* // [items] start
|
||
* // [items] end
|
||
* urlPatternMappings?: string[]
|
||
* // [items] start
|
||
* // [items] end
|
||
* servletNameMappings?: string[]
|
||
* name?: string
|
||
* className?: string
|
||
* initParameters?: Record<string, string>
|
||
* }
|
||
* >
|
||
* servletContextName?: string
|
||
* // [items] start
|
||
* // [items] end
|
||
* sessionTrackingModes?: ('COOKIE' | 'URL' | 'SSL')[]
|
||
* effectiveMinorVersion?: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* defaultSessionTrackingModes?: ('COOKIE' | 'URL' | 'SSL')[]
|
||
* servletRegistrations?: Record<
|
||
* string,
|
||
* {
|
||
* // [items] start
|
||
* // [items] end
|
||
* mappings?: string[]
|
||
* runAsRole?: string
|
||
* name?: string
|
||
* className?: string
|
||
* initParameters?: Record<string, string>
|
||
* }
|
||
* >
|
||
* effectiveMajorVersion?: number
|
||
* virtualServerName?: string
|
||
* sessionCookieConfig?: {
|
||
* name?: string
|
||
* path?: string
|
||
* comment?: string
|
||
* domain?: string
|
||
* secure?: boolean
|
||
* maxAge?: number
|
||
* httpOnly?: boolean
|
||
* }
|
||
* jspConfigDescriptor?: {
|
||
* // [items] start
|
||
* // [items] end
|
||
* taglibs?: Array<{
|
||
* taglibURI?: string
|
||
* taglibLocation?: string
|
||
* }>
|
||
* // [items] start
|
||
* // [items] end
|
||
* jspPropertyGroups?: Array<{
|
||
* buffer?: string
|
||
* // [items] start
|
||
* // [items] end
|
||
* urlPatterns?: string[]
|
||
* defaultContentType?: string
|
||
* elIgnored?: string
|
||
* pageEncoding?: string
|
||
* isXml?: string
|
||
* // [items] start
|
||
* // [items] end
|
||
* includeCodas?: string[]
|
||
* trimDirectiveWhitespaces?: string
|
||
* // [items] start
|
||
* // [items] end
|
||
* includePreludes?: string[]
|
||
* scriptingInvalid?: string
|
||
* errorOnUndeclaredNamespace?: string
|
||
* deferredSyntaxAllowedAsLiteral?: string
|
||
* }>
|
||
* }
|
||
* responseCharacterEncoding?: string
|
||
* // [items] start
|
||
* // [items] end
|
||
* effectiveSessionTrackingModes?: ('COOKIE' | 'URL' | 'SSL')[]
|
||
* }
|
||
* contentType?: string
|
||
* requestContextAttribute?: string
|
||
* staticAttributes?: Record<string, object>
|
||
* exposePathVariables?: boolean
|
||
* exposeContextBeansAsAttributes?: boolean
|
||
* // [items] start
|
||
* // [items] end
|
||
* exposedContextBeanNames?: string[]
|
||
* beanName?: string
|
||
* url?: string
|
||
* contextRelative?: boolean
|
||
* http10Compatible?: boolean
|
||
* exposeModelAttributes?: boolean
|
||
* encodingScheme?: string
|
||
* statusCode?:
|
||
* | '100 CONTINUE'
|
||
* | '101 SWITCHING_PROTOCOLS'
|
||
* | '102 PROCESSING'
|
||
* | '103 CHECKPOINT'
|
||
* | '200 OK'
|
||
* | '201 CREATED'
|
||
* | '202 ACCEPTED'
|
||
* | '203 NON_AUTHORITATIVE_INFORMATION'
|
||
* | '204 NO_CONTENT'
|
||
* | '205 RESET_CONTENT'
|
||
* | '206 PARTIAL_CONTENT'
|
||
* | '207 MULTI_STATUS'
|
||
* | '208 ALREADY_REPORTED'
|
||
* | '226 IM_USED'
|
||
* | '300 MULTIPLE_CHOICES'
|
||
* | '301 MOVED_PERMANENTLY'
|
||
* | '302 FOUND'
|
||
* | '302 MOVED_TEMPORARILY'
|
||
* | '303 SEE_OTHER'
|
||
* | '304 NOT_MODIFIED'
|
||
* | '305 USE_PROXY'
|
||
* | '307 TEMPORARY_REDIRECT'
|
||
* | '308 PERMANENT_REDIRECT'
|
||
* | '400 BAD_REQUEST'
|
||
* | '401 UNAUTHORIZED'
|
||
* | '402 PAYMENT_REQUIRED'
|
||
* | '403 FORBIDDEN'
|
||
* | '404 NOT_FOUND'
|
||
* | '405 METHOD_NOT_ALLOWED'
|
||
* | '406 NOT_ACCEPTABLE'
|
||
* | '407 PROXY_AUTHENTICATION_REQUIRED'
|
||
* | '408 REQUEST_TIMEOUT'
|
||
* | '409 CONFLICT'
|
||
* | '410 GONE'
|
||
* | '411 LENGTH_REQUIRED'
|
||
* | '412 PRECONDITION_FAILED'
|
||
* | '413 PAYLOAD_TOO_LARGE'
|
||
* | '413 REQUEST_ENTITY_TOO_LARGE'
|
||
* | '414 URI_TOO_LONG'
|
||
* | '414 REQUEST_URI_TOO_LONG'
|
||
* | '415 UNSUPPORTED_MEDIA_TYPE'
|
||
* | '416 REQUESTED_RANGE_NOT_SATISFIABLE'
|
||
* | '417 EXPECTATION_FAILED'
|
||
* | '418 I_AM_A_TEAPOT'
|
||
* | '419 INSUFFICIENT_SPACE_ON_RESOURCE'
|
||
* | '420 METHOD_FAILURE'
|
||
* | '421 DESTINATION_LOCKED'
|
||
* | '422 UNPROCESSABLE_ENTITY'
|
||
* | '423 LOCKED'
|
||
* | '424 FAILED_DEPENDENCY'
|
||
* | '425 TOO_EARLY'
|
||
* | '426 UPGRADE_REQUIRED'
|
||
* | '428 PRECONDITION_REQUIRED'
|
||
* | '429 TOO_MANY_REQUESTS'
|
||
* | '431 REQUEST_HEADER_FIELDS_TOO_LARGE'
|
||
* | '451 UNAVAILABLE_FOR_LEGAL_REASONS'
|
||
* | '500 INTERNAL_SERVER_ERROR'
|
||
* | '501 NOT_IMPLEMENTED'
|
||
* | '502 BAD_GATEWAY'
|
||
* | '503 SERVICE_UNAVAILABLE'
|
||
* | '504 GATEWAY_TIMEOUT'
|
||
* | '505 HTTP_VERSION_NOT_SUPPORTED'
|
||
* | '506 VARIANT_ALSO_NEGOTIATES'
|
||
* | '507 INSUFFICIENT_STORAGE'
|
||
* | '508 LOOP_DETECTED'
|
||
* | '509 BANDWIDTH_LIMIT_EXCEEDED'
|
||
* | '510 NOT_EXTENDED'
|
||
* | '511 NETWORK_AUTHENTICATION_REQUIRED'
|
||
* expandUriTemplateVariables?: boolean
|
||
* propagateQueryParams?: boolean
|
||
* // [items] start
|
||
* // [items] end
|
||
* hosts?: string[]
|
||
* redirectView?: boolean
|
||
* propagateQueryProperties?: boolean
|
||
* attributes?: Record<string, string>
|
||
* attributesMap?: Record<string, object>
|
||
* attributesCSV?: string
|
||
* }
|
||
* ```
|
||
*/
|
||
RedirectTo<
|
||
Config extends Alova2MethodConfig<RedirectView> & {
|
||
pathParams: {
|
||
id: string;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<RedirectView, 'Base.RedirectTo', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/base/ManualHashCacheDemo
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Record<string, object>
|
||
* ```
|
||
*/
|
||
manualHashCacheDemo<Config extends Alova2MethodConfig<Record<string, object>>>(
|
||
config?: Config
|
||
): Alova2Method<Record<string, object>, 'Base.manualHashCacheDemo', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/base/GetUserInfo
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = object
|
||
* ```
|
||
*/
|
||
getUserInfo<Config extends Alova2MethodConfig<object>>(
|
||
config?: Config
|
||
): Alova2Method<object, 'Base.getUserInfo', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/base/GetSysDict
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Record<string, object>
|
||
* ```
|
||
*/
|
||
getSysDict<Config extends Alova2MethodConfig<Record<string, object>>>(
|
||
config?: Config
|
||
): Alova2Method<Record<string, object>, 'Base.getSysDict', Config>;
|
||
};
|
||
AppRole: {
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/approle/SaveUserRoles
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* userId: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* roleIds?: number[]
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
saveUserRoles<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
data: UserAppRoleBindRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'AppRole.saveUserRoles', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/approle/SaveRoleUsers
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* roleId: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* userIds?: number[]
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
saveRoleUsers<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
data: AppRoleUserBindRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'AppRole.saveRoleUsers', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/approle/SaveRoleModules
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* roleId: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* moduleIds?: number[]
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
saveRoleModules<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
data: AppRoleModuleAssignRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'AppRole.saveRoleModules', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/approle/RoleEdit/{id}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* id: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* id: number
|
||
* name: string
|
||
* appId?: number
|
||
* allAppFlag: boolean
|
||
* remark?: string
|
||
* disabled?: boolean
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
roleEdit<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
pathParams: {
|
||
id: number;
|
||
};
|
||
data: SysAppRoleRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'AppRole.roleEdit', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/approle/RoleDelete/{id}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* id: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
roleDelete<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
pathParams: {
|
||
id: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'AppRole.roleDelete', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/approle/RoleAdd
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* id: number
|
||
* name: string
|
||
* appId?: number
|
||
* allAppFlag: boolean
|
||
* remark?: string
|
||
* disabled?: boolean
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
roleAdd<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
data: SysAppRoleRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'AppRole.roleAdd', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/approle/RemoveRoleUser
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* roleId: number
|
||
* userId: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
removeRoleUser<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
params: {
|
||
roleId: number;
|
||
userId: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'AppRole.removeRoleUser', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/approle/RoleUsers
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* roleId: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Array<{
|
||
* id?: number
|
||
* account?: string
|
||
* realName?: string
|
||
* }>
|
||
* ```
|
||
*/
|
||
roleUsers<
|
||
Config extends Alova2MethodConfig<AppRoleUserVo[]> & {
|
||
params: {
|
||
roleId: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<AppRoleUserVo[], 'AppRole.roleUsers', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/approle/RoleModuleTree
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* roleId: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* appKey?: number
|
||
* pcIcon?: string
|
||
* sortNo?: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* modules?: Array<{
|
||
* id?: number
|
||
* parentId?: number
|
||
* name?: string
|
||
* customId?: string
|
||
* path?: string
|
||
* level?: number
|
||
* sortNo?: number
|
||
* checked?: boolean
|
||
* }>
|
||
* }>
|
||
* ```
|
||
*/
|
||
roleModuleTree<
|
||
Config extends Alova2MethodConfig<AppRoleAuthzAppVo[]> & {
|
||
params: {
|
||
roleId: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<AppRoleAuthzAppVo[], 'AppRole.roleModuleTree', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/approle/RoleList
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* query: {
|
||
* name?: string
|
||
* appId?: number
|
||
* allAppFlag?: boolean
|
||
* disabled?: boolean
|
||
* }
|
||
* pageQuery: {
|
||
* pageIndex?: number
|
||
* pageSize?: number
|
||
* keyword?: string
|
||
* }
|
||
* sort: {
|
||
* // [items] start
|
||
* // [items] end
|
||
* sort?: string[]
|
||
* }
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = {
|
||
* total?: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* content?: Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* appId?: number
|
||
* appName?: string
|
||
* allAppFlag?: boolean
|
||
* remark?: string
|
||
* disabled?: boolean
|
||
* }>
|
||
* pageIndex?: number
|
||
* pageSize?: number
|
||
* totalPages?: number
|
||
* hasNext?: boolean
|
||
* }
|
||
* ```
|
||
*/
|
||
roleList<
|
||
Config extends Alova2MethodConfig<BasePageResultSysAppRoleVo> & {
|
||
params: {
|
||
query: SysAppRoleQuery;
|
||
pageQuery: BasePageQuery;
|
||
sort: Sort;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<BasePageResultSysAppRoleVo, 'AppRole.roleList', Config>;
|
||
};
|
||
AppSettings: {
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/app/SavePushSetting/{id}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* id: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* pushBaseUrl?: string
|
||
* pushEnabled?: number
|
||
* pushEventTypes?: string
|
||
* pushSchoolIds?: string
|
||
* pushRoleIds?: string
|
||
* pushSecret?: string
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
savePushSetting<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
pathParams: {
|
||
id: number;
|
||
};
|
||
data: PushSettingRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'AppSettings.savePushSetting', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/app/ResetAppSecret/{id}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* id: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = string
|
||
* ```
|
||
*/
|
||
resetAppSecret<
|
||
Config extends Alova2MethodConfig<string> & {
|
||
pathParams: {
|
||
id: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<string, 'AppSettings.resetAppSecret', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/app/RefreshSignKeys
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Record<string, object>
|
||
* ```
|
||
*/
|
||
refreshSignKeys<Config extends Alova2MethodConfig<Record<string, object>>>(
|
||
config?: Config
|
||
): Alova2Method<Record<string, object>, 'AppSettings.refreshSignKeys', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/app/EditType/{id}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* id: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* id: number
|
||
* name: string
|
||
* sortNo?: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
editType<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
pathParams: {
|
||
id: number;
|
||
};
|
||
data: AppCategoryRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'AppSettings.editType', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/app/EditModule/{id}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* id: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* id: number
|
||
* appId: number
|
||
* parentId?: number
|
||
* name: string
|
||
* customId: string
|
||
* path?: string
|
||
* sortNo?: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
editModule<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
pathParams: {
|
||
id: number;
|
||
};
|
||
data: AppModuleRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'AppSettings.editModule', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/app/EditApp/{id}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* id: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* id: number
|
||
* name: string
|
||
* categoryId: number
|
||
* desc?: string
|
||
* // [items] start
|
||
* // [items] end
|
||
* clients?: number[]
|
||
* pcUrl?: string
|
||
* pcIcon?: string
|
||
* appUrl?: string
|
||
* appIcon?: string
|
||
* officialAccountUrl?: string
|
||
* dingtalkUrl?: string
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
editApp<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
pathParams: {
|
||
id: number;
|
||
};
|
||
data: ApplicationInfoRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'AppSettings.editApp', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/app/DeleteType/{id}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* id: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
deleteType<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
pathParams: {
|
||
id: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'AppSettings.deleteType', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/app/DeleteModule/{id}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* id: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
deleteModule<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
pathParams: {
|
||
id: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'AppSettings.deleteModule', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/app/DeleteApp/{id}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* id: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
deleteApp<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
pathParams: {
|
||
id: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'AppSettings.deleteApp', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/app/AppTypeSort
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = number[]
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
appTypeSort<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
data: number[];
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'AppSettings.appTypeSort', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/app/AppSort
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = number[]
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
appSort<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
data: number[];
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'AppSettings.appSort', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/app/AddType
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* id: number
|
||
* name: string
|
||
* sortNo?: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
addType<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
data: AppCategoryRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'AppSettings.addType', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/app/AddModule
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* id: number
|
||
* appId: number
|
||
* parentId?: number
|
||
* name: string
|
||
* customId: string
|
||
* path?: string
|
||
* sortNo?: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
addModule<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
data: AppModuleRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'AppSettings.addModule', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /api/app/AddApp
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* id: number
|
||
* name: string
|
||
* categoryId: number
|
||
* desc?: string
|
||
* // [items] start
|
||
* // [items] end
|
||
* clients?: number[]
|
||
* pcUrl?: string
|
||
* pcIcon?: string
|
||
* appUrl?: string
|
||
* appIcon?: string
|
||
* officialAccountUrl?: string
|
||
* dingtalkUrl?: string
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
addApp<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
data: ApplicationInfoRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'AppSettings.addApp', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/app/ModuleList
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* query: {
|
||
* appId?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* }
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Array<{
|
||
* id?: number
|
||
* appId?: number
|
||
* parentId?: number
|
||
* name?: string
|
||
* customId?: string
|
||
* path?: string
|
||
* level?: number
|
||
* sortNo?: number
|
||
* // [items] start
|
||
* // [cycle] $.[]
|
||
* // [items] end
|
||
* children?: AppModuleVo[]
|
||
* }>
|
||
* ```
|
||
*/
|
||
moduleList<
|
||
Config extends Alova2MethodConfig<AppModuleVo[]> & {
|
||
params: {
|
||
query: AppModuleQuery;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<AppModuleVo[], 'AppSettings.moduleList', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/app/GetPushSetting/{id}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* id: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = {
|
||
* id?: number
|
||
* appKey?: number
|
||
* name?: string
|
||
* pushBaseUrl?: string
|
||
* pushEnabled?: number
|
||
* pushEventTypes?: string
|
||
* pushSchoolIds?: string
|
||
* pushRoleIds?: string
|
||
* pushSecret?: string
|
||
* }
|
||
* ```
|
||
*/
|
||
getPushSetting<
|
||
Config extends Alova2MethodConfig<PushSettingVo> & {
|
||
pathParams: {
|
||
id: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<PushSettingVo, 'AppSettings.getPushSetting', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/app/AppTypeList
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* query: {
|
||
* name?: string
|
||
* }
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* sortNo?: number
|
||
* }>
|
||
* ```
|
||
*/
|
||
appTypeList<
|
||
Config extends Alova2MethodConfig<AppCategoryVo[]> & {
|
||
params: {
|
||
query: AppCategoryQuery;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<AppCategoryVo[], 'AppSettings.appTypeList', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/app/AppSortList
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* categoryId: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* sortNo?: number
|
||
* }>
|
||
* ```
|
||
*/
|
||
appSortList<
|
||
Config extends Alova2MethodConfig<ApplicationInfoSortVo[]> & {
|
||
params: {
|
||
categoryId: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<ApplicationInfoSortVo[], 'AppSettings.appSortList', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/app/AppList
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* query: {
|
||
* name?: string
|
||
* categoryId?: number
|
||
* }
|
||
* pageQuery: {
|
||
* pageIndex?: number
|
||
* pageSize?: number
|
||
* keyword?: string
|
||
* }
|
||
* sort: {
|
||
* // [items] start
|
||
* // [items] end
|
||
* sort?: string[]
|
||
* }
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = {
|
||
* total?: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* content?: Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* categoryId?: number
|
||
* sortNo?: number
|
||
* desc?: string
|
||
* appKey?: number
|
||
* appSecret?: string
|
||
* // [items] start
|
||
* // [items] end
|
||
* clients?: number[]
|
||
* pcUrl?: string
|
||
* pcIcon?: string
|
||
* appUrl?: string
|
||
* appIcon?: string
|
||
* officialAccountUrl?: string
|
||
* dingtalkUrl?: string
|
||
* }>
|
||
* pageIndex?: number
|
||
* pageSize?: number
|
||
* totalPages?: number
|
||
* hasNext?: boolean
|
||
* }
|
||
* ```
|
||
*/
|
||
appList<
|
||
Config extends Alova2MethodConfig<BasePageResultApplicationInfoVo> & {
|
||
params: {
|
||
query: ApplicationInfoQuery;
|
||
pageQuery: BasePageQuery;
|
||
sort: Sort;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<BasePageResultApplicationInfoVo, 'AppSettings.appList', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /api/app/AppAuthzList
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* // [items] start
|
||
* // [items] end
|
||
* app?: Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* }>
|
||
* }>
|
||
* ```
|
||
*/
|
||
appAuthzList<Config extends Alova2MethodConfig<AppAuthzCategoryVo[]>>(
|
||
config?: Config
|
||
): Alova2Method<AppAuthzCategoryVo[], 'AppSettings.appAuthzList', Config>;
|
||
};
|
||
User: {
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /oapi/user/moveToGroup
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* userId: number
|
||
* groupId: number
|
||
* schoolId: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = {
|
||
* id?: number
|
||
* account?: string
|
||
* name?: string
|
||
* idcard?: string
|
||
* phone?: string
|
||
* email?: string
|
||
* gender?: number
|
||
* profilePicture?: string
|
||
* type?: number
|
||
* status?: number
|
||
* dept?: {
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.dept
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }
|
||
* school?: {
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.school
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }
|
||
* bureau?: {
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.bureau
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }
|
||
* // [items] start
|
||
* // [items] end
|
||
* groups?: Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.groups.[]
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }>
|
||
* // [items] start
|
||
* // [items] end
|
||
* roleIds?: number[]
|
||
* currentRoleId?: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* schools?: Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.schools.[]
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }>
|
||
* }
|
||
* ```
|
||
*/
|
||
moveToGroup<
|
||
Config extends Alova2MethodConfig<BoaUser> & {
|
||
data: SysUserMoveRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<BoaUser, 'User.moveToGroup', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /oapi/user/edit/{id}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* id: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* id: number
|
||
* groupId: number
|
||
* account: string
|
||
* password: string
|
||
* confirmPassword?: string
|
||
* realName?: string
|
||
* phone?: string
|
||
* birthday?: string
|
||
* idcard?: string
|
||
* email?: string
|
||
* gender?: number
|
||
* profilePicture?: string
|
||
* // [items] start
|
||
* // [items] end
|
||
* roles?: number[]
|
||
* disabled?: number
|
||
* expired?: boolean
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = {
|
||
* id?: number
|
||
* account?: string
|
||
* name?: string
|
||
* idcard?: string
|
||
* phone?: string
|
||
* email?: string
|
||
* gender?: number
|
||
* profilePicture?: string
|
||
* type?: number
|
||
* status?: number
|
||
* dept?: {
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.dept
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }
|
||
* school?: {
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.school
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }
|
||
* bureau?: {
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.bureau
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }
|
||
* // [items] start
|
||
* // [items] end
|
||
* groups?: Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.groups.[]
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }>
|
||
* // [items] start
|
||
* // [items] end
|
||
* roleIds?: number[]
|
||
* currentRoleId?: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* schools?: Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.schools.[]
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }>
|
||
* }
|
||
* ```
|
||
*/
|
||
edit_2<
|
||
Config extends Alova2MethodConfig<BoaUser> & {
|
||
pathParams: {
|
||
id: number;
|
||
};
|
||
data: SysUserRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<BoaUser, 'User.edit_2', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /oapi/user/delete/{id}/{groupId}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* id: number
|
||
* groupId: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
delete_1<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
pathParams: {
|
||
id: number;
|
||
groupId: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'User.delete_1', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /oapi/user/batchAdd
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = Array<{
|
||
* id: number
|
||
* groupId: number
|
||
* account: string
|
||
* password: string
|
||
* confirmPassword?: string
|
||
* realName?: string
|
||
* phone?: string
|
||
* birthday?: string
|
||
* idcard?: string
|
||
* email?: string
|
||
* gender?: number
|
||
* profilePicture?: string
|
||
* // [items] start
|
||
* // [items] end
|
||
* roles?: number[]
|
||
* disabled?: number
|
||
* expired?: boolean
|
||
* }>
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Array<{
|
||
* id?: number
|
||
* account?: string
|
||
* name?: string
|
||
* idcard?: string
|
||
* phone?: string
|
||
* email?: string
|
||
* gender?: number
|
||
* profilePicture?: string
|
||
* type?: number
|
||
* status?: number
|
||
* dept?: {
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.[].dept
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }
|
||
* school?: {
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.[].school
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }
|
||
* bureau?: {
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.[].bureau
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }
|
||
* // [items] start
|
||
* // [items] end
|
||
* groups?: Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.[].groups.[]
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }>
|
||
* // [items] start
|
||
* // [items] end
|
||
* roleIds?: number[]
|
||
* currentRoleId?: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* schools?: Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.[].schools.[]
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }>
|
||
* }>
|
||
* ```
|
||
*/
|
||
batchAdd_1<
|
||
Config extends Alova2MethodConfig<BoaUser[]> & {
|
||
data: SysUserRequest[];
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<BoaUser[], 'User.batchAdd_1', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /oapi/user/add
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* id: number
|
||
* groupId: number
|
||
* account: string
|
||
* password: string
|
||
* confirmPassword?: string
|
||
* realName?: string
|
||
* phone?: string
|
||
* birthday?: string
|
||
* idcard?: string
|
||
* email?: string
|
||
* gender?: number
|
||
* profilePicture?: string
|
||
* // [items] start
|
||
* // [items] end
|
||
* roles?: number[]
|
||
* disabled?: number
|
||
* expired?: boolean
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = {
|
||
* id?: number
|
||
* account?: string
|
||
* name?: string
|
||
* idcard?: string
|
||
* phone?: string
|
||
* email?: string
|
||
* gender?: number
|
||
* profilePicture?: string
|
||
* type?: number
|
||
* status?: number
|
||
* dept?: {
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.dept
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }
|
||
* school?: {
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.school
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }
|
||
* bureau?: {
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.bureau
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }
|
||
* // [items] start
|
||
* // [items] end
|
||
* groups?: Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.groups.[]
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }>
|
||
* // [items] start
|
||
* // [items] end
|
||
* roleIds?: number[]
|
||
* currentRoleId?: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* schools?: Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.schools.[]
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }>
|
||
* }
|
||
* ```
|
||
*/
|
||
add_2<
|
||
Config extends Alova2MethodConfig<BoaUser> & {
|
||
data: SysUserRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<BoaUser, 'User.add_2', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /oapi/user/modules
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* userId: number
|
||
* schId?: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Array<{
|
||
* id?: number
|
||
* parentId?: number
|
||
* customId?: string
|
||
* name?: string
|
||
* path?: string
|
||
* level?: number
|
||
* sortNo?: number
|
||
* icon?: string
|
||
* }>
|
||
* ```
|
||
*/
|
||
modules<
|
||
Config extends Alova2MethodConfig<BoaModule[]> & {
|
||
params: {
|
||
userId: number;
|
||
schId?: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<BoaModule[], 'User.modules', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /oapi/user/byPhone
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* phone: string
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = {
|
||
* id?: number
|
||
* account?: string
|
||
* name?: string
|
||
* idcard?: string
|
||
* phone?: string
|
||
* email?: string
|
||
* gender?: number
|
||
* profilePicture?: string
|
||
* type?: number
|
||
* status?: number
|
||
* dept?: {
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.dept
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }
|
||
* school?: {
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.school
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }
|
||
* bureau?: {
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.bureau
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }
|
||
* // [items] start
|
||
* // [items] end
|
||
* groups?: Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.groups.[]
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }>
|
||
* // [items] start
|
||
* // [items] end
|
||
* roleIds?: number[]
|
||
* currentRoleId?: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* schools?: Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.schools.[]
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }>
|
||
* }
|
||
* ```
|
||
*/
|
||
byPhone<
|
||
Config extends Alova2MethodConfig<BoaUser> & {
|
||
params: {
|
||
phone: string;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<BoaUser, 'User.byPhone', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /oapi/user/byLoginName
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* loginName: string
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = {
|
||
* id?: number
|
||
* account?: string
|
||
* name?: string
|
||
* idcard?: string
|
||
* phone?: string
|
||
* email?: string
|
||
* gender?: number
|
||
* profilePicture?: string
|
||
* type?: number
|
||
* status?: number
|
||
* dept?: {
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.dept
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }
|
||
* school?: {
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.school
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }
|
||
* bureau?: {
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.bureau
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }
|
||
* // [items] start
|
||
* // [items] end
|
||
* groups?: Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.groups.[]
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }>
|
||
* // [items] start
|
||
* // [items] end
|
||
* roleIds?: number[]
|
||
* currentRoleId?: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* schools?: Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.schools.[]
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }>
|
||
* }
|
||
* ```
|
||
*/
|
||
byLoginName<
|
||
Config extends Alova2MethodConfig<BoaUser> & {
|
||
params: {
|
||
loginName: string;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<BoaUser, 'User.byLoginName', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /oapi/user/byId
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* id: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = {
|
||
* id?: number
|
||
* account?: string
|
||
* name?: string
|
||
* idcard?: string
|
||
* phone?: string
|
||
* email?: string
|
||
* gender?: number
|
||
* profilePicture?: string
|
||
* type?: number
|
||
* status?: number
|
||
* dept?: {
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.dept
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }
|
||
* school?: {
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.school
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }
|
||
* bureau?: {
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.bureau
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }
|
||
* // [items] start
|
||
* // [items] end
|
||
* groups?: Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.groups.[]
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }>
|
||
* // [items] start
|
||
* // [items] end
|
||
* roleIds?: number[]
|
||
* currentRoleId?: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* schools?: Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.schools.[]
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }>
|
||
* }
|
||
* ```
|
||
*/
|
||
byId<
|
||
Config extends Alova2MethodConfig<BoaUser> & {
|
||
params: {
|
||
id: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<BoaUser, 'User.byId', Config>;
|
||
};
|
||
Group: {
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /oapi/group/edit/{id}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* id: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* id?: number
|
||
* name: string
|
||
* parentId: number
|
||
* type: number
|
||
* sort?: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = {
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }
|
||
* ```
|
||
*/
|
||
edit_3<
|
||
Config extends Alova2MethodConfig<BoaGroup> & {
|
||
pathParams: {
|
||
id: number;
|
||
};
|
||
data: SysGroupRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<BoaGroup, 'Group.edit_3', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /oapi/group/delete/{id}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* id: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = null
|
||
* ```
|
||
*/
|
||
delete_2<
|
||
Config extends Alova2MethodConfig<null> & {
|
||
pathParams: {
|
||
id: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<null, 'Group.delete_2', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /oapi/group/batchAdd
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* pid: number
|
||
* type: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* items: Array<{
|
||
* name: string
|
||
* }>
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.[]
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }>
|
||
* ```
|
||
*/
|
||
batchAdd_2<
|
||
Config extends Alova2MethodConfig<BoaGroup[]> & {
|
||
data: SysGroupBatchRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<BoaGroup[], 'Group.batchAdd_2', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [POST]
|
||
*
|
||
* **path:** /oapi/group/add
|
||
*
|
||
* ---
|
||
*
|
||
* **RequestBody**
|
||
* ```ts
|
||
* type RequestBody = {
|
||
* id?: number
|
||
* name: string
|
||
* parentId: number
|
||
* type: number
|
||
* sort?: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = {
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }
|
||
* ```
|
||
*/
|
||
add_3<
|
||
Config extends Alova2MethodConfig<BoaGroup> & {
|
||
data: SysGroupRequest;
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<BoaGroup, 'Group.add_3', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /oapi/group/tree
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = {
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }
|
||
* ```
|
||
*/
|
||
tree<Config extends Alova2MethodConfig<BoaGroup>>(config?: Config): Alova2Method<BoaGroup, 'Group.tree', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /oapi/group/list
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* ids: string
|
||
* withSub?: boolean
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Array<{
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $.[]
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }>
|
||
* ```
|
||
*/
|
||
list_2<
|
||
Config extends Alova2MethodConfig<BoaGroup[]> & {
|
||
params: {
|
||
ids: string;
|
||
withSub?: boolean;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<BoaGroup[], 'Group.list_2', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /oapi/group/byId
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* groupId: number
|
||
* withSub?: boolean
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = {
|
||
* id?: number
|
||
* name?: string
|
||
* parentId?: number
|
||
* type?: number
|
||
* sort?: number
|
||
* // [items] start
|
||
* // [cycle] $
|
||
* // [items] end
|
||
* children?: BoaGroup[]
|
||
* }
|
||
* ```
|
||
*/
|
||
byId_1<
|
||
Config extends Alova2MethodConfig<BoaGroup> & {
|
||
params: {
|
||
groupId: number;
|
||
withSub?: boolean;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<BoaGroup, 'Group.byId_1', Config>;
|
||
};
|
||
SysOperationLog: {
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET] 操作日志分页查询
|
||
*
|
||
* **path:** /api/oplog/List
|
||
*
|
||
* ---
|
||
*
|
||
* **Query Parameters**
|
||
* ```ts
|
||
* type QueryParameters = {
|
||
* query: {
|
||
* logLevel?: number
|
||
* userId?: number
|
||
* username?: string
|
||
* requestUri?: string
|
||
* requestIp?: string
|
||
* operationType?: string
|
||
* statusCode?: number
|
||
* success?: boolean
|
||
* keyword?: string
|
||
* startTime?: string
|
||
* endTime?: string
|
||
* }
|
||
* pageQuery: {
|
||
* pageIndex?: number
|
||
* pageSize?: number
|
||
* keyword?: string
|
||
* }
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = {
|
||
* total?: number
|
||
* // [items] start
|
||
* // [items] end
|
||
* content?: Array<{
|
||
* id?: number
|
||
* logLevel?: number
|
||
* userId?: number
|
||
* username?: string
|
||
* requestIp?: string
|
||
* requestUri?: string
|
||
* requestMethod?: string
|
||
* operationType?: string
|
||
* classMethod?: string
|
||
* requestParams?: string
|
||
* statusCode?: number
|
||
* costTime?: number
|
||
* userAgent?: string
|
||
* errorMsg?: string
|
||
* createTime?: string
|
||
* }>
|
||
* pageIndex?: number
|
||
* pageSize?: number
|
||
* totalPages?: number
|
||
* hasNext?: boolean
|
||
* }
|
||
* ```
|
||
*/
|
||
operationLogList<
|
||
Config extends Alova2MethodConfig<BasePageResultSysOperationLogListVo> & {
|
||
params: {
|
||
query: SysOperationLogQuery;
|
||
pageQuery: BasePageQuery;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<BasePageResultSysOperationLogListVo, 'SysOperationLog.operationLogList', Config>;
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET] 下载日志响应原文
|
||
*
|
||
* **path:** /api/oplog/Download/{id}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* id: number
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Blob
|
||
* ```
|
||
*/
|
||
operationLogDownload<
|
||
Config extends Alova2MethodConfig<Blob> & {
|
||
pathParams: {
|
||
id: number;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<Blob, 'SysOperationLog.operationLogDownload', Config>;
|
||
};
|
||
SignKeyInternal: {
|
||
/**
|
||
* ---
|
||
*
|
||
* [GET]
|
||
*
|
||
* **path:** /oapi/internal/sign-key/{appId}
|
||
*
|
||
* ---
|
||
*
|
||
* **Path Parameters**
|
||
* ```ts
|
||
* type PathParameters = {
|
||
* appId: string
|
||
* }
|
||
* ```
|
||
*
|
||
* ---
|
||
*
|
||
* **Response**
|
||
* ```ts
|
||
* type Response = Record<string, object>
|
||
* ```
|
||
*/
|
||
signKey<
|
||
Config extends Alova2MethodConfig<Record<string, object>> & {
|
||
pathParams: {
|
||
appId: string;
|
||
};
|
||
}
|
||
>(
|
||
config: Config
|
||
): Alova2Method<Record<string, object>, 'SignKeyInternal.signKey', Config>;
|
||
};
|
||
}
|
||
|
||
var Apis: Apis;
|
||
}
|