From 6365f124842e4fc7158f050429d510b23232248a Mon Sep 17 00:00:00 2001 From: "hoeppner.dataport" Date: Wed, 22 Jan 2025 15:02:59 +0100 Subject: [PATCH 1/4] generated client --- src/serverApi/v3/api.ts | 834 +++++++++++++++++++++++++++------------- 1 file changed, 564 insertions(+), 270 deletions(-) diff --git a/src/serverApi/v3/api.ts b/src/serverApi/v3/api.ts index 02aa20dd18..971e894de8 100644 --- a/src/serverApi/v3/api.ts +++ b/src/serverApi/v3/api.ts @@ -32,19 +32,19 @@ export interface AccountByIdBodyParams { * @type {string} * @memberof AccountByIdBodyParams */ - username?: string | null; + username?: string; /** * The new password for the user. * @type {string} * @memberof AccountByIdBodyParams */ - password?: string | null; + password?: string; /** * The new activation state of the user. * @type {boolean} * @memberof AccountByIdBodyParams */ - activated?: boolean | null; + activated?: boolean; } /** * @@ -363,6 +363,7 @@ export enum AuthorizationContextParamsRequiredPermissionsEnum { RoomDelete = 'ROOM_DELETE', RoomMembersAdd = 'ROOM_MEMBERS_ADD', RoomMembersRemove = 'ROOM_MEMBERS_REMOVE', + RoomMembersChangeRole = 'ROOM_MEMBERS_CHANGE_ROLE', RoomChangeOwner = 'ROOM_CHANGE_OWNER', SchoolChatManage = 'SCHOOL_CHAT_MANAGE', SchoolCreate = 'SCHOOL_CREATE', @@ -913,6 +914,36 @@ export interface ChangeLanguageParams { */ language: LanguageType; } +/** + * + * @export + * @interface ChangeRoomRoleBodyParams + */ +export interface ChangeRoomRoleBodyParams { + /** + * The IDs of the users + * @type {Array} + * @memberof ChangeRoomRoleBodyParams + */ + userIds: Array; + /** + * The role to assign to the users. Must be a Room Role role other than ROOMOWNER. + * @type {string} + * @memberof ChangeRoomRoleBodyParams + */ + roleName: ChangeRoomRoleBodyParamsRoleNameEnum; +} + +/** + * @export + * @enum {string} + */ +export enum ChangeRoomRoleBodyParamsRoleNameEnum { + Roomadmin = 'roomadmin', + Roomeditor = 'roomeditor', + Roomviewer = 'roomviewer' +} + /** * * @export @@ -2529,13 +2560,13 @@ export interface CreateBoardBodyParams { */ parentId: string; /** - * + * The type of the parent * @type {BoardParentType} * @memberof CreateBoardBodyParams */ parentType: BoardParentType; /** - * + * The layout of the board * @type {BoardLayout} * @memberof CreateBoardBodyParams */ @@ -2591,7 +2622,7 @@ export enum CreateCardBodyParamsRequiredEmptyElementsEnum { */ export interface CreateContentElementBodyParams { /** - * + * The type of element * @type {ContentElementType} * @memberof CreateContentElementBodyParams */ @@ -2702,7 +2733,7 @@ export interface CreateRoomBodyParams { */ name: string; /** - * + * The display color of the room * @type {RoomColor} * @memberof CreateRoomBodyParams */ @@ -3158,7 +3189,7 @@ export interface DrawingElementContent { */ export interface DrawingElementContentBody { /** - * + * the type of the updated element * @type {ContentElementType} * @memberof DrawingElementContentBody */ @@ -3394,7 +3425,7 @@ export interface ExternalToolElementContent { */ export interface ExternalToolElementContentBody { /** - * + * the type of the updated element * @type {ContentElementType} * @memberof ExternalToolElementContentBody */ @@ -3813,7 +3844,7 @@ export interface FileElementContent { */ export interface FileElementContentBody { /** - * + * the type of the updated element * @type {ContentElementType} * @memberof FileElementContentBody */ @@ -4604,7 +4635,7 @@ export interface LinkElementContent { */ export interface LinkElementContentBody { /** - * + * the type of the updated element * @type {ContentElementType} * @memberof LinkElementContentBody */ @@ -5349,7 +5380,7 @@ export interface MediaAvailableLineResponse { */ elements: Array; /** - * + * Background color of available media line * @type {MediaBoardColors} * @memberof MediaAvailableLineResponse */ @@ -5425,7 +5456,7 @@ export interface MediaBoardResponse { */ timestamps: TimestampsResponse; /** - * + * Layout of media board * @type {MediaBoardLayoutType} * @memberof MediaBoardResponse */ @@ -5500,7 +5531,7 @@ export interface MediaLineResponse { */ timestamps: TimestampsResponse; /** - * + * The background color of the media line * @type {MediaBoardColors} * @memberof MediaLineResponse */ @@ -5829,7 +5860,7 @@ export interface NewsResponse { */ sourceDescription?: string; /** - * + * Target model to which the News entity is related * @type {NewsTargetModel} * @memberof NewsResponse */ @@ -6787,25 +6818,25 @@ export interface PatchMyAccountParams { * @type {string} * @memberof PatchMyAccountParams */ - passwordNew?: string | null; + passwordNew?: string; /** * The new email address for the current user. * @type {string} * @memberof PatchMyAccountParams */ - email?: string | null; + email?: string; /** * The new first name for the current user. * @type {string} * @memberof PatchMyAccountParams */ - firstName?: string | null; + firstName?: string; /** * The new last name for the current user. * @type {string} * @memberof PatchMyAccountParams */ - lastName?: string | null; + lastName?: string; } /** * @@ -6984,6 +7015,7 @@ export enum Permission { RoomDelete = 'ROOM_DELETE', RoomMembersAdd = 'ROOM_MEMBERS_ADD', RoomMembersRemove = 'ROOM_MEMBERS_REMOVE', + RoomMembersChangeRole = 'ROOM_MEMBERS_CHANGE_ROLE', RoomChangeOwner = 'ROOM_CHANGE_OWNER', SchoolChatManage = 'SCHOOL_CHAT_MANAGE', SchoolCreate = 'SCHOOL_CREATE', @@ -7344,7 +7376,7 @@ export interface RichTextElementContent { */ export interface RichTextElementContentBody { /** - * + * the type of the updated element * @type {ContentElementType} * @memberof RichTextElementContentBody */ @@ -8701,7 +8733,7 @@ export interface SubmissionContainerElementContent { */ export interface SubmissionContainerElementContentBody { /** - * + * the type of the updated element * @type {ContentElementType} * @memberof SubmissionContainerElementContentBody */ @@ -9272,7 +9304,7 @@ export interface ToolLaunchRequestResponse { */ openNewTab?: boolean; /** - * + * Specifies the underlying type of the request * @type {LaunchType} * @memberof ToolLaunchRequestResponse */ @@ -9452,7 +9484,7 @@ export interface UpdateRoomBodyParams { */ name: string; /** - * + * The display color of the room * @type {RoomColor} * @memberof UpdateRoomBodyParams */ @@ -9973,7 +10005,7 @@ export interface VideoConferenceElementContent { */ export interface VideoConferenceElementContentBody { /** - * + * the type of the updated element * @type {ContentElementType} * @memberof VideoConferenceElementContentBody */ @@ -10023,7 +10055,7 @@ export interface VideoConferenceElementResponse { */ export interface VideoConferenceInfoResponse { /** - * + * The state of the video conference. * @type {VideoConferenceStateResponse} * @memberof VideoConferenceInfoResponse */ @@ -10783,13 +10815,18 @@ export const AdminStudentsApiAxiosParamCreator = function (configuration?: Confi * @param {number} [limit] Page limit, defaults to 10. * @param {number} [$limit] Page limit, defaults to 25. * @param {number} [$skip] Number of elements (not pages) to be skipped + * @param {object} [$sort] Sort parameter. + * @param {object} [consentStatus] * @param {Array} [classes] + * @param {object} [createdAt] + * @param {object} [lastLoginSystemChange] + * @param {object} [outdatedSince] * @param {string} [searchQuery] * @param {Array} [users] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - adminApiStudentsControllerSearchStudents: async (skip?: number, limit?: number, $limit?: number, $skip?: number, classes?: Array, searchQuery?: string, users?: Array, options: any = {}): Promise => { + adminApiStudentsControllerSearchStudents: async (skip?: number, limit?: number, $limit?: number, $skip?: number, $sort?: object, consentStatus?: object, classes?: Array, createdAt?: object, lastLoginSystemChange?: object, outdatedSince?: object, searchQuery?: string, users?: Array, options: any = {}): Promise => { const localVarPath = `/users/admin/students`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -10822,10 +10859,30 @@ export const AdminStudentsApiAxiosParamCreator = function (configuration?: Confi localVarQueryParameter['$skip'] = $skip; } + if ($sort !== undefined) { + localVarQueryParameter['$sort'] = $sort; + } + + if (consentStatus !== undefined) { + localVarQueryParameter['consentStatus'] = consentStatus; + } + if (classes) { localVarQueryParameter['classes'] = classes; } + if (createdAt !== undefined) { + localVarQueryParameter['createdAt'] = createdAt; + } + + if (lastLoginSystemChange !== undefined) { + localVarQueryParameter['lastLoginSystemChange'] = lastLoginSystemChange; + } + + if (outdatedSince !== undefined) { + localVarQueryParameter['outdatedSince'] = outdatedSince; + } + if (searchQuery !== undefined) { localVarQueryParameter['searchQuery'] = searchQuery; } @@ -10873,14 +10930,19 @@ export const AdminStudentsApiFp = function(configuration?: Configuration) { * @param {number} [limit] Page limit, defaults to 10. * @param {number} [$limit] Page limit, defaults to 25. * @param {number} [$skip] Number of elements (not pages) to be skipped + * @param {object} [$sort] Sort parameter. + * @param {object} [consentStatus] * @param {Array} [classes] + * @param {object} [createdAt] + * @param {object} [lastLoginSystemChange] + * @param {object} [outdatedSince] * @param {string} [searchQuery] * @param {Array} [users] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async adminApiStudentsControllerSearchStudents(skip?: number, limit?: number, $limit?: number, $skip?: number, classes?: Array, searchQuery?: string, users?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.adminApiStudentsControllerSearchStudents(skip, limit, $limit, $skip, classes, searchQuery, users, options); + async adminApiStudentsControllerSearchStudents(skip?: number, limit?: number, $limit?: number, $skip?: number, $sort?: object, consentStatus?: object, classes?: Array, createdAt?: object, lastLoginSystemChange?: object, outdatedSince?: object, searchQuery?: string, users?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.adminApiStudentsControllerSearchStudents(skip, limit, $limit, $skip, $sort, consentStatus, classes, createdAt, lastLoginSystemChange, outdatedSince, searchQuery, users, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, } @@ -10910,14 +10972,19 @@ export const AdminStudentsApiFactory = function (configuration?: Configuration, * @param {number} [limit] Page limit, defaults to 10. * @param {number} [$limit] Page limit, defaults to 25. * @param {number} [$skip] Number of elements (not pages) to be skipped + * @param {object} [$sort] Sort parameter. + * @param {object} [consentStatus] * @param {Array} [classes] + * @param {object} [createdAt] + * @param {object} [lastLoginSystemChange] + * @param {object} [outdatedSince] * @param {string} [searchQuery] * @param {Array} [users] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - adminApiStudentsControllerSearchStudents(skip?: number, limit?: number, $limit?: number, $skip?: number, classes?: Array, searchQuery?: string, users?: Array, options?: any): AxiosPromise { - return localVarFp.adminApiStudentsControllerSearchStudents(skip, limit, $limit, $skip, classes, searchQuery, users, options).then((request) => request(axios, basePath)); + adminApiStudentsControllerSearchStudents(skip?: number, limit?: number, $limit?: number, $skip?: number, $sort?: object, consentStatus?: object, classes?: Array, createdAt?: object, lastLoginSystemChange?: object, outdatedSince?: object, searchQuery?: string, users?: Array, options?: any): AxiosPromise { + return localVarFp.adminApiStudentsControllerSearchStudents(skip, limit, $limit, $skip, $sort, consentStatus, classes, createdAt, lastLoginSystemChange, outdatedSince, searchQuery, users, options).then((request) => request(axios, basePath)); }, }; }; @@ -10945,14 +11012,19 @@ export interface AdminStudentsApiInterface { * @param {number} [limit] Page limit, defaults to 10. * @param {number} [$limit] Page limit, defaults to 25. * @param {number} [$skip] Number of elements (not pages) to be skipped + * @param {object} [$sort] Sort parameter. + * @param {object} [consentStatus] * @param {Array} [classes] + * @param {object} [createdAt] + * @param {object} [lastLoginSystemChange] + * @param {object} [outdatedSince] * @param {string} [searchQuery] * @param {Array} [users] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AdminStudentsApiInterface */ - adminApiStudentsControllerSearchStudents(skip?: number, limit?: number, $limit?: number, $skip?: number, classes?: Array, searchQuery?: string, users?: Array, options?: any): AxiosPromise; + adminApiStudentsControllerSearchStudents(skip?: number, limit?: number, $limit?: number, $skip?: number, $sort?: object, consentStatus?: object, classes?: Array, createdAt?: object, lastLoginSystemChange?: object, outdatedSince?: object, searchQuery?: string, users?: Array, options?: any): AxiosPromise; } @@ -10982,15 +11054,20 @@ export class AdminStudentsApi extends BaseAPI implements AdminStudentsApiInterfa * @param {number} [limit] Page limit, defaults to 10. * @param {number} [$limit] Page limit, defaults to 25. * @param {number} [$skip] Number of elements (not pages) to be skipped + * @param {object} [$sort] Sort parameter. + * @param {object} [consentStatus] * @param {Array} [classes] + * @param {object} [createdAt] + * @param {object} [lastLoginSystemChange] + * @param {object} [outdatedSince] * @param {string} [searchQuery] * @param {Array} [users] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AdminStudentsApi */ - public adminApiStudentsControllerSearchStudents(skip?: number, limit?: number, $limit?: number, $skip?: number, classes?: Array, searchQuery?: string, users?: Array, options?: any) { - return AdminStudentsApiFp(this.configuration).adminApiStudentsControllerSearchStudents(skip, limit, $limit, $skip, classes, searchQuery, users, options).then((request) => request(this.axios, this.basePath)); + public adminApiStudentsControllerSearchStudents(skip?: number, limit?: number, $limit?: number, $skip?: number, $sort?: object, consentStatus?: object, classes?: Array, createdAt?: object, lastLoginSystemChange?: object, outdatedSince?: object, searchQuery?: string, users?: Array, options?: any) { + return AdminStudentsApiFp(this.configuration).adminApiStudentsControllerSearchStudents(skip, limit, $limit, $skip, $sort, consentStatus, classes, createdAt, lastLoginSystemChange, outdatedSince, searchQuery, users, options).then((request) => request(this.axios, this.basePath)); } } @@ -11046,13 +11123,18 @@ export const AdminTeachersApiAxiosParamCreator = function (configuration?: Confi * @param {number} [limit] Page limit, defaults to 10. * @param {number} [$limit] Page limit, defaults to 25. * @param {number} [$skip] Number of elements (not pages) to be skipped + * @param {object} [$sort] Sort parameter. + * @param {object} [consentStatus] * @param {Array} [classes] + * @param {object} [createdAt] + * @param {object} [lastLoginSystemChange] + * @param {object} [outdatedSince] * @param {string} [searchQuery] * @param {Array} [users] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - adminApiTeachersControllerSearchTeachers: async (skip?: number, limit?: number, $limit?: number, $skip?: number, classes?: Array, searchQuery?: string, users?: Array, options: any = {}): Promise => { + adminApiTeachersControllerSearchTeachers: async (skip?: number, limit?: number, $limit?: number, $skip?: number, $sort?: object, consentStatus?: object, classes?: Array, createdAt?: object, lastLoginSystemChange?: object, outdatedSince?: object, searchQuery?: string, users?: Array, options: any = {}): Promise => { const localVarPath = `/users/admin/teachers`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -11085,10 +11167,30 @@ export const AdminTeachersApiAxiosParamCreator = function (configuration?: Confi localVarQueryParameter['$skip'] = $skip; } + if ($sort !== undefined) { + localVarQueryParameter['$sort'] = $sort; + } + + if (consentStatus !== undefined) { + localVarQueryParameter['consentStatus'] = consentStatus; + } + if (classes) { localVarQueryParameter['classes'] = classes; } + if (createdAt !== undefined) { + localVarQueryParameter['createdAt'] = createdAt; + } + + if (lastLoginSystemChange !== undefined) { + localVarQueryParameter['lastLoginSystemChange'] = lastLoginSystemChange; + } + + if (outdatedSince !== undefined) { + localVarQueryParameter['outdatedSince'] = outdatedSince; + } + if (searchQuery !== undefined) { localVarQueryParameter['searchQuery'] = searchQuery; } @@ -11136,14 +11238,19 @@ export const AdminTeachersApiFp = function(configuration?: Configuration) { * @param {number} [limit] Page limit, defaults to 10. * @param {number} [$limit] Page limit, defaults to 25. * @param {number} [$skip] Number of elements (not pages) to be skipped + * @param {object} [$sort] Sort parameter. + * @param {object} [consentStatus] * @param {Array} [classes] + * @param {object} [createdAt] + * @param {object} [lastLoginSystemChange] + * @param {object} [outdatedSince] * @param {string} [searchQuery] * @param {Array} [users] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async adminApiTeachersControllerSearchTeachers(skip?: number, limit?: number, $limit?: number, $skip?: number, classes?: Array, searchQuery?: string, users?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.adminApiTeachersControllerSearchTeachers(skip, limit, $limit, $skip, classes, searchQuery, users, options); + async adminApiTeachersControllerSearchTeachers(skip?: number, limit?: number, $limit?: number, $skip?: number, $sort?: object, consentStatus?: object, classes?: Array, createdAt?: object, lastLoginSystemChange?: object, outdatedSince?: object, searchQuery?: string, users?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.adminApiTeachersControllerSearchTeachers(skip, limit, $limit, $skip, $sort, consentStatus, classes, createdAt, lastLoginSystemChange, outdatedSince, searchQuery, users, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, } @@ -11173,14 +11280,19 @@ export const AdminTeachersApiFactory = function (configuration?: Configuration, * @param {number} [limit] Page limit, defaults to 10. * @param {number} [$limit] Page limit, defaults to 25. * @param {number} [$skip] Number of elements (not pages) to be skipped + * @param {object} [$sort] Sort parameter. + * @param {object} [consentStatus] * @param {Array} [classes] + * @param {object} [createdAt] + * @param {object} [lastLoginSystemChange] + * @param {object} [outdatedSince] * @param {string} [searchQuery] * @param {Array} [users] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - adminApiTeachersControllerSearchTeachers(skip?: number, limit?: number, $limit?: number, $skip?: number, classes?: Array, searchQuery?: string, users?: Array, options?: any): AxiosPromise { - return localVarFp.adminApiTeachersControllerSearchTeachers(skip, limit, $limit, $skip, classes, searchQuery, users, options).then((request) => request(axios, basePath)); + adminApiTeachersControllerSearchTeachers(skip?: number, limit?: number, $limit?: number, $skip?: number, $sort?: object, consentStatus?: object, classes?: Array, createdAt?: object, lastLoginSystemChange?: object, outdatedSince?: object, searchQuery?: string, users?: Array, options?: any): AxiosPromise { + return localVarFp.adminApiTeachersControllerSearchTeachers(skip, limit, $limit, $skip, $sort, consentStatus, classes, createdAt, lastLoginSystemChange, outdatedSince, searchQuery, users, options).then((request) => request(axios, basePath)); }, }; }; @@ -11208,14 +11320,19 @@ export interface AdminTeachersApiInterface { * @param {number} [limit] Page limit, defaults to 10. * @param {number} [$limit] Page limit, defaults to 25. * @param {number} [$skip] Number of elements (not pages) to be skipped + * @param {object} [$sort] Sort parameter. + * @param {object} [consentStatus] * @param {Array} [classes] + * @param {object} [createdAt] + * @param {object} [lastLoginSystemChange] + * @param {object} [outdatedSince] * @param {string} [searchQuery] * @param {Array} [users] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AdminTeachersApiInterface */ - adminApiTeachersControllerSearchTeachers(skip?: number, limit?: number, $limit?: number, $skip?: number, classes?: Array, searchQuery?: string, users?: Array, options?: any): AxiosPromise; + adminApiTeachersControllerSearchTeachers(skip?: number, limit?: number, $limit?: number, $skip?: number, $sort?: object, consentStatus?: object, classes?: Array, createdAt?: object, lastLoginSystemChange?: object, outdatedSince?: object, searchQuery?: string, users?: Array, options?: any): AxiosPromise; } @@ -11245,15 +11362,20 @@ export class AdminTeachersApi extends BaseAPI implements AdminTeachersApiInterfa * @param {number} [limit] Page limit, defaults to 10. * @param {number} [$limit] Page limit, defaults to 25. * @param {number} [$skip] Number of elements (not pages) to be skipped + * @param {object} [$sort] Sort parameter. + * @param {object} [consentStatus] * @param {Array} [classes] + * @param {object} [createdAt] + * @param {object} [lastLoginSystemChange] + * @param {object} [outdatedSince] * @param {string} [searchQuery] * @param {Array} [users] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AdminTeachersApi */ - public adminApiTeachersControllerSearchTeachers(skip?: number, limit?: number, $limit?: number, $skip?: number, classes?: Array, searchQuery?: string, users?: Array, options?: any) { - return AdminTeachersApiFp(this.configuration).adminApiTeachersControllerSearchTeachers(skip, limit, $limit, $skip, classes, searchQuery, users, options).then((request) => request(this.axios, this.basePath)); + public adminApiTeachersControllerSearchTeachers(skip?: number, limit?: number, $limit?: number, $skip?: number, $sort?: object, consentStatus?: object, classes?: Array, createdAt?: object, lastLoginSystemChange?: object, outdatedSince?: object, searchQuery?: string, users?: Array, options?: any) { + return AdminTeachersApiFp(this.configuration).adminApiTeachersControllerSearchTeachers(skip, limit, $limit, $skip, $sort, consentStatus, classes, createdAt, lastLoginSystemChange, outdatedSince, searchQuery, users, options).then((request) => request(this.axios, this.basePath)); } } @@ -14577,7 +14699,8 @@ export class BoardSubmissionApi extends BaseAPI implements BoardSubmissionApiInt export const CollaborativeStorageApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Updates the CRUD Permissions(+Share) for a specific Role in a Team + * + * @summary Updates the CRUD Permissions(+Share) for a specific Role in a Team * @param {string} teamId * @param {string} roleId * @param {TeamPermissionsBody} teamPermissionsBody @@ -14634,7 +14757,8 @@ export const CollaborativeStorageApiFp = function(configuration?: Configuration) const localVarAxiosParamCreator = CollaborativeStorageApiAxiosParamCreator(configuration) return { /** - * Updates the CRUD Permissions(+Share) for a specific Role in a Team + * + * @summary Updates the CRUD Permissions(+Share) for a specific Role in a Team * @param {string} teamId * @param {string} roleId * @param {TeamPermissionsBody} teamPermissionsBody @@ -14656,7 +14780,8 @@ export const CollaborativeStorageApiFactory = function (configuration?: Configur const localVarFp = CollaborativeStorageApiFp(configuration) return { /** - * Updates the CRUD Permissions(+Share) for a specific Role in a Team + * + * @summary Updates the CRUD Permissions(+Share) for a specific Role in a Team * @param {string} teamId * @param {string} roleId * @param {TeamPermissionsBody} teamPermissionsBody @@ -14676,7 +14801,8 @@ export const CollaborativeStorageApiFactory = function (configuration?: Configur */ export interface CollaborativeStorageApiInterface { /** - * Updates the CRUD Permissions(+Share) for a specific Role in a Team + * + * @summary Updates the CRUD Permissions(+Share) for a specific Role in a Team * @param {string} teamId * @param {string} roleId * @param {TeamPermissionsBody} teamPermissionsBody @@ -14696,7 +14822,8 @@ export interface CollaborativeStorageApiInterface { */ export class CollaborativeStorageApi extends BaseAPI implements CollaborativeStorageApiInterface { /** - * Updates the CRUD Permissions(+Share) for a specific Role in a Team + * + * @summary Updates the CRUD Permissions(+Share) for a specific Role in a Team * @param {string} teamId * @param {string} roleId * @param {TeamPermissionsBody} teamPermissionsBody @@ -16491,190 +16618,6 @@ export class DashboardApi extends BaseAPI implements DashboardApiInterface { } -/** - * DefaultApi - axios parameter creator - * @export - */ -export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * - * @summary Useable configuration for clients - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - serverConfigControllerPublicConfig: async (options: any = {}): Promise => { - const localVarPath = `/config/public`; - // 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: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * - * @summary Default route to test public access - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - serverControllerGetHello: async (options: any = {}): Promise => { - const localVarPath = `/`; - // 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: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * DefaultApi - functional programming interface - * @export - */ -export const DefaultApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration) - return { - /** - * - * @summary Useable configuration for clients - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async serverConfigControllerPublicConfig(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.serverConfigControllerPublicConfig(options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * - * @summary Default route to test public access - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async serverControllerGetHello(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.serverControllerGetHello(options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - } -}; - -/** - * DefaultApi - factory interface - * @export - */ -export const DefaultApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = DefaultApiFp(configuration) - return { - /** - * - * @summary Useable configuration for clients - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - serverConfigControllerPublicConfig(options?: any): AxiosPromise { - return localVarFp.serverConfigControllerPublicConfig(options).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Default route to test public access - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - serverControllerGetHello(options?: any): AxiosPromise { - return localVarFp.serverControllerGetHello(options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * DefaultApi - interface - * @export - * @interface DefaultApi - */ -export interface DefaultApiInterface { - /** - * - * @summary Useable configuration for clients - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof DefaultApiInterface - */ - serverConfigControllerPublicConfig(options?: any): AxiosPromise; - - /** - * - * @summary Default route to test public access - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof DefaultApiInterface - */ - serverControllerGetHello(options?: any): AxiosPromise; - -} - -/** - * DefaultApi - object-oriented interface - * @export - * @class DefaultApi - * @extends {BaseAPI} - */ -export class DefaultApi extends BaseAPI implements DefaultApiInterface { - /** - * - * @summary Useable configuration for clients - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof DefaultApi - */ - public serverConfigControllerPublicConfig(options?: any) { - return DefaultApiFp(this.configuration).serverConfigControllerPublicConfig(options).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Default route to test public access - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof DefaultApi - */ - public serverControllerGetHello(options?: any) { - return DefaultApiFp(this.configuration).serverControllerGetHello(options).then((request) => request(this.axios, this.basePath)); - } -} - - /** * GroupApi - axios parameter creator * @export @@ -18980,7 +18923,8 @@ export class MetaTagExtractorApi extends BaseAPI implements MetaTagExtractorApiI export const NewsApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Create a news by a user in a given scope (school or team). + * + * @summary Create a news by a user in a given scope (school or team). * @param {CreateNewsParams} createNewsParams * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19019,7 +18963,8 @@ export const NewsApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * Delete a news. + * + * @summary Delete a news. * @param {string} newsId The id of the news. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19056,7 +19001,8 @@ export const NewsApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * Responds with all news for a user. + * + * @summary Responds with all news for a user. * @param {'schools' | 'courses' | 'teams'} [targetModel] Target model to which the news are related * @param {string} [targetId] Specific target id to which the news are related (works only together with targetModel) * @param {boolean} [unpublished] Flag that filters if the news should be published or not @@ -19114,7 +19060,8 @@ export const NewsApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * Retrieve a specific news entry by id. A user may only read news of scopes he has the read permission. The news entity has school and user names populated. + * + * @summary Retrieve a specific news entry by id. A user may only read news of scopes he has the read permission. The news entity has school and user names populated. * @param {string} newsId The id of the news. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19151,7 +19098,8 @@ export const NewsApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * Update properties of a news. + * + * @summary Update properties of a news. * @param {string} newsId The id of the news. * @param {UpdateNewsParams} updateNewsParams * @param {*} [options] Override http request option. @@ -19194,7 +19142,8 @@ export const NewsApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * Responds with news of a given team for a user. + * + * @summary Responds with news of a given team for a user. * @param {string} teamId The id of the team. * @param {'schools' | 'courses' | 'teams'} [targetModel] Target model to which the news are related * @param {string} [targetId] Specific target id to which the news are related (works only together with targetModel) @@ -19266,7 +19215,8 @@ export const NewsApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = NewsApiAxiosParamCreator(configuration) return { /** - * Create a news by a user in a given scope (school or team). + * + * @summary Create a news by a user in a given scope (school or team). * @param {CreateNewsParams} createNewsParams * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19276,7 +19226,8 @@ export const NewsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Delete a news. + * + * @summary Delete a news. * @param {string} newsId The id of the news. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19286,7 +19237,8 @@ export const NewsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Responds with all news for a user. + * + * @summary Responds with all news for a user. * @param {'schools' | 'courses' | 'teams'} [targetModel] Target model to which the news are related * @param {string} [targetId] Specific target id to which the news are related (works only together with targetModel) * @param {boolean} [unpublished] Flag that filters if the news should be published or not @@ -19300,7 +19252,8 @@ export const NewsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Retrieve a specific news entry by id. A user may only read news of scopes he has the read permission. The news entity has school and user names populated. + * + * @summary Retrieve a specific news entry by id. A user may only read news of scopes he has the read permission. The news entity has school and user names populated. * @param {string} newsId The id of the news. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19310,7 +19263,8 @@ export const NewsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Update properties of a news. + * + * @summary Update properties of a news. * @param {string} newsId The id of the news. * @param {UpdateNewsParams} updateNewsParams * @param {*} [options] Override http request option. @@ -19321,7 +19275,8 @@ export const NewsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Responds with news of a given team for a user. + * + * @summary Responds with news of a given team for a user. * @param {string} teamId The id of the team. * @param {'schools' | 'courses' | 'teams'} [targetModel] Target model to which the news are related * @param {string} [targetId] Specific target id to which the news are related (works only together with targetModel) @@ -19346,7 +19301,8 @@ export const NewsApiFactory = function (configuration?: Configuration, basePath? const localVarFp = NewsApiFp(configuration) return { /** - * Create a news by a user in a given scope (school or team). + * + * @summary Create a news by a user in a given scope (school or team). * @param {CreateNewsParams} createNewsParams * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19355,7 +19311,8 @@ export const NewsApiFactory = function (configuration?: Configuration, basePath? return localVarFp.newsControllerCreate(createNewsParams, options).then((request) => request(axios, basePath)); }, /** - * Delete a news. + * + * @summary Delete a news. * @param {string} newsId The id of the news. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19364,7 +19321,8 @@ export const NewsApiFactory = function (configuration?: Configuration, basePath? return localVarFp.newsControllerDelete(newsId, options).then((request) => request(axios, basePath)); }, /** - * Responds with all news for a user. + * + * @summary Responds with all news for a user. * @param {'schools' | 'courses' | 'teams'} [targetModel] Target model to which the news are related * @param {string} [targetId] Specific target id to which the news are related (works only together with targetModel) * @param {boolean} [unpublished] Flag that filters if the news should be published or not @@ -19377,7 +19335,8 @@ export const NewsApiFactory = function (configuration?: Configuration, basePath? return localVarFp.newsControllerFindAll(targetModel, targetId, unpublished, skip, limit, options).then((request) => request(axios, basePath)); }, /** - * Retrieve a specific news entry by id. A user may only read news of scopes he has the read permission. The news entity has school and user names populated. + * + * @summary Retrieve a specific news entry by id. A user may only read news of scopes he has the read permission. The news entity has school and user names populated. * @param {string} newsId The id of the news. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19386,7 +19345,8 @@ export const NewsApiFactory = function (configuration?: Configuration, basePath? return localVarFp.newsControllerFindOne(newsId, options).then((request) => request(axios, basePath)); }, /** - * Update properties of a news. + * + * @summary Update properties of a news. * @param {string} newsId The id of the news. * @param {UpdateNewsParams} updateNewsParams * @param {*} [options] Override http request option. @@ -19396,7 +19356,8 @@ export const NewsApiFactory = function (configuration?: Configuration, basePath? return localVarFp.newsControllerUpdate(newsId, updateNewsParams, options).then((request) => request(axios, basePath)); }, /** - * Responds with news of a given team for a user. + * + * @summary Responds with news of a given team for a user. * @param {string} teamId The id of the team. * @param {'schools' | 'courses' | 'teams'} [targetModel] Target model to which the news are related * @param {string} [targetId] Specific target id to which the news are related (works only together with targetModel) @@ -19419,7 +19380,8 @@ export const NewsApiFactory = function (configuration?: Configuration, basePath? */ export interface NewsApiInterface { /** - * Create a news by a user in a given scope (school or team). + * + * @summary Create a news by a user in a given scope (school or team). * @param {CreateNewsParams} createNewsParams * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19428,7 +19390,8 @@ export interface NewsApiInterface { newsControllerCreate(createNewsParams: CreateNewsParams, options?: any): AxiosPromise; /** - * Delete a news. + * + * @summary Delete a news. * @param {string} newsId The id of the news. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19437,7 +19400,8 @@ export interface NewsApiInterface { newsControllerDelete(newsId: string, options?: any): AxiosPromise; /** - * Responds with all news for a user. + * + * @summary Responds with all news for a user. * @param {'schools' | 'courses' | 'teams'} [targetModel] Target model to which the news are related * @param {string} [targetId] Specific target id to which the news are related (works only together with targetModel) * @param {boolean} [unpublished] Flag that filters if the news should be published or not @@ -19450,7 +19414,8 @@ export interface NewsApiInterface { newsControllerFindAll(targetModel?: 'schools' | 'courses' | 'teams', targetId?: string, unpublished?: boolean, skip?: number, limit?: number, options?: any): AxiosPromise; /** - * Retrieve a specific news entry by id. A user may only read news of scopes he has the read permission. The news entity has school and user names populated. + * + * @summary Retrieve a specific news entry by id. A user may only read news of scopes he has the read permission. The news entity has school and user names populated. * @param {string} newsId The id of the news. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19459,7 +19424,8 @@ export interface NewsApiInterface { newsControllerFindOne(newsId: string, options?: any): AxiosPromise; /** - * Update properties of a news. + * + * @summary Update properties of a news. * @param {string} newsId The id of the news. * @param {UpdateNewsParams} updateNewsParams * @param {*} [options] Override http request option. @@ -19469,7 +19435,8 @@ export interface NewsApiInterface { newsControllerUpdate(newsId: string, updateNewsParams: UpdateNewsParams, options?: any): AxiosPromise; /** - * Responds with news of a given team for a user. + * + * @summary Responds with news of a given team for a user. * @param {string} teamId The id of the team. * @param {'schools' | 'courses' | 'teams'} [targetModel] Target model to which the news are related * @param {string} [targetId] Specific target id to which the news are related (works only together with targetModel) @@ -19492,7 +19459,8 @@ export interface NewsApiInterface { */ export class NewsApi extends BaseAPI implements NewsApiInterface { /** - * Create a news by a user in a given scope (school or team). + * + * @summary Create a news by a user in a given scope (school or team). * @param {CreateNewsParams} createNewsParams * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19503,7 +19471,8 @@ export class NewsApi extends BaseAPI implements NewsApiInterface { } /** - * Delete a news. + * + * @summary Delete a news. * @param {string} newsId The id of the news. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19514,7 +19483,8 @@ export class NewsApi extends BaseAPI implements NewsApiInterface { } /** - * Responds with all news for a user. + * + * @summary Responds with all news for a user. * @param {'schools' | 'courses' | 'teams'} [targetModel] Target model to which the news are related * @param {string} [targetId] Specific target id to which the news are related (works only together with targetModel) * @param {boolean} [unpublished] Flag that filters if the news should be published or not @@ -19529,7 +19499,8 @@ export class NewsApi extends BaseAPI implements NewsApiInterface { } /** - * Retrieve a specific news entry by id. A user may only read news of scopes he has the read permission. The news entity has school and user names populated. + * + * @summary Retrieve a specific news entry by id. A user may only read news of scopes he has the read permission. The news entity has school and user names populated. * @param {string} newsId The id of the news. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19540,7 +19511,8 @@ export class NewsApi extends BaseAPI implements NewsApiInterface { } /** - * Update properties of a news. + * + * @summary Update properties of a news. * @param {string} newsId The id of the news. * @param {UpdateNewsParams} updateNewsParams * @param {*} [options] Override http request option. @@ -19552,7 +19524,8 @@ export class NewsApi extends BaseAPI implements NewsApiInterface { } /** - * Responds with news of a given team for a user. + * + * @summary Responds with news of a given team for a user. * @param {string} teamId The id of the team. * @param {'schools' | 'courses' | 'teams'} [targetModel] Target model to which the news are related * @param {string} [targetId] Specific target id to which the news are related (works only together with targetModel) @@ -20769,6 +20742,50 @@ export const RoomApiAxiosParamCreator = function (configuration?: Configuration) options: localVarRequestOptions, }; }, + /** + * + * @summary Change the roles that members have within the room + * @param {string} roomId + * @param {ChangeRoomRoleBodyParams} changeRoomRoleBodyParams + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + roomControllerChangeRolesOfMembers: async (roomId: string, changeRoomRoleBodyParams: ChangeRoomRoleBodyParams, options: any = {}): Promise => { + // verify required parameter 'roomId' is not null or undefined + assertParamExists('roomControllerChangeRolesOfMembers', 'roomId', roomId) + // verify required parameter 'changeRoomRoleBodyParams' is not null or undefined + assertParamExists('roomControllerChangeRolesOfMembers', 'changeRoomRoleBodyParams', changeRoomRoleBodyParams) + const localVarPath = `/rooms/{roomId}/members/roles` + .replace(`{${"roomId"}}`, encodeURIComponent(String(roomId))); + // 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: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication bearer required + // http bearer authentication required + await setBearerAuthToObject(localVarHeaderParameter, configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(changeRoomRoleBodyParams, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, /** * * @summary Create a new room @@ -21115,6 +21132,18 @@ export const RoomApiFp = function(configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.roomControllerAddMembers(roomId, addRoomMembersBodyParams, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * + * @summary Change the roles that members have within the room + * @param {string} roomId + * @param {ChangeRoomRoleBodyParams} changeRoomRoleBodyParams + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async roomControllerChangeRolesOfMembers(roomId: string, changeRoomRoleBodyParams: ChangeRoomRoleBodyParams, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.roomControllerChangeRolesOfMembers(roomId, changeRoomRoleBodyParams, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, /** * * @summary Create a new room @@ -21227,6 +21256,17 @@ export const RoomApiFactory = function (configuration?: Configuration, basePath? roomControllerAddMembers(roomId: string, addRoomMembersBodyParams: AddRoomMembersBodyParams, options?: any): AxiosPromise { return localVarFp.roomControllerAddMembers(roomId, addRoomMembersBodyParams, options).then((request) => request(axios, basePath)); }, + /** + * + * @summary Change the roles that members have within the room + * @param {string} roomId + * @param {ChangeRoomRoleBodyParams} changeRoomRoleBodyParams + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + roomControllerChangeRolesOfMembers(roomId: string, changeRoomRoleBodyParams: ChangeRoomRoleBodyParams, options?: any): AxiosPromise { + return localVarFp.roomControllerChangeRolesOfMembers(roomId, changeRoomRoleBodyParams, options).then((request) => request(axios, basePath)); + }, /** * * @summary Create a new room @@ -21330,6 +21370,17 @@ export interface RoomApiInterface { */ roomControllerAddMembers(roomId: string, addRoomMembersBodyParams: AddRoomMembersBodyParams, options?: any): AxiosPromise; + /** + * + * @summary Change the roles that members have within the room + * @param {string} roomId + * @param {ChangeRoomRoleBodyParams} changeRoomRoleBodyParams + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RoomApiInterface + */ + roomControllerChangeRolesOfMembers(roomId: string, changeRoomRoleBodyParams: ChangeRoomRoleBodyParams, options?: any): AxiosPromise; + /** * * @summary Create a new room @@ -21435,6 +21486,19 @@ export class RoomApi extends BaseAPI implements RoomApiInterface { return RoomApiFp(this.configuration).roomControllerAddMembers(roomId, addRoomMembersBodyParams, options).then((request) => request(this.axios, this.basePath)); } + /** + * + * @summary Change the roles that members have within the room + * @param {string} roomId + * @param {ChangeRoomRoleBodyParams} changeRoomRoleBodyParams + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RoomApi + */ + public roomControllerChangeRolesOfMembers(roomId: string, changeRoomRoleBodyParams: ChangeRoomRoleBodyParams, options?: any) { + return RoomApiFp(this.configuration).roomControllerChangeRolesOfMembers(roomId, changeRoomRoleBodyParams, options).then((request) => request(this.axios, this.basePath)); + } + /** * * @summary Create a new room @@ -22579,6 +22643,236 @@ export class SchoolApi extends BaseAPI implements SchoolApiInterface { } +/** + * ServerApi - axios parameter creator + * @export + */ +export const ServerApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * + * @summary Default route to test public access + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + serverControllerGetHello: async (options: any = {}): Promise => { + const localVarPath = `/`; + // 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: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * ServerApi - functional programming interface + * @export + */ +export const ServerApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = ServerApiAxiosParamCreator(configuration) + return { + /** + * + * @summary Default route to test public access + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async serverControllerGetHello(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.serverControllerGetHello(options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + } +}; + +/** + * ServerApi - factory interface + * @export + */ +export const ServerApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = ServerApiFp(configuration) + return { + /** + * + * @summary Default route to test public access + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + serverControllerGetHello(options?: any): AxiosPromise { + return localVarFp.serverControllerGetHello(options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * ServerApi - interface + * @export + * @interface ServerApi + */ +export interface ServerApiInterface { + /** + * + * @summary Default route to test public access + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ServerApiInterface + */ + serverControllerGetHello(options?: any): AxiosPromise; + +} + +/** + * ServerApi - object-oriented interface + * @export + * @class ServerApi + * @extends {BaseAPI} + */ +export class ServerApi extends BaseAPI implements ServerApiInterface { + /** + * + * @summary Default route to test public access + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ServerApi + */ + public serverControllerGetHello(options?: any) { + return ServerApiFp(this.configuration).serverControllerGetHello(options).then((request) => request(this.axios, this.basePath)); + } +} + + +/** + * ServerConfigApi - axios parameter creator + * @export + */ +export const ServerConfigApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * + * @summary Useable configuration for clients + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + serverConfigControllerPublicConfig: async (options: any = {}): Promise => { + const localVarPath = `/config/public`; + // 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: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * ServerConfigApi - functional programming interface + * @export + */ +export const ServerConfigApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = ServerConfigApiAxiosParamCreator(configuration) + return { + /** + * + * @summary Useable configuration for clients + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async serverConfigControllerPublicConfig(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.serverConfigControllerPublicConfig(options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + } +}; + +/** + * ServerConfigApi - factory interface + * @export + */ +export const ServerConfigApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = ServerConfigApiFp(configuration) + return { + /** + * + * @summary Useable configuration for clients + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + serverConfigControllerPublicConfig(options?: any): AxiosPromise { + return localVarFp.serverConfigControllerPublicConfig(options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * ServerConfigApi - interface + * @export + * @interface ServerConfigApi + */ +export interface ServerConfigApiInterface { + /** + * + * @summary Useable configuration for clients + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ServerConfigApiInterface + */ + serverConfigControllerPublicConfig(options?: any): AxiosPromise; + +} + +/** + * ServerConfigApi - object-oriented interface + * @export + * @class ServerConfigApi + * @extends {BaseAPI} + */ +export class ServerConfigApi extends BaseAPI implements ServerConfigApiInterface { + /** + * + * @summary Useable configuration for clients + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ServerConfigApi + */ + public serverConfigControllerPublicConfig(options?: any) { + return ServerConfigApiFp(this.configuration).serverConfigControllerPublicConfig(options).then((request) => request(this.axios, this.basePath)); + } +} + + /** * ShareTokenApi - axios parameter creator * @export @@ -23252,7 +23546,7 @@ export const SystemsApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * This endpoint is used to show users the possible login systems that exist. No sensible data should be returned! + * * @summary Finds all publicly available systems. * @param {SystemType} [types] The type of the system. * @param {*} [options] Override http request option. @@ -23287,7 +23581,7 @@ export const SystemsApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * This endpoint is used to get information about a possible login systems. No sensible data should be returned! + * * @summary Finds a publicly available system. * @param {string} systemId * @param {*} [options] Override http request option. @@ -23342,7 +23636,7 @@ export const SystemsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * This endpoint is used to show users the possible login systems that exist. No sensible data should be returned! + * * @summary Finds all publicly available systems. * @param {SystemType} [types] The type of the system. * @param {*} [options] Override http request option. @@ -23353,7 +23647,7 @@ export const SystemsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * This endpoint is used to get information about a possible login systems. No sensible data should be returned! + * * @summary Finds a publicly available system. * @param {string} systemId * @param {*} [options] Override http request option. @@ -23384,7 +23678,7 @@ export const SystemsApiFactory = function (configuration?: Configuration, basePa return localVarFp.systemControllerDeleteSystem(systemId, options).then((request) => request(axios, basePath)); }, /** - * This endpoint is used to show users the possible login systems that exist. No sensible data should be returned! + * * @summary Finds all publicly available systems. * @param {SystemType} [types] The type of the system. * @param {*} [options] Override http request option. @@ -23394,7 +23688,7 @@ export const SystemsApiFactory = function (configuration?: Configuration, basePa return localVarFp.systemControllerFind(types, options).then((request) => request(axios, basePath)); }, /** - * This endpoint is used to get information about a possible login systems. No sensible data should be returned! + * * @summary Finds a publicly available system. * @param {string} systemId * @param {*} [options] Override http request option. @@ -23423,7 +23717,7 @@ export interface SystemsApiInterface { systemControllerDeleteSystem(systemId: string, options?: any): AxiosPromise; /** - * This endpoint is used to show users the possible login systems that exist. No sensible data should be returned! + * * @summary Finds all publicly available systems. * @param {SystemType} [types] The type of the system. * @param {*} [options] Override http request option. @@ -23433,7 +23727,7 @@ export interface SystemsApiInterface { systemControllerFind(types?: SystemType, options?: any): AxiosPromise; /** - * This endpoint is used to get information about a possible login systems. No sensible data should be returned! + * * @summary Finds a publicly available system. * @param {string} systemId * @param {*} [options] Override http request option. @@ -23464,7 +23758,7 @@ export class SystemsApi extends BaseAPI implements SystemsApiInterface { } /** - * This endpoint is used to show users the possible login systems that exist. No sensible data should be returned! + * * @summary Finds all publicly available systems. * @param {SystemType} [types] The type of the system. * @param {*} [options] Override http request option. @@ -23476,7 +23770,7 @@ export class SystemsApi extends BaseAPI implements SystemsApiInterface { } /** - * This endpoint is used to get information about a possible login systems. No sensible data should be returned! + * * @summary Finds a publicly available system. * @param {string} systemId * @param {*} [options] Override http request option. From 8f43f1e7ecdaefdeddb5be3e9a56224182a62c58 Mon Sep 17 00:00:00 2001 From: "hoeppner.dataport" Date: Thu, 23 Jan 2025 16:11:30 +0100 Subject: [PATCH 2/4] chore: generate client --- src/serverApi/v3/api.ts | 122 +++++++++++++++++++++++++++++++++++----- 1 file changed, 107 insertions(+), 15 deletions(-) diff --git a/src/serverApi/v3/api.ts b/src/serverApi/v3/api.ts index 971e894de8..72582a7fef 100644 --- a/src/serverApi/v3/api.ts +++ b/src/serverApi/v3/api.ts @@ -1308,6 +1308,12 @@ export interface ConfigResponse { * @memberof ConfigResponse */ ACCESSIBILITY_REPORT_EMAIL: string; + /** + * + * @type {string} + * @memberof ConfigResponse + */ + SC_CONTACT_EMAIL: string; /** * * @type {boolean} @@ -1728,6 +1734,12 @@ export interface ConfigResponse { * @memberof ConfigResponse */ FEATURE_EXTERNAL_SYSTEM_LOGOUT_ENABLED: boolean; + /** + * + * @type {boolean} + * @memberof ConfigResponse + */ + FEATURE_VIDIS_MEDIA_ACTIVATIONS_ENABLED: boolean; } /** * @@ -4244,10 +4256,10 @@ export enum LaunchType { export interface LayoutBodyParams { /** * - * @type {MediaBoardLayoutType} + * @type {BoardLayout} * @memberof LayoutBodyParams */ - layout: MediaBoardLayoutType; + layout: BoardLayout; } /** * @@ -5420,17 +5432,6 @@ export enum MediaBoardColors { BlueGrey = 'blueGrey' } -/** - * - * @export - * @enum {string} - */ -export enum MediaBoardLayoutType { - Columns = 'columns', - List = 'list', - Grid = 'grid' -} - /** * * @export @@ -5457,10 +5458,10 @@ export interface MediaBoardResponse { timestamps: TimestampsResponse; /** * Layout of media board - * @type {MediaBoardLayoutType} + * @type {BoardLayout} * @memberof MediaBoardResponse */ - layout: MediaBoardLayoutType; + layout: BoardLayout; } /** * @@ -12412,6 +12413,50 @@ export const BoardApiAxiosParamCreator = function (configuration?: Configuration options: localVarRequestOptions, }; }, + /** + * + * @summary Update the layout of a board. + * @param {string} boardId The id of the board. + * @param {LayoutBodyParams} layoutBodyParams + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + boardControllerUpdateLayout: async (boardId: string, layoutBodyParams: LayoutBodyParams, options: any = {}): Promise => { + // verify required parameter 'boardId' is not null or undefined + assertParamExists('boardControllerUpdateLayout', 'boardId', boardId) + // verify required parameter 'layoutBodyParams' is not null or undefined + assertParamExists('boardControllerUpdateLayout', 'layoutBodyParams', layoutBodyParams) + const localVarPath = `/boards/{boardId}/layout` + .replace(`{${"boardId"}}`, encodeURIComponent(String(boardId))); + // 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: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication bearer required + // http bearer authentication required + await setBearerAuthToObject(localVarHeaderParameter, configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(layoutBodyParams, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, /** * * @summary Update the visibility of a board. @@ -12544,6 +12589,18 @@ export const BoardApiFp = function(configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.boardControllerUpdateBoardTitle(boardId, updateBoardTitleParams, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * + * @summary Update the layout of a board. + * @param {string} boardId The id of the board. + * @param {LayoutBodyParams} layoutBodyParams + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async boardControllerUpdateLayout(boardId: string, layoutBodyParams: LayoutBodyParams, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.boardControllerUpdateLayout(boardId, layoutBodyParams, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, /** * * @summary Update the visibility of a board. @@ -12637,6 +12694,17 @@ export const BoardApiFactory = function (configuration?: Configuration, basePath boardControllerUpdateBoardTitle(boardId: string, updateBoardTitleParams: UpdateBoardTitleParams, options?: any): AxiosPromise { return localVarFp.boardControllerUpdateBoardTitle(boardId, updateBoardTitleParams, options).then((request) => request(axios, basePath)); }, + /** + * + * @summary Update the layout of a board. + * @param {string} boardId The id of the board. + * @param {LayoutBodyParams} layoutBodyParams + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + boardControllerUpdateLayout(boardId: string, layoutBodyParams: LayoutBodyParams, options?: any): AxiosPromise { + return localVarFp.boardControllerUpdateLayout(boardId, layoutBodyParams, options).then((request) => request(axios, basePath)); + }, /** * * @summary Update the visibility of a board. @@ -12728,6 +12796,17 @@ export interface BoardApiInterface { */ boardControllerUpdateBoardTitle(boardId: string, updateBoardTitleParams: UpdateBoardTitleParams, options?: any): AxiosPromise; + /** + * + * @summary Update the layout of a board. + * @param {string} boardId The id of the board. + * @param {LayoutBodyParams} layoutBodyParams + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BoardApiInterface + */ + boardControllerUpdateLayout(boardId: string, layoutBodyParams: LayoutBodyParams, options?: any): AxiosPromise; + /** * * @summary Update the visibility of a board. @@ -12833,6 +12912,19 @@ export class BoardApi extends BaseAPI implements BoardApiInterface { return BoardApiFp(this.configuration).boardControllerUpdateBoardTitle(boardId, updateBoardTitleParams, options).then((request) => request(this.axios, this.basePath)); } + /** + * + * @summary Update the layout of a board. + * @param {string} boardId The id of the board. + * @param {LayoutBodyParams} layoutBodyParams + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BoardApi + */ + public boardControllerUpdateLayout(boardId: string, layoutBodyParams: LayoutBodyParams, options?: any) { + return BoardApiFp(this.configuration).boardControllerUpdateLayout(boardId, layoutBodyParams, options).then((request) => request(this.axios, this.basePath)); + } + /** * * @summary Update the visibility of a board. From 7c715e9bafd0e15ef6045cd95980aa749469c34f Mon Sep 17 00:00:00 2001 From: "hoeppner.dataport" Date: Thu, 23 Jan 2025 16:35:50 +0100 Subject: [PATCH 3/4] chore: fix incorrectly merged api.ts --- src/serverApi/v3/api.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/src/serverApi/v3/api.ts b/src/serverApi/v3/api.ts index 2f321e5a96..72582a7fef 100644 --- a/src/serverApi/v3/api.ts +++ b/src/serverApi/v3/api.ts @@ -5462,7 +5462,6 @@ export interface MediaBoardResponse { * @memberof MediaBoardResponse */ layout: BoardLayout; - layout: BoardLayout; } /** * From b081bffd1dd3bb63bbba920733adad20ab5727a6 Mon Sep 17 00:00:00 2001 From: "hoeppner.dataport" Date: Fri, 24 Jan 2025 09:05:06 +0100 Subject: [PATCH 4/4] fix problems due to SwaggerApi update --- src/store/env-config.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/store/env-config.ts b/src/store/env-config.ts index 2c489ea253..7ae3f1151b 100644 --- a/src/store/env-config.ts +++ b/src/store/env-config.ts @@ -5,8 +5,8 @@ import { } from "@/fileStorageApi/v3"; import { ConfigResponse, - DefaultApiFactory, - DefaultApiInterface, + ServerConfigApiFactory, + ServerConfigApiInterface, LanguageType, SchulcloudTheme, Timezone, @@ -184,8 +184,8 @@ export default class EnvConfigModule extends VuexModule { return this.env.FEATURE_SHOW_NEW_CLASS_VIEW_ENABLED; } - private get serverApi(): DefaultApiInterface { - const serverApi = DefaultApiFactory(undefined, "/v3", $axios); + private get serverApi(): ServerConfigApiInterface { + const serverApi = ServerConfigApiFactory(undefined, "/v3", $axios); return serverApi; }