/* tslint:disable */ /* eslint-disable */ /** * 用户中心接口文档 - version 0.0.1-SNAPSHOT * * Demo project for Spring Boot * * OpenAPI version: 3.0.0 * * Contact: * * 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 ApplicationInfoRequest { appIcon?: string; appUrl?: string; categoryId?: number; clients?: number[]; desc?: string; dingtalkUrl?: string; id?: number; name?: string; officialAccountUrl?: string; pcIcon?: string; pcUrl?: string; } export interface AppModuleRequest { appId?: number; customId?: string; id?: number; name?: string; parentId?: number; path?: string; sortNo?: number; } export interface AppCategoryRequest { id?: number; name?: string; sortNo?: number; } export interface SysAppRoleRequest { allAppFlag?: boolean; appId?: number; disabled?: boolean; id?: number; name?: string; remark?: string; } export interface AppRoleModuleAssignRequest { moduleIds?: number[]; roleId?: number; } export interface AppRoleUserBindRequest { roleId?: number; userIds?: number[]; } export interface UserAppRoleBindRequest { roleIds?: number[]; userId?: number; } export interface GroupAppAssignRequest { appIds?: number[]; groupId?: number; } export interface ModulePermItem { inheritFlag?: boolean; moduleId?: number; } export interface GroupModulePermRequest { groupId?: number; perms?: ModulePermItem[]; } export interface GroupModuleAuthzItem { appId?: number; groupId?: number; isAll?: number; mode?: number; moduleId?: number; } export interface SchoolAppAuthzRequest { appid?: number; mode?: number; schid?: number; } export interface SysGroupRequest { id?: number; name?: string; parentId?: number; sort?: number; type?: number; } export interface _ { /** * 子组名称 */ name: string; } export interface _2 { /** * 待新增的子组列表,每一项仅需提供 name */ items: _[]; /** * 父组ID(挂载点,必须存在) */ pid: number; /** * 组类型(GroupTypeEnum.key,如 4=班级组) */ type: number; } export interface SysUserRequest { account?: string; birthday?: string; confirmPassword?: string; disabled?: number; expired?: boolean; groupId?: number; id?: number; idcard?: string; password?: string; phone?: string; profilePicture?: string; realName?: string; roles?: number[]; } export interface AppItem { id?: number; name?: string; } export interface AppAuthzCategoryVo { app?: AppItem[]; id?: number; name?: string; } export interface SysGroupVo { children?: SysGroupVo[]; id?: number; name?: string; sort?: number; type?: number; } export interface ApplicationInfoVo { appIcon?: string; appKey?: number; appSecret?: string; appUrl?: string; categoryId?: number; clients?: number[]; desc?: string; dingtalkUrl?: string; id?: number; name?: string; officialAccountUrl?: string; pcIcon?: string; pcUrl?: string; sortNo?: number; } export interface BasePageResultOfApplicationInfoVo { content?: ApplicationInfoVo[]; hasNext?: boolean; pageIndex?: number; pageSize?: number; total?: number; totalPages?: number; } export interface ApplicationInfoSortVo { id?: number; name?: string; sortNo?: number; } export interface AppCategoryVo { id?: number; name?: string; sortNo?: number; } export interface AppModuleVo { appId?: number; children?: AppModuleVo[]; customId?: string; id?: number; level?: number; name?: string; parentId?: number; path?: string; sortNo?: number; } export interface SysAppRoleVo { allAppFlag?: boolean; appId?: number; appName?: string; disabled?: boolean; id?: number; name?: string; remark?: string; } export interface BasePageResultOfSysAppRoleVo { content?: SysAppRoleVo[]; hasNext?: boolean; pageIndex?: number; pageSize?: number; total?: number; totalPages?: number; } export interface AppRoleAuthzModuleVo { checked?: boolean; children?: AppRoleAuthzModuleVo[]; customId?: string; id?: number; level?: number; name?: string; parentId?: number; path?: string; sortNo?: number; } export interface AppRoleAuthzAppVo { appKey?: number; id?: number; modules?: AppRoleAuthzModuleVo[]; name?: string; pcIcon?: string; sortNo?: number; } export interface AppRoleUserVo { account?: string; id?: number; realName?: string; } export type AutowireCapableBeanFactory = object; export interface ClassLoader { parent?: ClassLoader; } export interface Environment { activeProfiles?: string[]; defaultProfiles?: string[]; } export type BeanFactory = object; export interface ApplicationContext { applicationName?: string; /** * AutowireCapableBeanFactory * --- */ autowireCapableBeanFactory?: AutowireCapableBeanFactory; beanDefinitionCount?: number; beanDefinitionNames?: string[]; /** * ClassLoader * --- */ classLoader?: ClassLoader; displayName?: string; /** * Environment * --- */ environment?: Environment; id?: string; parent?: ApplicationContext; /** * BeanFactory * --- */ parentBeanFactory?: BeanFactory; startupDate?: number; } export interface RedirectView { /** * ApplicationContext * --- */ applicationContext?: ApplicationContext; attributesMap?: object; beanName?: string; contentType?: string; exposePathVariables?: boolean; hosts?: string[]; propagateQueryProperties?: boolean; redirectView?: boolean; requestContextAttribute?: string; staticAttributes?: object; url?: string; } export interface GroupAppVo { appKey?: number; categoryId?: number; checked?: boolean; id?: number; name?: string; pcIcon?: string; } export interface GroupAuthzModuleVo { checked?: boolean; children?: GroupAuthzModuleVo[]; customId?: string; id?: number; inheritFlag?: boolean; level?: number; name?: string; parentId?: number; path?: string; sortNo?: number; } export interface GroupAuthzAppVo { appKey?: number; categoryId?: number; id?: number; modules?: GroupAuthzModuleVo[]; name?: string; pcIcon?: string; sortNo?: number; } export interface GroupAuthzCategoryVo { apps?: GroupAuthzAppVo[]; id?: number; name?: string; } export interface UserPermissionUserVo { account?: string; groupPath?: string; id?: number; isMain?: number; realName?: string; } export interface UserGroupNodeVo { children?: UserGroupNodeVo[]; id?: number; name?: string; own?: boolean; } export interface UserPermissionModuleVo { children?: UserPermissionModuleVo[]; customId?: string; id?: number; level?: number; name?: string; parentId?: number; path?: string; sortNo?: number; } export interface UserPermissionAppVo { appKey?: number; id?: number; modules?: UserPermissionModuleVo[]; name?: string; pcIcon?: string; sortNo?: number; } export interface UserPermissionCategoryVo { apps?: UserPermissionAppVo[]; id?: number; name?: string; sortNo?: number; } export interface UserRoleVo { allAppFlag?: boolean; appId?: number; appName?: string; disabled?: boolean; id?: number; name?: string; } export interface SysUserVo { account?: string; birthday?: string; createTime?: string; disabled?: number; expired?: boolean; id?: number; idcard?: string; phone?: string; profilePicture?: string; realName?: string; roles?: number[]; updateTime?: string; } export interface BasePageResultOfSysUserVo { content?: SysUserVo[]; hasNext?: boolean; pageIndex?: number; pageSize?: number; total?: number; totalPages?: number; } declare global { interface Apis { AppSettings: { /** * --- * * [POST] addApp * * **path:** /api/app/AddApp * * --- * * **RequestBody** * ```ts * type RequestBody = { * appIcon?: string * appUrl?: string * categoryId?: number * // [items] start * // [items] end * clients?: number[] * desc?: string * dingtalkUrl?: string * id?: number * name?: string * officialAccountUrl?: string * pcIcon?: string * pcUrl?: string * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ addApp< Config extends Alova2MethodConfig & { data: ApplicationInfoRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] addModule * * **path:** /api/app/AddModule * * --- * * **RequestBody** * ```ts * type RequestBody = { * appId?: number * customId?: string * id?: number * name?: string * parentId?: number * path?: string * sortNo?: number * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ addModule< Config extends Alova2MethodConfig & { data: AppModuleRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] addType * * **path:** /api/app/AddType * * --- * * **RequestBody** * ```ts * type RequestBody = { * id?: number * name?: string * sortNo?: number * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ addType< Config extends Alova2MethodConfig & { data: AppCategoryRequest; } >( config: Config ): Alova2Method; /** * --- * * [GET] appAuthzList * * **path:** /api/app/AppAuthzList * * --- * * **Response** * ```ts * type Response = Array<{ * // [items] start * // [title] AppItem * // [items] end * app?: Array<{ * id?: number * name?: string * }> * id?: number * name?: string * }> * ``` */ appAuthzList>( config?: Config ): Alova2Method; /** * --- * * [GET] appList * * **path:** /api/app/AppList * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * categoryId?: number * name?: string * pageIndex?: number * pageSize?: number * sorted?: boolean * unsorted?: boolean * } * ``` * * --- * * **Response** * ```ts * type Response = { * // [items] start * // [title] ApplicationInfoVo * // [items] end * content?: Array<{ * appIcon?: string * appKey?: number * appSecret?: string * appUrl?: string * categoryId?: number * // [items] start * // [items] end * clients?: number[] * desc?: string * dingtalkUrl?: string * id?: number * name?: string * officialAccountUrl?: string * pcIcon?: string * pcUrl?: string * sortNo?: number * }> * hasNext?: boolean * pageIndex?: number * pageSize?: number * total?: number * totalPages?: number * } * ``` */ appList< Config extends Alova2MethodConfig & { params: { categoryId?: number; name?: string; pageIndex?: number; pageSize?: number; sorted?: boolean; unsorted?: boolean; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] appSort * * **path:** /api/app/AppSort * * --- * * **RequestBody** * ```ts * type RequestBody = number[] * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ appSort< Config extends Alova2MethodConfig & { data: number[]; } >( config: Config ): Alova2Method; /** * --- * * [GET] appSortList * * **path:** /api/app/AppSortList * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // categoryId * categoryId: number * } * ``` * * --- * * **Response** * ```ts * type Response = Array<{ * id?: number * name?: string * sortNo?: number * }> * ``` */ appSortList< Config extends Alova2MethodConfig & { params: { /** * categoryId */ categoryId: number; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] appTypeList * * **path:** /api/app/AppTypeList * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * name?: string * } * ``` * * --- * * **Response** * ```ts * type Response = Array<{ * id?: number * name?: string * sortNo?: number * }> * ``` */ appTypeList< Config extends Alova2MethodConfig & { params: { name?: string; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] appTypeSort * * **path:** /api/app/AppTypeSort * * --- * * **RequestBody** * ```ts * type RequestBody = number[] * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ appTypeSort< Config extends Alova2MethodConfig & { data: number[]; } >( config: Config ): Alova2Method; /** * --- * * [POST] deleteApp * * **path:** /api/app/DeleteApp/{id} * * --- * * **Path Parameters** * ```ts * type PathParameters = { * // id * id: number * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ deleteApp< Config extends Alova2MethodConfig & { pathParams: { /** * id */ id: number; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] deleteModule * * **path:** /api/app/DeleteModule/{id} * * --- * * **Path Parameters** * ```ts * type PathParameters = { * // id * id: number * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ deleteModule< Config extends Alova2MethodConfig & { pathParams: { /** * id */ id: number; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] deleteType * * **path:** /api/app/DeleteType/{id} * * --- * * **Path Parameters** * ```ts * type PathParameters = { * // id * id: number * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ deleteType< Config extends Alova2MethodConfig & { pathParams: { /** * id */ id: number; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] editApp * * **path:** /api/app/EditApp/{id} * * --- * * **Path Parameters** * ```ts * type PathParameters = { * // id * id: number * } * ``` * * --- * * **RequestBody** * ```ts * type RequestBody = { * appIcon?: string * appUrl?: string * categoryId?: number * // [items] start * // [items] end * clients?: number[] * desc?: string * dingtalkUrl?: string * id?: number * name?: string * officialAccountUrl?: string * pcIcon?: string * pcUrl?: string * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ editApp< Config extends Alova2MethodConfig & { pathParams: { /** * id */ id: number; }; data: ApplicationInfoRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] editModule * * **path:** /api/app/EditModule/{id} * * --- * * **Path Parameters** * ```ts * type PathParameters = { * // id * id: number * } * ``` * * --- * * **RequestBody** * ```ts * type RequestBody = { * appId?: number * customId?: string * id?: number * name?: string * parentId?: number * path?: string * sortNo?: number * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ editModule< Config extends Alova2MethodConfig & { pathParams: { /** * id */ id: number; }; data: AppModuleRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] editType * * **path:** /api/app/EditType/{id} * * --- * * **Path Parameters** * ```ts * type PathParameters = { * // id * id: number * } * ``` * * --- * * **RequestBody** * ```ts * type RequestBody = { * id?: number * name?: string * sortNo?: number * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ editType< Config extends Alova2MethodConfig & { pathParams: { /** * id */ id: number; }; data: AppCategoryRequest; } >( config: Config ): Alova2Method; /** * --- * * [GET] moduleList * * **path:** /api/app/ModuleList * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * appId?: number * name?: string * parentId?: number * } * ``` * * --- * * **Response** * ```ts * type Response = Array<{ * appId?: number * // [items] start * // [cycle] $.[] * // [items] end * children?: AppModuleVo[] * customId?: string * id?: number * level?: number * name?: string * parentId?: number * path?: string * sortNo?: number * }> * ``` */ moduleList< Config extends Alova2MethodConfig & { params: { appId?: number; name?: string; parentId?: number; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] resetAppSecret * * **path:** /api/app/ResetAppSecret/{id} * * --- * * **Path Parameters** * ```ts * type PathParameters = { * // id * id: number * } * ``` * * --- * * **Response** * ```ts * type Response = string * ``` */ resetAppSecret< Config extends Alova2MethodConfig & { pathParams: { /** * id */ id: number; }; } >( config: Config ): Alova2Method; }; AppRole: { /** * --- * * [POST] removeRoleUser * * **path:** /api/approle/RemoveRoleUser * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // roleId * roleId: number * // userId * userId: number * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ removeRoleUser< Config extends Alova2MethodConfig & { params: { /** * roleId */ roleId: number; /** * userId */ userId: number; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] roleAdd * * **path:** /api/approle/RoleAdd * * --- * * **RequestBody** * ```ts * type RequestBody = { * allAppFlag?: boolean * appId?: number * disabled?: boolean * id?: number * name?: string * remark?: string * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ roleAdd< Config extends Alova2MethodConfig & { data: SysAppRoleRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] roleDelete * * **path:** /api/approle/RoleDelete/{id} * * --- * * **Path Parameters** * ```ts * type PathParameters = { * // id * id: number * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ roleDelete< Config extends Alova2MethodConfig & { pathParams: { /** * id */ id: number; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] roleEdit * * **path:** /api/approle/RoleEdit/{id} * * --- * * **Path Parameters** * ```ts * type PathParameters = { * // id * id: number * } * ``` * * --- * * **RequestBody** * ```ts * type RequestBody = { * allAppFlag?: boolean * appId?: number * disabled?: boolean * id?: number * name?: string * remark?: string * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ roleEdit< Config extends Alova2MethodConfig & { pathParams: { /** * id */ id: number; }; data: SysAppRoleRequest; } >( config: Config ): Alova2Method; /** * --- * * [GET] roleList * * **path:** /api/approle/RoleList * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * allAppFlag?: boolean * appId?: number * disabled?: boolean * name?: string * pageIndex?: number * pageSize?: number * sorted?: boolean * unsorted?: boolean * } * ``` * * --- * * **Response** * ```ts * type Response = { * // [items] start * // [title] SysAppRoleVo * // [items] end * content?: Array<{ * allAppFlag?: boolean * appId?: number * appName?: string * disabled?: boolean * id?: number * name?: string * remark?: string * }> * hasNext?: boolean * pageIndex?: number * pageSize?: number * total?: number * totalPages?: number * } * ``` */ roleList< Config extends Alova2MethodConfig & { params: { allAppFlag?: boolean; appId?: number; disabled?: boolean; name?: string; pageIndex?: number; pageSize?: number; sorted?: boolean; unsorted?: boolean; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] roleModuleTree * * **path:** /api/approle/RoleModuleTree * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // roleId * roleId: number * } * ``` * * --- * * **Response** * ```ts * type Response = Array<{ * appKey?: number * id?: number * // [items] start * // [title] AppRoleAuthzModuleVo * // [items] end * modules?: Array<{ * checked?: boolean * // [items] start * // [cycle] $.[].modules.[] * // [items] end * children?: AppRoleAuthzModuleVo[] * customId?: string * id?: number * level?: number * name?: string * parentId?: number * path?: string * sortNo?: number * }> * name?: string * pcIcon?: string * sortNo?: number * }> * ``` */ roleModuleTree< Config extends Alova2MethodConfig & { params: { /** * roleId */ roleId: number; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] roleUsers * * **path:** /api/approle/RoleUsers * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // roleId * roleId: number * } * ``` * * --- * * **Response** * ```ts * type Response = Array<{ * account?: string * id?: number * realName?: string * }> * ``` */ roleUsers< Config extends Alova2MethodConfig & { params: { /** * roleId */ roleId: number; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] saveRoleModules * * **path:** /api/approle/SaveRoleModules * * --- * * **RequestBody** * ```ts * type RequestBody = { * // [items] start * // [items] end * moduleIds?: number[] * roleId?: number * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ saveRoleModules< Config extends Alova2MethodConfig & { data: AppRoleModuleAssignRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] saveRoleUsers * * **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 & { data: AppRoleUserBindRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] saveUserRoles * * **path:** /api/approle/SaveUserRoles * * --- * * **RequestBody** * ```ts * type RequestBody = { * // [items] start * // [items] end * roleIds?: number[] * userId?: number * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ saveUserRoles< Config extends Alova2MethodConfig & { data: UserAppRoleBindRequest; } >( config: Config ): Alova2Method; }; Base: { /** * --- * * [GET] getSysDict * * **path:** /api/base/GetSysDict * * --- * * **Response** * ```ts * type Response = object * ``` */ getSysDict>( config?: Config ): Alova2Method; /** * --- * * [GET] getUserInfo * * **path:** /api/base/GetUserInfo * * --- * * **Response** * ```ts * type Response = object * ``` */ getUserInfo>( config?: Config ): Alova2Method; /** * --- * * [GET] manualHashCacheDemo * * **path:** /api/base/ManualHashCacheDemo * * --- * * **Response** * ```ts * type Response = object * ``` */ manualHashCacheDemo>( config?: Config ): Alova2Method; /** * --- * * [GET] RedirectTo * * **path:** /api/base/RedirectTo/{id} * * --- * * **Path Parameters** * ```ts * type PathParameters = { * // id * id: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // [title] ApplicationContext * applicationContext?: { * applicationName?: string * // [title] AutowireCapableBeanFactory * autowireCapableBeanFactory?: object * beanDefinitionCount?: number * // [items] start * // [items] end * beanDefinitionNames?: string[] * // [title] ClassLoader * classLoader?: { * // [cycle] $.applicationContext.classLoader * parent?: ClassLoader * } * displayName?: string * // [title] Environment * environment?: { * // [items] start * // [items] end * activeProfiles?: string[] * // [items] start * // [items] end * defaultProfiles?: string[] * } * id?: string * // [cycle] $.applicationContext * parent?: ApplicationContext * // [title] BeanFactory * parentBeanFactory?: object * startupDate?: number * } * attributesMap?: object * beanName?: string * contentType?: string * exposePathVariables?: boolean * // [items] start * // [items] end * hosts?: string[] * propagateQueryProperties?: boolean * redirectView?: boolean * requestContextAttribute?: string * staticAttributes?: object * url?: string * } * ``` */ RedirectTo< Config extends Alova2MethodConfig & { pathParams: { /** * id */ id: string; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] uploadFile * * **path:** /api/base/UploadFile * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // type * type?: string * } * ``` * * --- * * **RequestBody** * ```ts * type RequestBody = { * // file * file: Blob * } * ``` * * --- * * **Response** * ```ts * type Response = string * ``` */ uploadFile< Config extends Alova2MethodConfig & { params: { /** * type */ type?: string; }; data: { /** * file */ file: Blob; }; } >( config: Config ): Alova2Method; }; GroupAuthz: { /** * --- * * [POST] assignApps * * **path:** /api/groupauthz/AssignApps * * --- * * **RequestBody** * ```ts * type RequestBody = { * // [items] start * // [items] end * appIds?: number[] * groupId?: number * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ assignApps< Config extends Alova2MethodConfig & { data: GroupAppAssignRequest; } >( config: Config ): Alova2Method; /** * --- * * [GET] getSchoolAppId * * **path:** /api/groupauthz/GetSchoolAppId * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // nodeId * nodeId: number * } * ``` * * --- * * **Response** * ```ts * type Response = number[] * ``` */ getSchoolAppId< Config extends Alova2MethodConfig & { params: { /** * nodeId */ nodeId: number; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] groupAppList * * **path:** /api/groupauthz/GroupAppList * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // groupId * groupId: number * } * ``` * * --- * * **Response** * ```ts * type Response = Array<{ * appKey?: number * categoryId?: number * checked?: boolean * id?: number * name?: string * pcIcon?: string * }> * ``` */ groupAppList< Config extends Alova2MethodConfig & { params: { /** * groupId */ groupId: number; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] groupModuleTree * * **path:** /api/groupauthz/GroupModuleTree * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // groupId * groupId: number * } * ``` * * --- * * **Response** * ```ts * type Response = Array<{ * appKey?: number * categoryId?: number * id?: number * // [items] start * // [title] GroupAuthzModuleVo * // [items] end * modules?: Array<{ * checked?: boolean * // [items] start * // [cycle] $.[].modules.[] * // [items] end * children?: GroupAuthzModuleVo[] * customId?: string * id?: number * inheritFlag?: boolean * level?: number * name?: string * parentId?: number * path?: string * sortNo?: number * }> * name?: string * pcIcon?: string * sortNo?: number * }> * ``` */ groupModuleTree< Config extends Alova2MethodConfig & { params: { /** * groupId */ groupId: number; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] groupModuleTreeByCategory * * **path:** /api/groupauthz/GroupModuleTreeByCategory * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // groupId * groupId: number * } * ``` * * --- * * **Response** * ```ts * type Response = Array<{ * // [items] start * // [title] GroupAuthzAppVo * // [items] end * apps?: Array<{ * appKey?: number * categoryId?: number * id?: number * // [items] start * // [title] GroupAuthzModuleVo * // [items] end * modules?: Array<{ * checked?: boolean * // [items] start * // [cycle] $.[].apps.[].modules.[] * // [items] end * children?: GroupAuthzModuleVo[] * customId?: string * id?: number * inheritFlag?: boolean * level?: number * name?: string * parentId?: number * path?: string * sortNo?: number * }> * name?: string * pcIcon?: string * sortNo?: number * }> * id?: number * name?: string * }> * ``` */ groupModuleTreeByCategory< Config extends Alova2MethodConfig & { params: { /** * groupId */ groupId: number; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] groupUsers * * **path:** /api/groupauthz/GroupUsers * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // groupId * groupId: number * } * ``` * * --- * * **Response** * ```ts * type Response = Array<{ * account?: string * groupPath?: string * id?: number * isMain?: number * realName?: string * }> * ``` */ groupUsers< Config extends Alova2MethodConfig & { params: { /** * groupId */ groupId: number; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] hasModulePerm * * **path:** /api/groupauthz/HasModulePerm * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // moduleId * moduleId: number * // userId * userId: number * } * ``` * * --- * * **Response** * ```ts * type Response = boolean * ``` */ hasModulePerm< Config extends Alova2MethodConfig & { params: { /** * moduleId */ moduleId: number; /** * userId */ userId: number; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] saveModulePerms * * **path:** /api/groupauthz/SaveModulePerms * * --- * * **RequestBody** * ```ts * type RequestBody = { * groupId?: number * // [items] start * // [title] ModulePermItem * // [items] end * perms?: Array<{ * inheritFlag?: boolean * moduleId?: number * }> * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ saveModulePerms< Config extends Alova2MethodConfig & { data: GroupModulePermRequest; } >( config: Config ): Alova2Method; /** * --- * * [GET] searchUsers * * **path:** /api/groupauthz/SearchUsers * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // keyword * keyword: string * } * ``` * * --- * * **Response** * ```ts * type Response = Array<{ * account?: string * groupPath?: string * id?: number * isMain?: number * realName?: string * }> * ``` */ searchUsers< Config extends Alova2MethodConfig & { params: { /** * keyword */ keyword: string; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] setGroupModule * * **path:** /api/groupauthz/SetGroupModule * * --- * * **RequestBody** * ```ts * type RequestBody = Array<{ * appId?: number * groupId?: number * isAll?: number * mode?: number * moduleId?: number * }> * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ setGroupModule< Config extends Alova2MethodConfig & { data: GroupModuleAuthzItem[]; } >( config: Config ): Alova2Method; /** * --- * * [POST] setSchoolApp * * **path:** /api/groupauthz/SetSchoolApp * * --- * * **RequestBody** * ```ts * type RequestBody = { * appid?: number * mode?: number * schid?: number * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ setSchoolApp< Config extends Alova2MethodConfig & { data: SchoolAppAuthzRequest; } >( config: Config ): Alova2Method; /** * --- * * [GET] userGroupTree * * **path:** /api/groupauthz/UserGroupTree * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // userId * userId: number * } * ``` * * --- * * **Response** * ```ts * type Response = Array<{ * // [items] start * // [cycle] $.[] * // [items] end * children?: UserGroupNodeVo[] * id?: number * name?: string * own?: boolean * }> * ``` */ userGroupTree< Config extends Alova2MethodConfig & { params: { /** * userId */ userId: number; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] userPermissionTree * * **path:** /api/groupauthz/UserPermissionTree * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // groupId * groupId?: number * // userId * userId: number * } * ``` * * --- * * **Response** * ```ts * type Response = Array<{ * // [items] start * // [title] UserPermissionAppVo * // [items] end * apps?: Array<{ * appKey?: number * id?: number * // [items] start * // [title] UserPermissionModuleVo * // [items] end * modules?: Array<{ * // [items] start * // [cycle] $.[].apps.[].modules.[] * // [items] end * children?: UserPermissionModuleVo[] * customId?: string * id?: number * level?: number * name?: string * parentId?: number * path?: string * sortNo?: number * }> * name?: string * pcIcon?: string * sortNo?: number * }> * id?: number * name?: string * sortNo?: number * }> * ``` */ userPermissionTree< Config extends Alova2MethodConfig & { params: { /** * groupId */ groupId?: number; /** * userId */ userId: number; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] userRoles * * **path:** /api/groupauthz/UserRoles * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // userId * userId: number * } * ``` * * --- * * **Response** * ```ts * type Response = Array<{ * allAppFlag?: boolean * appId?: number * appName?: string * disabled?: boolean * id?: number * name?: string * }> * ``` */ userRoles< Config extends Alova2MethodConfig & { params: { /** * userId */ userId: number; }; } >( config: Config ): Alova2Method; }; SysGroup: { /** * --- * * [POST] add * * **path:** /api/sysgroup/Add * * --- * * **RequestBody** * ```ts * type RequestBody = { * id?: number * name?: string * parentId?: number * sort?: number * type?: number * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ add< Config extends Alova2MethodConfig & { data: SysGroupRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] batchAdd * * **path:** /api/sysgroup/BatchAdd * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 待新增的子组列表,每一项仅需提供 name * // [items] start * // [title] 批量新增单项 * // 仅需提供子组名称 * // [items] end * items: Array<{ * // 子组名称 * name: string * }> * // 父组ID(挂载点,必须存在) * pid: number * // 组类型(GroupTypeEnum.key,如 4=班级组) * type: number * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ batchAdd< Config extends Alova2MethodConfig & { data: _2; } >( config: Config ): Alova2Method; /** * --- * * [POST] delete * * **path:** /api/sysgroup/Delete/{id} * * --- * * **Path Parameters** * ```ts * type PathParameters = { * // id * id: number * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ delete< Config extends Alova2MethodConfig & { pathParams: { /** * id */ id: number; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] edit * * **path:** /api/sysgroup/Edit/{id} * * --- * * **Path Parameters** * ```ts * type PathParameters = { * // id * id: number * } * ``` * * --- * * **RequestBody** * ```ts * type RequestBody = { * id?: number * name?: string * parentId?: number * sort?: number * type?: number * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ edit< Config extends Alova2MethodConfig & { pathParams: { /** * id */ id: number; }; data: SysGroupRequest; } >( config: Config ): Alova2Method; /** * --- * * [GET] getSchoolTree * * **path:** /api/sysgroup/GetSchoolTree * * --- * * **Response** * ```ts * type Response = Array<{ * // [items] start * // [cycle] $.[] * // [items] end * children?: SysGroupVo[] * id?: number * name?: string * sort?: number * type?: number * }> * ``` */ getSchoolTree>( config?: Config ): Alova2Method; /** * --- * * [GET] getTree * * **path:** /api/sysgroup/GetTree * * --- * * **Response** * ```ts * type Response = Array<{ * // [items] start * // [cycle] $.[] * // [items] end * children?: SysGroupVo[] * id?: number * name?: string * sort?: number * type?: number * }> * ``` */ getTree>( config?: Config ): Alova2Method; /** * --- * * [GET] list * * **path:** /api/sysgroup/List * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * name?: string * parentId?: number * } * ``` * * --- * * **Response** * ```ts * type Response = Array<{ * // [items] start * // [cycle] $.[] * // [items] end * children?: SysGroupVo[] * id?: number * name?: string * sort?: number * type?: number * }> * ``` */ list< Config extends Alova2MethodConfig & { params: { name?: string; parentId?: number; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] move * * **path:** /api/sysgroup/Move * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * moveId?: number * pid?: number * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ move< Config extends Alova2MethodConfig & { params: { moveId?: number; pid?: number; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] sortChildren * * **path:** /api/sysgroup/SortChildren * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // [items] start * // [items] end * ids?: number[] * pid?: number * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ sortChildren< Config extends Alova2MethodConfig & { params: { ids?: number[]; pid?: number; }; } >( config: Config ): Alova2Method; }; SysUser: { /** * --- * * [GET] getGroups * * **path:** /api/sysuser/Groups/{userId} * * --- * * **Path Parameters** * ```ts * type PathParameters = { * // userId * userId: number * } * ``` * * --- * * **Response** * ```ts * type Response = number[] * ``` */ getGroups< Config extends Alova2MethodConfig & { pathParams: { /** * userId */ userId: number; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] add * * **path:** /api/sysuser/Add * * --- * * **RequestBody** * ```ts * type RequestBody = { * account?: string * birthday?: string * confirmPassword?: string * disabled?: number * expired?: boolean * groupId?: number * id?: number * idcard?: string * password?: string * phone?: string * profilePicture?: string * realName?: string * // [items] start * // [items] end * roles?: number[] * } * ``` * * --- * * **Response** * ```ts * type Response = number * ``` */ add< Config extends Alova2MethodConfig & { data: SysUserRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] delete * * **path:** /api/sysuser/Delete/{id} * * --- * * **Path Parameters** * ```ts * type PathParameters = { * // id * id: number * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ delete< Config extends Alova2MethodConfig & { pathParams: { /** * id */ id: number; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] disable * * **path:** /api/sysuser/Disable/{id} * * --- * * **Path Parameters** * ```ts * type PathParameters = { * // id * id: number * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ disable< Config extends Alova2MethodConfig & { pathParams: { /** * id */ id: number; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] edit * * **path:** /api/sysuser/Edit/{id} * * --- * * **Path Parameters** * ```ts * type PathParameters = { * // id * id: number * } * ``` * * --- * * **RequestBody** * ```ts * type RequestBody = { * account?: string * birthday?: string * confirmPassword?: string * disabled?: number * expired?: boolean * groupId?: number * id?: number * idcard?: string * password?: string * phone?: string * profilePicture?: string * realName?: string * // [items] start * // [items] end * roles?: number[] * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ edit< Config extends Alova2MethodConfig & { pathParams: { /** * id */ id: number; }; data: SysUserRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] enable * * **path:** /api/sysuser/Enable/{id} * * --- * * **Path Parameters** * ```ts * type PathParameters = { * // id * id: number * } * ``` * * --- * * **Response** * ```ts * type Response = null * ``` */ enable< Config extends Alova2MethodConfig & { pathParams: { /** * id */ id: number; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] list * * **path:** /api/sysuser/List * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * disabled?: number * groupId?: number * name?: string * pageIndex?: number * pageSize?: number * sorted?: boolean * unsorted?: boolean * withSub?: number * } * ``` * * --- * * **Response** * ```ts * type Response = { * // [items] start * // [title] SysUserVo * // [items] end * content?: Array<{ * account?: string * birthday?: string * createTime?: string * disabled?: number * expired?: boolean * id?: number * idcard?: string * phone?: string * profilePicture?: string * realName?: string * // [items] start * // [items] end * roles?: number[] * updateTime?: string * }> * hasNext?: boolean * pageIndex?: number * pageSize?: number * total?: number * totalPages?: number * } * ``` */ list< Config extends Alova2MethodConfig & { params: { disabled?: number; groupId?: number; name?: string; pageIndex?: number; pageSize?: number; sorted?: boolean; unsorted?: boolean; withSub?: number; }; } >( config: Config ): Alova2Method; }; } var Apis: Apis; }