Merge branch 'Issue/2881-messageController' into 'dev'

New: Message controller client

See merge request !115

.vscode/settings.json

 {
+  "workbench.colorCustomizations": {
+    "activityBar.background": "#678367",
+    "activityBar.foreground": "#dcdcdc",
+    "activityBar.inactiveForeground": "#384238",
+    "activityBar.activeBorder": "#384238",
+    "activityBarBadge.background": "#384238",
+    "activityBarBadge.foreground": "#dcdcdc"
+  },
   "search.exclude": {
     "**/.yarn": true,
     "**/.pnp.*": true

src/Coscine.Api/@coscine/api/maintenance-api.ts

@@ -66,6 +66,7 @@ export const MaintenanceApiAxiosParamCreator = function (configuration?: Configu
          * 
          * @summary Retrieves the current maintenance messages.
          * @param {*} [options] Override http request option.
+         * @deprecated
          * @throws {RequiredError}
          */
         getCurrentMaintenances: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
@@ -121,6 +122,7 @@ export const MaintenanceApiFp = function(configuration?: Configuration) {
          * 
          * @summary Retrieves the current maintenance messages.
          * @param {*} [options] Override http request option.
+         * @deprecated
          * @throws {RequiredError}
          */
         async getCurrentMaintenances(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MaintenanceDtoPagedResponse>> {
@@ -152,6 +154,7 @@ export const MaintenanceApiFactory = function (configuration?: Configuration, ba
          * 
          * @summary Retrieves the current maintenance messages.
          * @param {*} [options] Override http request option.
+         * @deprecated
          * @throws {RequiredError}
          */
         getCurrentMaintenances(options?: RawAxiosRequestConfig): AxiosPromise<MaintenanceDtoPagedResponse> {
@@ -182,6 +185,7 @@ export class MaintenanceApi extends BaseAPI {
      * 
      * @summary Retrieves the current maintenance messages.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof MaintenanceApi
      */

src/Coscine.Api/@coscine/model/index.ts

@@ -55,6 +55,9 @@ export * from './license-dto-response';
 export * from './license-for-resource-manipulation-dto';
 export * from './maintenance-dto';
 export * from './maintenance-dto-paged-response';
+export * from './message-dto';
+export * from './message-dto-paged-response';
+export * from './message-type';
 export * from './metadata-tree-dto';
 export * from './metadata-tree-dto-paged-response';
 export * from './metadata-tree-dto-response';

src/Coscine.Api/@coscine/model/message-dto-paged-response.ts

+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Coscine Web API
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { MessageDto } from './message-dto';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Pagination } from './pagination';
+
+/**
+ * 
+ * @export
+ * @interface MessageDtoPagedResponse
+ */
+export interface MessageDtoPagedResponse {
+    /**
+     * 
+     * @type {Array<MessageDto>}
+     * @memberof MessageDtoPagedResponse
+     */
+    'data'?: Array<MessageDto> | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof MessageDtoPagedResponse
+     */
+    'isSuccess'?: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof MessageDtoPagedResponse
+     */
+    'statusCode'?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof MessageDtoPagedResponse
+     */
+    'traceId'?: string | null;
+    /**
+     * 
+     * @type {Pagination}
+     * @memberof MessageDtoPagedResponse
+     */
+    'pagination'?: Pagination;
+}
+

src/Coscine.Api/@coscine/model/message-dto.ts

+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Coscine Web API
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { MessageType } from './message-type';
+
+/**
+ * 
+ * @export
+ * @interface MessageDto
+ */
+export interface MessageDto {
+    /**
+     * ID of the message.
+     * @type {string}
+     * @memberof MessageDto
+     */
+    'id'?: string;
+    /**
+     * Message body in multiple languages as key-value pairs.   The key is the ISO 639-1 Alpha-2 two-letter language code, and the value is the message in that language.
+     * @type {{ [key: string]: string; }}
+     * @memberof MessageDto
+     */
+    'body'?: { [key: string]: string; } | null;
+    /**
+     * 
+     * @type {MessageType}
+     * @memberof MessageDto
+     */
+    'type'?: MessageType;
+    /**
+     * Title of the message.
+     * @type {string}
+     * @memberof MessageDto
+     */
+    'title'?: string | null;
+    /**
+     * URL related to the message.
+     * @type {string}
+     * @memberof MessageDto
+     */
+    'href'?: string | null;
+    /**
+     * Start date of the message.
+     * @type {string}
+     * @memberof MessageDto
+     */
+    'startDate'?: string | null;
+    /**
+     * End date of the message.
+     * @type {string}
+     * @memberof MessageDto
+     */
+    'endDate'?: string | null;
+}
+
+
+

src/Coscine.Api/@coscine/model/message-type.ts

+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Coscine Web API
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Defines the various types of messages.
+ * @export
+ * @enum {string}
+ */
+
+export const MessageType = {
+    Disturbance: 'Disturbance',
+    PartialDisturbance: 'PartialDisturbance',
+    Maintenance: 'Maintenance',
+    PartialMaintenance: 'PartialMaintenance',
+    LimitedOperation: 'LimitedOperation',
+    Interruption: 'Interruption',
+    Change: 'Change',
+    Hint: 'Hint',
+    Warning: 'Warning',
+    Information: 'Information'
+} as const;
+
+export type MessageType = typeof MessageType[keyof typeof MessageType];
+
+
+

src/Coscine.Api/api.ts

@@ -40,6 +40,7 @@ export * from './@coscine/api/search-api';
 export * from './@coscine/api/self-api';
 export * from './@coscine/api/self-api-token-api';
 export * from './@coscine/api/self-session-api';
+export * from './@coscine/api/system-status-api';
 export * from './@coscine/api/title-api';
 export * from './@coscine/api/tos-api';
 export * from './@coscine/api/tree-api';

src/apis.ts

@@ -29,6 +29,7 @@ import {
   SelfApiFactory,
   SelfApiTokenApiFactory,
   SelfSessionApiFactory,
+  SystemStatusApiFactory,
   TitleApiFactory,
   TosApiFactory,
   TreeApiFactory,
@@ -103,6 +104,7 @@ function implementations(axios?: AxiosInstance) {
     SelfApiTokenApi: SelfApiTokenApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine', axios),
     SelfSessionApi: SelfSessionApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine', axios),
     ShibbolethApi: ShibbolethApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine/api/Coscine.Api.STS', axios),
+    SystemStatusApi: SystemStatusApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine', axios),
     TitleApi: TitleApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine', axios),
     TosApi: TosApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine', axios),
     TreeApi: TreeApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine', axios),

src/index.ts

@@ -33,6 +33,7 @@ export const SearchApi = apis.SearchApi;
 export const SelfApi = apis.SelfApi;
 export const SelfApiTokenApi = apis.SelfApiTokenApi;
 export const ShibbolethApi = apis.ShibbolethApi;
+export const SystemStatusApi = apis.SystemStatusApi;
 export const TitleApi = apis.TitleApi;
 export const TosApi = apis.TosApi;
 export const TreeApi = apis.TreeApi;