diff --git a/src/serverApi/v3/api.ts b/src/serverApi/v3/api.ts index 7332b8ff11..aea961b6e0 100644 --- a/src/serverApi/v3/api.ts +++ b/src/serverApi/v3/api.ts @@ -114,16 +114,6 @@ export interface AccountSearchListResponse { */ limit: number; } -/** - * - * @export - * @enum {string} - */ -export enum Action { - Read = 'read', - Write = 'write' -} - /** * * @export @@ -227,18 +217,196 @@ export enum AuthorizationBodyParamsReferenceTypeEnum { */ export interface AuthorizationContextParams { /** - * - * @type {Action} + * Define for which action the operation should be performend. + * @type {string} * @memberof AuthorizationContextParams */ - action: Action; + action: AuthorizationContextParamsActionEnum; /** * User permissions that are needed to execute the operation. - * @type {Array} + * @type {Array} * @memberof AuthorizationContextParams */ - requiredPermissions: Array; + requiredPermissions: Array; } + +/** + * @export + * @enum {string} + */ +export enum AuthorizationContextParamsActionEnum { + Read = 'read', + Write = 'write' +} +/** + * @export + * @enum {string} + */ +export enum AuthorizationContextParamsRequiredPermissionsEnum { + AccountCreate = 'ACCOUNT_CREATE', + AccountDelete = 'ACCOUNT_DELETE', + AccountEdit = 'ACCOUNT_EDIT', + AccountView = 'ACCOUNT_VIEW', + AddSchoolMembers = 'ADD_SCHOOL_MEMBERS', + AdminEdit = 'ADMIN_EDIT', + AdminView = 'ADMIN_VIEW', + BaseView = 'BASE_VIEW', + CalendarCreate = 'CALENDAR_CREATE', + CalendarEdit = 'CALENDAR_EDIT', + CalendarView = 'CALENDAR_VIEW', + ChangeTeamRoles = 'CHANGE_TEAM_ROLES', + ClassCreate = 'CLASS_CREATE', + ClassEdit = 'CLASS_EDIT', + ClassFullAdmin = 'CLASS_FULL_ADMIN', + ClassList = 'CLASS_LIST', + ClassRemove = 'CLASS_REMOVE', + ClassView = 'CLASS_VIEW', + CommentsCreate = 'COMMENTS_CREATE', + CommentsEdit = 'COMMENTS_EDIT', + CommentsView = 'COMMENTS_VIEW', + ContentNonOerView = 'CONTENT_NON_OER_VIEW', + ContentView = 'CONTENT_VIEW', + ContextToolAdmin = 'CONTEXT_TOOL_ADMIN', + ContextToolUser = 'CONTEXT_TOOL_USER', + CoursegroupCreate = 'COURSEGROUP_CREATE', + CoursegroupEdit = 'COURSEGROUP_EDIT', + CourseAdministration = 'COURSE_ADMINISTRATION', + CourseCreate = 'COURSE_CREATE', + CourseDelete = 'COURSE_DELETE', + CourseEdit = 'COURSE_EDIT', + CourseRemove = 'COURSE_REMOVE', + CourseView = 'COURSE_VIEW', + CreateSupportJwt = 'CREATE_SUPPORT_JWT', + CreateTopicsAndTasks = 'CREATE_TOPICS_AND_TASKS', + DashboardView = 'DASHBOARD_VIEW', + DatasourcesCreate = 'DATASOURCES_CREATE', + DatasourcesDelete = 'DATASOURCES_DELETE', + DatasourcesEdit = 'DATASOURCES_EDIT', + DatasourcesRun = 'DATASOURCES_RUN', + DatasourcesRunView = 'DATASOURCES_RUN_VIEW', + DatasourcesView = 'DATASOURCES_VIEW', + DefaultFilePermissions = 'DEFAULT_FILE_PERMISSIONS', + DeleteTeam = 'DELETE_TEAM', + EditAllFiles = 'EDIT_ALL_FILES', + EnterthecloudStart = 'ENTERTHECLOUD_START', + FederalstateCreate = 'FEDERALSTATE_CREATE', + FederalstateEdit = 'FEDERALSTATE_EDIT', + FederalstateView = 'FEDERALSTATE_VIEW', + FilestorageCreate = 'FILESTORAGE_CREATE', + FilestorageEdit = 'FILESTORAGE_EDIT', + FilestorageRemove = 'FILESTORAGE_REMOVE', + FilestorageView = 'FILESTORAGE_VIEW', + FileCreate = 'FILE_CREATE', + FileDelete = 'FILE_DELETE', + FileMove = 'FILE_MOVE', + FolderCreate = 'FOLDER_CREATE', + FolderDelete = 'FOLDER_DELETE', + GroupList = 'GROUP_LIST', + GroupFullAdmin = 'GROUP_FULL_ADMIN', + GroupView = 'GROUP_VIEW', + HelpdeskCreate = 'HELPDESK_CREATE', + HelpdeskEdit = 'HELPDESK_EDIT', + HelpdeskView = 'HELPDESK_VIEW', + HomeworkCreate = 'HOMEWORK_CREATE', + HomeworkEdit = 'HOMEWORK_EDIT', + HomeworkView = 'HOMEWORK_VIEW', + ImportUserMigrate = 'IMPORT_USER_MIGRATE', + ImportUserUpdate = 'IMPORT_USER_UPDATE', + ImportUserView = 'IMPORT_USER_VIEW', + InstanceView = 'INSTANCE_VIEW', + InviteAdministrators = 'INVITE_ADMINISTRATORS', + InviteExperts = 'INVITE_EXPERTS', + JoinMeeting = 'JOIN_MEETING', + LeaveTeam = 'LEAVE_TEAM', + LernstoreView = 'LERNSTORE_VIEW', + LessonsCreate = 'LESSONS_CREATE', + LessonsView = 'LESSONS_VIEW', + LinkCreate = 'LINK_CREATE', + NewsCreate = 'NEWS_CREATE', + NewsEdit = 'NEWS_EDIT', + NewsView = 'NEWS_VIEW', + NextcloudUser = 'NEXTCLOUD_USER', + NotificationCreate = 'NOTIFICATION_CREATE', + NotificationEdit = 'NOTIFICATION_EDIT', + NotificationView = 'NOTIFICATION_VIEW', + OauthClientEdit = 'OAUTH_CLIENT_EDIT', + OauthClientView = 'OAUTH_CLIENT_VIEW', + PasswordEdit = 'PASSWORD_EDIT', + PwrecoveryCreate = 'PWRECOVERY_CREATE', + PwrecoveryEdit = 'PWRECOVERY_EDIT', + PwrecoveryView = 'PWRECOVERY_VIEW', + ReleasesCreate = 'RELEASES_CREATE', + ReleasesEdit = 'RELEASES_EDIT', + ReleasesView = 'RELEASES_VIEW', + RemoveMembers = 'REMOVE_MEMBERS', + RenameTeam = 'RENAME_TEAM', + RequestConsents = 'REQUEST_CONSENTS', + RoleCreate = 'ROLE_CREATE', + RoleEdit = 'ROLE_EDIT', + RoleView = 'ROLE_VIEW', + SchoolChatManage = 'SCHOOL_CHAT_MANAGE', + SchoolCreate = 'SCHOOL_CREATE', + SchoolEdit = 'SCHOOL_EDIT', + SchoolEditAll = 'SCHOOL_EDIT_ALL', + SchoolLogoManage = 'SCHOOL_LOGO_MANAGE', + SchoolNewsEdit = 'SCHOOL_NEWS_EDIT', + SchoolPermissionChange = 'SCHOOL_PERMISSION_CHANGE', + SchoolPermissionView = 'SCHOOL_PERMISSION_VIEW', + SchoolStudentTeamManage = 'SCHOOL_STUDENT_TEAM_MANAGE', + SchoolSystemEdit = 'SCHOOL_SYSTEM_EDIT', + SchoolSystemView = 'SCHOOL_SYSTEM_VIEW', + SchoolToolAdmin = 'SCHOOL_TOOL_ADMIN', + ScopePermissionsView = 'SCOPE_PERMISSIONS_VIEW', + StartMeeting = 'START_MEETING', + StudentCreate = 'STUDENT_CREATE', + StudentDelete = 'STUDENT_DELETE', + StudentEdit = 'STUDENT_EDIT', + StudentList = 'STUDENT_LIST', + StudentSkipRegistration = 'STUDENT_SKIP_REGISTRATION', + SubmissionsCreate = 'SUBMISSIONS_CREATE', + SubmissionsEdit = 'SUBMISSIONS_EDIT', + SubmissionsSchoolView = 'SUBMISSIONS_SCHOOL_VIEW', + SubmissionsView = 'SUBMISSIONS_VIEW', + SyncStart = 'SYNC_START', + SystemCreate = 'SYSTEM_CREATE', + SystemEdit = 'SYSTEM_EDIT', + SystemView = 'SYSTEM_VIEW', + TaskDashboardTeacherViewV3 = 'TASK_DASHBOARD_TEACHER_VIEW_V3', + TaskDashboardViewV3 = 'TASK_DASHBOARD_VIEW_V3', + TeacherCreate = 'TEACHER_CREATE', + TeacherDelete = 'TEACHER_DELETE', + TeacherEdit = 'TEACHER_EDIT', + TeacherList = 'TEACHER_LIST', + TeacherSkipRegistration = 'TEACHER_SKIP_REGISTRATION', + TeamCreate = 'TEAM_CREATE', + ToolCreateEtherpad = 'TOOL_CREATE_ETHERPAD', + TeamEdit = 'TEAM_EDIT', + TeamInviteExternal = 'TEAM_INVITE_EXTERNAL', + TeamView = 'TEAM_VIEW', + ToolAdmin = 'TOOL_ADMIN', + ToolCreate = 'TOOL_CREATE', + ToolEdit = 'TOOL_EDIT', + ToolNewView = 'TOOL_NEW_VIEW', + ToolView = 'TOOL_VIEW', + TopicCreate = 'TOPIC_CREATE', + TopicEdit = 'TOPIC_EDIT', + TopicView = 'TOPIC_VIEW', + UploadFiles = 'UPLOAD_FILES', + UseLibreoffice = 'USE_LIBREOFFICE', + UseRocketchat = 'USE_ROCKETCHAT', + UsergroupCreate = 'USERGROUP_CREATE', + UsergroupEdit = 'USERGROUP_EDIT', + UsergroupView = 'USERGROUP_VIEW', + UserChangeOwnName = 'USER_CHANGE_OWN_NAME', + UserCreate = 'USER_CREATE', + UserLoginMigrationAdmin = 'USER_LOGIN_MIGRATION_ADMIN', + UserLoginMigrationRollback = 'USER_LOGIN_MIGRATION_ROLLBACK', + UserLoginMigrationForce = 'USER_LOGIN_MIGRATION_FORCE', + UserMigrate = 'USER_MIGRATE', + UserUpdate = 'USER_UPDATE', + YearsEdit = 'YEARS_EDIT' +} + /** * * @export @@ -277,6 +445,55 @@ export interface BasicToolConfigParams { */ baseUrl: string; } +/** + * + * @export + * @interface BoardColumnBoardResponse + */ +export interface BoardColumnBoardResponse { + /** + * + * @type {string} + * @memberof BoardColumnBoardResponse + */ + id: string; + /** + * + * @type {string} + * @memberof BoardColumnBoardResponse + */ + title: string; + /** + * + * @type {boolean} + * @memberof BoardColumnBoardResponse + */ + published: boolean; + /** + * + * @type {string} + * @memberof BoardColumnBoardResponse + */ + createdAt: string; + /** + * + * @type {string} + * @memberof BoardColumnBoardResponse + */ + updatedAt: string; + /** + * + * @type {string} + * @memberof BoardColumnBoardResponse + */ + columnBoardId: string; + /** + * + * @type {string} + * @memberof BoardColumnBoardResponse + */ + layout: string; +} /** * * @export @@ -310,10 +527,10 @@ export interface BoardElementResponse { type: BoardElementResponseTypeEnum; /** * Content of the Board, either: a task or a lesson specific for the board - * @type {object} + * @type {BoardTaskResponse | BoardLessonResponse | BoardColumnBoardResponse} * @memberof BoardElementResponse */ - content: object; + content: BoardTaskResponse | BoardLessonResponse | BoardColumnBoardResponse; } /** @@ -347,6 +564,67 @@ export enum BoardLayout { Grid = 'grid' } +/** + * + * @export + * @interface BoardLessonResponse + */ +export interface BoardLessonResponse { + /** + * + * @type {string} + * @memberof BoardLessonResponse + */ + id: string; + /** + * + * @type {string} + * @memberof BoardLessonResponse + */ + name: string; + /** + * + * @type {string} + * @memberof BoardLessonResponse + */ + courseName?: string; + /** + * + * @type {number} + * @memberof BoardLessonResponse + */ + numberOfPublishedTasks: number; + /** + * + * @type {number} + * @memberof BoardLessonResponse + */ + numberOfDraftTasks: number; + /** + * + * @type {number} + * @memberof BoardLessonResponse + */ + numberOfPlannedTasks: number; + /** + * + * @type {string} + * @memberof BoardLessonResponse + */ + createdAt: string; + /** + * + * @type {string} + * @memberof BoardLessonResponse + */ + updatedAt: string; + /** + * + * @type {boolean} + * @memberof BoardLessonResponse + */ + hidden: boolean; +} /** * * @export @@ -362,43 +640,153 @@ export enum BoardParentType { * @export * @interface BoardResponse */ -export interface BoardResponse { +export interface BoardResponse { + /** + * + * @type {string} + * @memberof BoardResponse + */ + id: string; + /** + * + * @type {string} + * @memberof BoardResponse + */ + title: string; + /** + * + * @type {Array} + * @memberof BoardResponse + */ + columns: Array; + /** + * + * @type {TimestampsResponse} + * @memberof BoardResponse + */ + timestamps: TimestampsResponse; + /** + * + * @type {boolean} + * @memberof BoardResponse + */ + isVisible: boolean; + /** + * + * @type {string} + * @memberof BoardResponse + */ + layout: string; +} +/** + * + * @export + * @interface BoardTaskResponse + */ +export interface BoardTaskResponse { + /** + * + * @type {string} + * @memberof BoardTaskResponse + */ + id: string; + /** + * + * @type {string} + * @memberof BoardTaskResponse + */ + name: string; + /** + * + * @type {string} + * @memberof BoardTaskResponse + */ + availableDate?: string; + /** + * + * @type {string} + * @memberof BoardTaskResponse + */ + dueDate?: string; + /** + * + * @type {string} + * @memberof BoardTaskResponse + */ + courseName?: string; + /** + * + * @type {string} + * @memberof BoardTaskResponse + */ + description?: string; + /** + * + * @type {string} + * @memberof BoardTaskResponse + */ + displayColor?: string; + /** + * + * @type {string} + * @memberof BoardTaskResponse + */ + createdAt: string; + /** + * + * @type {string} + * @memberof BoardTaskResponse + */ + updatedAt: string; + /** + * + * @type {BoardTaskStatusResponse} + * @memberof BoardTaskResponse + */ + status: BoardTaskStatusResponse; +} +/** + * + * @export + * @interface BoardTaskStatusResponse + */ +export interface BoardTaskStatusResponse { /** * - * @type {string} - * @memberof BoardResponse + * @type {number} + * @memberof BoardTaskStatusResponse */ - id: string; + submitted: number; /** * - * @type {string} - * @memberof BoardResponse + * @type {number} + * @memberof BoardTaskStatusResponse */ - title: string; + maxSubmissions: number; /** * - * @type {Array} - * @memberof BoardResponse + * @type {number} + * @memberof BoardTaskStatusResponse */ - columns: Array; + graded: number; /** * - * @type {TimestampsResponse} - * @memberof BoardResponse + * @type {boolean} + * @memberof BoardTaskStatusResponse */ - timestamps: TimestampsResponse; + isDraft: boolean; /** * * @type {boolean} - * @memberof BoardResponse + * @memberof BoardTaskStatusResponse */ - isVisible: boolean; + isSubstitutionTeacher: boolean; /** * - * @type {string} - * @memberof BoardResponse + * @type {boolean} + * @memberof BoardTaskStatusResponse */ - layout: string; + isFinished: boolean; } /** * @@ -6061,175 +6449,6 @@ export interface PeriodResponse { */ until: string; } -/** - * - * @export - * @enum {string} - */ -export enum Permission { - AccountCreate = 'ACCOUNT_CREATE', - AccountDelete = 'ACCOUNT_DELETE', - AccountEdit = 'ACCOUNT_EDIT', - AccountView = 'ACCOUNT_VIEW', - AddSchoolMembers = 'ADD_SCHOOL_MEMBERS', - AdminEdit = 'ADMIN_EDIT', - AdminView = 'ADMIN_VIEW', - BaseView = 'BASE_VIEW', - CalendarCreate = 'CALENDAR_CREATE', - CalendarEdit = 'CALENDAR_EDIT', - CalendarView = 'CALENDAR_VIEW', - ChangeTeamRoles = 'CHANGE_TEAM_ROLES', - ClassCreate = 'CLASS_CREATE', - ClassEdit = 'CLASS_EDIT', - ClassFullAdmin = 'CLASS_FULL_ADMIN', - ClassList = 'CLASS_LIST', - ClassRemove = 'CLASS_REMOVE', - ClassView = 'CLASS_VIEW', - CommentsCreate = 'COMMENTS_CREATE', - CommentsEdit = 'COMMENTS_EDIT', - CommentsView = 'COMMENTS_VIEW', - ContentNonOerView = 'CONTENT_NON_OER_VIEW', - ContentView = 'CONTENT_VIEW', - ContextToolAdmin = 'CONTEXT_TOOL_ADMIN', - ContextToolUser = 'CONTEXT_TOOL_USER', - CoursegroupCreate = 'COURSEGROUP_CREATE', - CoursegroupEdit = 'COURSEGROUP_EDIT', - CourseAdministration = 'COURSE_ADMINISTRATION', - CourseCreate = 'COURSE_CREATE', - CourseDelete = 'COURSE_DELETE', - CourseEdit = 'COURSE_EDIT', - CourseRemove = 'COURSE_REMOVE', - CourseView = 'COURSE_VIEW', - CreateSupportJwt = 'CREATE_SUPPORT_JWT', - CreateTopicsAndTasks = 'CREATE_TOPICS_AND_TASKS', - DashboardView = 'DASHBOARD_VIEW', - DatasourcesCreate = 'DATASOURCES_CREATE', - DatasourcesDelete = 'DATASOURCES_DELETE', - DatasourcesEdit = 'DATASOURCES_EDIT', - DatasourcesRun = 'DATASOURCES_RUN', - DatasourcesRunView = 'DATASOURCES_RUN_VIEW', - DatasourcesView = 'DATASOURCES_VIEW', - DefaultFilePermissions = 'DEFAULT_FILE_PERMISSIONS', - DeleteTeam = 'DELETE_TEAM', - EditAllFiles = 'EDIT_ALL_FILES', - EnterthecloudStart = 'ENTERTHECLOUD_START', - FederalstateCreate = 'FEDERALSTATE_CREATE', - FederalstateEdit = 'FEDERALSTATE_EDIT', - FederalstateView = 'FEDERALSTATE_VIEW', - FilestorageCreate = 'FILESTORAGE_CREATE', - FilestorageEdit = 'FILESTORAGE_EDIT', - FilestorageRemove = 'FILESTORAGE_REMOVE', - FilestorageView = 'FILESTORAGE_VIEW', - FileCreate = 'FILE_CREATE', - FileDelete = 'FILE_DELETE', - FileMove = 'FILE_MOVE', - FolderCreate = 'FOLDER_CREATE', - FolderDelete = 'FOLDER_DELETE', - GroupList = 'GROUP_LIST', - GroupFullAdmin = 'GROUP_FULL_ADMIN', - GroupView = 'GROUP_VIEW', - HelpdeskCreate = 'HELPDESK_CREATE', - HelpdeskEdit = 'HELPDESK_EDIT', - HelpdeskView = 'HELPDESK_VIEW', - HomeworkCreate = 'HOMEWORK_CREATE', - HomeworkEdit = 'HOMEWORK_EDIT', - HomeworkView = 'HOMEWORK_VIEW', - ImportUserMigrate = 'IMPORT_USER_MIGRATE', - ImportUserUpdate = 'IMPORT_USER_UPDATE', - ImportUserView = 'IMPORT_USER_VIEW', - InstanceView = 'INSTANCE_VIEW', - InviteAdministrators = 'INVITE_ADMINISTRATORS', - InviteExperts = 'INVITE_EXPERTS', - JoinMeeting = 'JOIN_MEETING', - LeaveTeam = 'LEAVE_TEAM', - LernstoreView = 'LERNSTORE_VIEW', - LessonsCreate = 'LESSONS_CREATE', - LessonsView = 'LESSONS_VIEW', - LinkCreate = 'LINK_CREATE', - NewsCreate = 'NEWS_CREATE', - NewsEdit = 'NEWS_EDIT', - NewsView = 'NEWS_VIEW', - NextcloudUser = 'NEXTCLOUD_USER', - NotificationCreate = 'NOTIFICATION_CREATE', - NotificationEdit = 'NOTIFICATION_EDIT', - NotificationView = 'NOTIFICATION_VIEW', - OauthClientEdit = 'OAUTH_CLIENT_EDIT', - OauthClientView = 'OAUTH_CLIENT_VIEW', - PasswordEdit = 'PASSWORD_EDIT', - PwrecoveryCreate = 'PWRECOVERY_CREATE', - PwrecoveryEdit = 'PWRECOVERY_EDIT', - PwrecoveryView = 'PWRECOVERY_VIEW', - ReleasesCreate = 'RELEASES_CREATE', - ReleasesEdit = 'RELEASES_EDIT', - ReleasesView = 'RELEASES_VIEW', - RemoveMembers = 'REMOVE_MEMBERS', - RenameTeam = 'RENAME_TEAM', - RequestConsents = 'REQUEST_CONSENTS', - RoleCreate = 'ROLE_CREATE', - RoleEdit = 'ROLE_EDIT', - RoleView = 'ROLE_VIEW', - SchoolChatManage = 'SCHOOL_CHAT_MANAGE', - SchoolCreate = 'SCHOOL_CREATE', - SchoolEdit = 'SCHOOL_EDIT', - SchoolLogoManage = 'SCHOOL_LOGO_MANAGE', - SchoolNewsEdit = 'SCHOOL_NEWS_EDIT', - SchoolPermissionChange = 'SCHOOL_PERMISSION_CHANGE', - SchoolPermissionView = 'SCHOOL_PERMISSION_VIEW', - SchoolStudentTeamManage = 'SCHOOL_STUDENT_TEAM_MANAGE', - SchoolSystemEdit = 'SCHOOL_SYSTEM_EDIT', - SchoolSystemView = 'SCHOOL_SYSTEM_VIEW', - SchoolToolAdmin = 'SCHOOL_TOOL_ADMIN', - ScopePermissionsView = 'SCOPE_PERMISSIONS_VIEW', - StartMeeting = 'START_MEETING', - StudentCreate = 'STUDENT_CREATE', - StudentDelete = 'STUDENT_DELETE', - StudentEdit = 'STUDENT_EDIT', - StudentList = 'STUDENT_LIST', - StudentSkipRegistration = 'STUDENT_SKIP_REGISTRATION', - SubmissionsCreate = 'SUBMISSIONS_CREATE', - SubmissionsEdit = 'SUBMISSIONS_EDIT', - SubmissionsSchoolView = 'SUBMISSIONS_SCHOOL_VIEW', - SubmissionsView = 'SUBMISSIONS_VIEW', - SyncStart = 'SYNC_START', - SystemCreate = 'SYSTEM_CREATE', - SystemEdit = 'SYSTEM_EDIT', - SystemView = 'SYSTEM_VIEW', - TaskDashboardTeacherViewV3 = 'TASK_DASHBOARD_TEACHER_VIEW_V3', - TaskDashboardViewV3 = 'TASK_DASHBOARD_VIEW_V3', - TeacherCreate = 'TEACHER_CREATE', - TeacherDelete = 'TEACHER_DELETE', - TeacherEdit = 'TEACHER_EDIT', - TeacherList = 'TEACHER_LIST', - TeacherSkipRegistration = 'TEACHER_SKIP_REGISTRATION', - TeamCreate = 'TEAM_CREATE', - ToolCreateEtherpad = 'TOOL_CREATE_ETHERPAD', - TeamEdit = 'TEAM_EDIT', - TeamInviteExternal = 'TEAM_INVITE_EXTERNAL', - TeamView = 'TEAM_VIEW', - ToolAdmin = 'TOOL_ADMIN', - ToolCreate = 'TOOL_CREATE', - ToolEdit = 'TOOL_EDIT', - ToolNewView = 'TOOL_NEW_VIEW', - ToolView = 'TOOL_VIEW', - TopicCreate = 'TOPIC_CREATE', - TopicEdit = 'TOPIC_EDIT', - TopicView = 'TOPIC_VIEW', - UploadFiles = 'UPLOAD_FILES', - UseLibreoffice = 'USE_LIBREOFFICE', - UseRocketchat = 'USE_ROCKETCHAT', - UsergroupCreate = 'USERGROUP_CREATE', - UsergroupEdit = 'USERGROUP_EDIT', - UsergroupView = 'USERGROUP_VIEW', - UserChangeOwnName = 'USER_CHANGE_OWN_NAME', - UserCreate = 'USER_CREATE', - UserLoginMigrationAdmin = 'USER_LOGIN_MIGRATION_ADMIN', - UserLoginMigrationRollback = 'USER_LOGIN_MIGRATION_ROLLBACK', - UserLoginMigrationForce = 'USER_LOGIN_MIGRATION_FORCE', - UserMigrate = 'USER_MIGRATE', - UserUpdate = 'USER_UPDATE', - YearsEdit = 'YEARS_EDIT' -} - /** * * @export @@ -10317,6 +10536,40 @@ export const AuthenticationApiAxiosParamCreator = function (configuration?: Conf localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; localVarRequestOptions.data = serializeDataIfNeeded(oauth2AuthorizationBodyParams, localVarRequestOptions, configuration) + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Logs out a user. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + logoutControllerLogout: async (options: any = {}): Promise => { + const localVarPath = `/logout`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication bearer required + // http bearer authentication required + await setBearerAuthToObject(localVarHeaderParameter, configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, @@ -10365,6 +10618,16 @@ export const AuthenticationApiFp = function(configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.loginControllerLoginOauth2(oauth2AuthorizationBodyParams, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * + * @summary Logs out a user. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async logoutControllerLogout(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.logoutControllerLogout(options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, } }; @@ -10405,6 +10668,15 @@ export const AuthenticationApiFactory = function (configuration?: Configuration, loginControllerLoginOauth2(oauth2AuthorizationBodyParams: Oauth2AuthorizationBodyParams, options?: any): AxiosPromise { return localVarFp.loginControllerLoginOauth2(oauth2AuthorizationBodyParams, options).then((request) => request(axios, basePath)); }, + /** + * + * @summary Logs out a user. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + logoutControllerLogout(options?: any): AxiosPromise { + return localVarFp.logoutControllerLogout(options).then((request) => request(axios, basePath)); + }, }; }; @@ -10444,6 +10716,15 @@ export interface AuthenticationApiInterface { */ loginControllerLoginOauth2(oauth2AuthorizationBodyParams: Oauth2AuthorizationBodyParams, options?: any): AxiosPromise; + /** + * + * @summary Logs out a user. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AuthenticationApiInterface + */ + logoutControllerLogout(options?: any): AxiosPromise; + } /** @@ -10488,6 +10769,17 @@ export class AuthenticationApi extends BaseAPI implements AuthenticationApiInter public loginControllerLoginOauth2(oauth2AuthorizationBodyParams: Oauth2AuthorizationBodyParams, options?: any) { return AuthenticationApiFp(this.configuration).loginControllerLoginOauth2(oauth2AuthorizationBodyParams, options).then((request) => request(this.axios, this.basePath)); } + + /** + * + * @summary Logs out a user. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AuthenticationApi + */ + public logoutControllerLogout(options?: any) { + return AuthenticationApiFp(this.configuration).logoutControllerLogout(options).then((request) => request(this.axios, this.basePath)); + } }