@coscine/api-client 3.21.0 → 3.22.0

package/dist/types/Coscine.Api/@coscine/api/system-status-api.d.ts

@@ -12,10 +12,12 @@
 import type { Configuration } from '../../configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import { type RequestArgs, BaseAPI } from '../../base';
+import type { MessageDto } from '../../@coscine/model';
 import type { MessageDtoPagedResponse } from '../../@coscine/model';
 import type { MessageType } from '../../@coscine/model';
 /**
  * SystemStatusApi - axios parameter creator
+ * @export
  */
 export declare const SystemStatusApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -25,6 +27,13 @@ export declare const SystemStatusApiAxiosParamCreator: (configuration?: Configur
      * @throws {RequiredError}
      */
     apiV2SystemStatusOptions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Retrieves the NOC messages.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getActiveNocMessages: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Retrieves the internal messages.
@@ -44,22 +53,17 @@ export declare const SystemStatusApiAxiosParamCreator: (configuration?: Configur
     /**
      *
      * @summary Retrieves the NOC messages.
-     * @param {string} [startDateAfter] Will only return messages that have their start date after this date (UTC).
-     * @param {string} [startDateBefore] Will only return messages that have their start date before this date (UTC).
-     * @param {string} [endDateAfter] Will only return messages that have their end date after this date (UTC).
-     * @param {string} [endDateBefore] Will only return messages that have their end date before this date (UTC).
-     * @param {MessageType} [type] Filter messages by their type  (e.g. information, warning, error).
-     * @param {string} [searchTerm] Filter messages by text contained in the messages or title.
      * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
      * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
      * @param {string} [orderBy] Gets or sets the field name used for ordering the results.  The order is constructed by an order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getNocMessages: (startDateAfter?: string, startDateBefore?: string, endDateAfter?: string, endDateBefore?: string, type?: MessageType, searchTerm?: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getNocMessages: (pageNumber?: number, pageSize?: number, orderBy?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * SystemStatusApi - functional programming interface
+ * @export
  */
 export declare const SystemStatusApiFp: (configuration?: Configuration) => {
     /**
@@ -69,6 +73,13 @@ export declare const SystemStatusApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     apiV2SystemStatusOptions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Retrieves the NOC messages.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getActiveNocMessages(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MessageDto>>>;
     /**
      *
      * @summary Retrieves the internal messages.
@@ -88,22 +99,17 @@ export declare const SystemStatusApiFp: (configuration?: Configuration) => {
     /**
      *
      * @summary Retrieves the NOC messages.
-     * @param {string} [startDateAfter] Will only return messages that have their start date after this date (UTC).
-     * @param {string} [startDateBefore] Will only return messages that have their start date before this date (UTC).
-     * @param {string} [endDateAfter] Will only return messages that have their end date after this date (UTC).
-     * @param {string} [endDateBefore] Will only return messages that have their end date before this date (UTC).
-     * @param {MessageType} [type] Filter messages by their type  (e.g. information, warning, error).
-     * @param {string} [searchTerm] Filter messages by text contained in the messages or title.
      * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
      * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
      * @param {string} [orderBy] Gets or sets the field name used for ordering the results.  The order is constructed by an order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getNocMessages(startDateAfter?: string, startDateBefore?: string, endDateAfter?: string, endDateBefore?: string, type?: MessageType, searchTerm?: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageDtoPagedResponse>>;
+    getNocMessages(pageNumber?: number, pageSize?: number, orderBy?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageDtoPagedResponse>>;
 };
 /**
  * SystemStatusApi - factory interface
+ * @export
  */
 export declare const SystemStatusApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -113,6 +119,13 @@ export declare const SystemStatusApiFactory: (configuration?: Configuration, bas
      * @throws {RequiredError}
      */
     apiV2SystemStatusOptions(options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Retrieves the NOC messages.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getActiveNocMessages(options?: RawAxiosRequestConfig): AxiosPromise<Array<MessageDto>>;
     /**
      *
      * @summary Retrieves the internal messages.
@@ -132,88 +145,95 @@ export declare const SystemStatusApiFactory: (configuration?: Configuration, bas
 };
 /**
  * Request parameters for getInternalMessages operation in SystemStatusApi.
+ * @export
+ * @interface SystemStatusApiGetInternalMessagesRequest
  */
 export interface SystemStatusApiGetInternalMessagesRequest {
     /**
      * Will only return messages that have their start date after this date (UTC).
+     * @type {string}
+     * @memberof SystemStatusApiGetInternalMessages
      */
     readonly startDateAfter?: string;
     /**
      * Will only return messages that have their start date before this date (UTC).
+     * @type {string}
+     * @memberof SystemStatusApiGetInternalMessages
      */
     readonly startDateBefore?: string;
     /**
      * Will only return messages that have their end date after this date (UTC).
+     * @type {string}
+     * @memberof SystemStatusApiGetInternalMessages
      */
     readonly endDateAfter?: string;
     /**
      * Will only return messages that have their end date before this date (UTC).
+     * @type {string}
+     * @memberof SystemStatusApiGetInternalMessages
      */
     readonly endDateBefore?: string;
     /**
      * Filter messages by their type  (e.g. information, warning, error).
+     * @type {MessageType}
+     * @memberof SystemStatusApiGetInternalMessages
      */
     readonly type?: MessageType;
     /**
      * Filter messages by text contained in the messages or title.
+     * @type {string}
+     * @memberof SystemStatusApiGetInternalMessages
      */
     readonly searchTerm?: string;
     /**
      * The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @type {number}
+     * @memberof SystemStatusApiGetInternalMessages
      */
     readonly pageNumber?: number;
     /**
      * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @type {number}
+     * @memberof SystemStatusApiGetInternalMessages
      */
     readonly pageSize?: number;
     /**
      * Gets or sets the field name used for ordering the results.  The order is constructed by an order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
+     * @type {string}
+     * @memberof SystemStatusApiGetInternalMessages
      */
     readonly orderBy?: string;
 }
 /**
  * Request parameters for getNocMessages operation in SystemStatusApi.
+ * @export
+ * @interface SystemStatusApiGetNocMessagesRequest
  */
 export interface SystemStatusApiGetNocMessagesRequest {
-    /**
-     * Will only return messages that have their start date after this date (UTC).
-     */
-    readonly startDateAfter?: string;
-    /**
-     * Will only return messages that have their start date before this date (UTC).
-     */
-    readonly startDateBefore?: string;
-    /**
-     * Will only return messages that have their end date after this date (UTC).
-     */
-    readonly endDateAfter?: string;
-    /**
-     * Will only return messages that have their end date before this date (UTC).
-     */
-    readonly endDateBefore?: string;
-    /**
-     * Filter messages by their type  (e.g. information, warning, error).
-     */
-    readonly type?: MessageType;
-    /**
-     * Filter messages by text contained in the messages or title.
-     */
-    readonly searchTerm?: string;
     /**
      * The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @type {number}
+     * @memberof SystemStatusApiGetNocMessages
      */
     readonly pageNumber?: number;
     /**
      * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @type {number}
+     * @memberof SystemStatusApiGetNocMessages
      */
     readonly pageSize?: number;
     /**
      * Gets or sets the field name used for ordering the results.  The order is constructed by an order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
+     * @type {string}
+     * @memberof SystemStatusApiGetNocMessages
      */
     readonly orderBy?: string;
 }
 /**
  * SystemStatusApi - object-oriented interface
+ * @export
+ * @class SystemStatusApi
+ * @extends {BaseAPI}
  */
 export declare class SystemStatusApi extends BaseAPI {
     /**
@@ -221,14 +241,24 @@ export declare class SystemStatusApi extends BaseAPI {
      * @summary Responds with the HTTP methods allowed for the endpoint.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof SystemStatusApi
      */
     apiV2SystemStatusOptions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @summary Retrieves the NOC messages.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SystemStatusApi
+     */
+    getActiveNocMessages(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageDto[], any>>;
     /**
      *
      * @summary Retrieves the internal messages.
      * @param {SystemStatusApiGetInternalMessagesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof SystemStatusApi
      */
     getInternalMessages(requestParameters?: SystemStatusApiGetInternalMessagesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageDtoPagedResponse, any>>;
     /**
@@ -237,6 +267,7 @@ export declare class SystemStatusApi extends BaseAPI {
      * @param {SystemStatusApiGetNocMessagesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof SystemStatusApi
      */
     getNocMessages(requestParameters?: SystemStatusApiGetNocMessagesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageDtoPagedResponse, any>>;
 }

package/dist/types/Coscine.Api/@coscine/api/title-api.d.ts

@@ -16,6 +16,7 @@ import type { TitleDtoIEnumerableResponse } from '../../@coscine/model';
 import type { TitleDtoResponse } from '../../@coscine/model';
 /**
  * TitleApi - axios parameter creator
+ * @export
  */
 export declare const TitleApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -46,6 +47,7 @@ export declare const TitleApiAxiosParamCreator: (configuration?: Configuration)
 };
 /**
  * TitleApi - functional programming interface
+ * @export
  */
 export declare const TitleApiFp: (configuration?: Configuration) => {
     /**
@@ -76,6 +78,7 @@ export declare const TitleApiFp: (configuration?: Configuration) => {
 };
 /**
  * TitleApi - factory interface
+ * @export
  */
 export declare const TitleApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -104,32 +107,47 @@ export declare const TitleApiFactory: (configuration?: Configuration, basePath?:
 };
 /**
  * Request parameters for getTitle operation in TitleApi.
+ * @export
+ * @interface TitleApiGetTitleRequest
  */
 export interface TitleApiGetTitleRequest {
     /**
      * The ID of the title.
+     * @type {string}
+     * @memberof TitleApiGetTitle
      */
     readonly titleId: string;
 }
 /**
  * Request parameters for getTitles operation in TitleApi.
+ * @export
+ * @interface TitleApiGetTitlesRequest
  */
 export interface TitleApiGetTitlesRequest {
     /**
      * The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @type {number}
+     * @memberof TitleApiGetTitles
      */
     readonly pageNumber?: number;
     /**
      * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @type {number}
+     * @memberof TitleApiGetTitles
      */
     readonly pageSize?: number;
     /**
      * Gets or sets the field name used for ordering the results.  The order is constructed by an order string.  Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.
+     * @type {string}
+     * @memberof TitleApiGetTitles
      */
     readonly orderBy?: string;
 }
 /**
  * TitleApi - object-oriented interface
+ * @export
+ * @class TitleApi
+ * @extends {BaseAPI}
  */
 export declare class TitleApi extends BaseAPI {
     /**
@@ -137,6 +155,7 @@ export declare class TitleApi extends BaseAPI {
      * @summary Responds with the HTTP methods allowed for the endpoint.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof TitleApi
      */
     apiV2TitlesOptions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
@@ -145,6 +164,7 @@ export declare class TitleApi extends BaseAPI {
      * @param {TitleApiGetTitleRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof TitleApi
      */
     getTitle(requestParameters: TitleApiGetTitleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TitleDtoResponse, any>>;
     /**
@@ -153,6 +173,7 @@ export declare class TitleApi extends BaseAPI {
      * @param {TitleApiGetTitlesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof TitleApi
      */
     getTitles(requestParameters?: TitleApiGetTitlesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TitleDtoIEnumerableResponse, any>>;
 }

package/dist/types/Coscine.Api/@coscine/api/tos-api.d.ts

@@ -15,6 +15,7 @@ import { type RequestArgs, BaseAPI } from '../../base';
 import type { TermsOfServiceDtoResponse } from '../../@coscine/model';
 /**
  * TosApi - axios parameter creator
+ * @export
  */
 export declare const TosApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -34,6 +35,7 @@ export declare const TosApiAxiosParamCreator: (configuration?: Configuration) =>
 };
 /**
  * TosApi - functional programming interface
+ * @export
  */
 export declare const TosApiFp: (configuration?: Configuration) => {
     /**
@@ -53,6 +55,7 @@ export declare const TosApiFp: (configuration?: Configuration) => {
 };
 /**
  * TosApi - factory interface
+ * @export
  */
 export declare const TosApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -72,6 +75,9 @@ export declare const TosApiFactory: (configuration?: Configuration, basePath?: s
 };
 /**
  * TosApi - object-oriented interface
+ * @export
+ * @class TosApi
+ * @extends {BaseAPI}
  */
 export declare class TosApi extends BaseAPI {
     /**
@@ -79,6 +85,7 @@ export declare class TosApi extends BaseAPI {
      * @summary Responds with the HTTP methods allowed for the endpoint.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof TosApi
      */
     apiV2TosOptions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
@@ -86,6 +93,7 @@ export declare class TosApi extends BaseAPI {
      * @summary Retrieves the current Terms of Service version.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof TosApi
      */
     getTos(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TermsOfServiceDtoResponse, any>>;
 }