@halo-dev/api-client 2.15.0 → 2.17.0

package/dist/src/api/notification-v1alpha1-uc-api.d.ts

@@ -0,0 +1,363 @@
+import { Configuration } from '../configuration';
+import { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { RequestArgs, BaseAPI } from '../base';
+import { MarkSpecifiedRequest, Notification, NotificationList, ReasonTypeNotifierCollectionRequest, ReasonTypeNotifierMatrix } from '../models';
+
+/**
+ * NotificationV1alpha1UcApi - axios parameter creator
+ * @export
+ */
+export declare const NotificationV1alpha1UcApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Delete the specified notification.
+     * @param {string} username Username
+     * @param {string} name Notification name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteSpecifiedNotification: (username: string, name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List notification preferences for the authenticated user.
+     * @param {string} username Username
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUserNotificationPreferences: (username: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List notifications for the authenticated user.
+     * @param {string} username Username
+     * @param {number} [page] Page number. Default is 0.
+     * @param {number} [size] Size number. Default is 0.
+     * @param {Array<string>} [labelSelector] Label selector. e.g.: hidden!&#x3D;true
+     * @param {Array<string>} [fieldSelector] Field selector. e.g.: metadata.name&#x3D;&#x3D;halo
+     * @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
+     * @param {string} [keyword] Keyword
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUserNotifications: (username: string, page?: number, size?: number, labelSelector?: Array<string>, fieldSelector?: Array<string>, sort?: Array<string>, keyword?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Mark the specified notification as read.
+     * @param {string} username Username
+     * @param {string} name Notification name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markNotificationAsRead: (username: string, name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Mark the specified notifications as read.
+     * @param {string} username Username
+     * @param {MarkSpecifiedRequest} markSpecifiedRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markNotificationsAsRead: (username: string, markSpecifiedRequest: MarkSpecifiedRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Save notification preferences for the authenticated user.
+     * @param {string} username Username
+     * @param {ReasonTypeNotifierCollectionRequest} [reasonTypeNotifierCollectionRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    saveUserNotificationPreferences: (username: string, reasonTypeNotifierCollectionRequest?: ReasonTypeNotifierCollectionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * NotificationV1alpha1UcApi - functional programming interface
+ * @export
+ */
+export declare const NotificationV1alpha1UcApiFp: (configuration?: Configuration) => {
+    /**
+     * Delete the specified notification.
+     * @param {string} username Username
+     * @param {string} name Notification name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteSpecifiedNotification(username: string, name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>>;
+    /**
+     * List notification preferences for the authenticated user.
+     * @param {string} username Username
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUserNotificationPreferences(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReasonTypeNotifierMatrix>>;
+    /**
+     * List notifications for the authenticated user.
+     * @param {string} username Username
+     * @param {number} [page] Page number. Default is 0.
+     * @param {number} [size] Size number. Default is 0.
+     * @param {Array<string>} [labelSelector] Label selector. e.g.: hidden!&#x3D;true
+     * @param {Array<string>} [fieldSelector] Field selector. e.g.: metadata.name&#x3D;&#x3D;halo
+     * @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
+     * @param {string} [keyword] Keyword
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUserNotifications(username: string, page?: number, size?: number, labelSelector?: Array<string>, fieldSelector?: Array<string>, sort?: Array<string>, keyword?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationList>>;
+    /**
+     * Mark the specified notification as read.
+     * @param {string} username Username
+     * @param {string} name Notification name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markNotificationAsRead(username: string, name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>>;
+    /**
+     * Mark the specified notifications as read.
+     * @param {string} username Username
+     * @param {MarkSpecifiedRequest} markSpecifiedRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markNotificationsAsRead(username: string, markSpecifiedRequest: MarkSpecifiedRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
+    /**
+     * Save notification preferences for the authenticated user.
+     * @param {string} username Username
+     * @param {ReasonTypeNotifierCollectionRequest} [reasonTypeNotifierCollectionRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    saveUserNotificationPreferences(username: string, reasonTypeNotifierCollectionRequest?: ReasonTypeNotifierCollectionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReasonTypeNotifierMatrix>>;
+};
+/**
+ * NotificationV1alpha1UcApi - factory interface
+ * @export
+ */
+export declare const NotificationV1alpha1UcApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Delete the specified notification.
+     * @param {NotificationV1alpha1UcApiDeleteSpecifiedNotificationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteSpecifiedNotification(requestParameters: NotificationV1alpha1UcApiDeleteSpecifiedNotificationRequest, options?: RawAxiosRequestConfig): AxiosPromise<Notification>;
+    /**
+     * List notification preferences for the authenticated user.
+     * @param {NotificationV1alpha1UcApiListUserNotificationPreferencesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUserNotificationPreferences(requestParameters: NotificationV1alpha1UcApiListUserNotificationPreferencesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReasonTypeNotifierMatrix>;
+    /**
+     * List notifications for the authenticated user.
+     * @param {NotificationV1alpha1UcApiListUserNotificationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUserNotifications(requestParameters: NotificationV1alpha1UcApiListUserNotificationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<NotificationList>;
+    /**
+     * Mark the specified notification as read.
+     * @param {NotificationV1alpha1UcApiMarkNotificationAsReadRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markNotificationAsRead(requestParameters: NotificationV1alpha1UcApiMarkNotificationAsReadRequest, options?: RawAxiosRequestConfig): AxiosPromise<Notification>;
+    /**
+     * Mark the specified notifications as read.
+     * @param {NotificationV1alpha1UcApiMarkNotificationsAsReadRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markNotificationsAsRead(requestParameters: NotificationV1alpha1UcApiMarkNotificationsAsReadRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
+    /**
+     * Save notification preferences for the authenticated user.
+     * @param {NotificationV1alpha1UcApiSaveUserNotificationPreferencesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    saveUserNotificationPreferences(requestParameters: NotificationV1alpha1UcApiSaveUserNotificationPreferencesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReasonTypeNotifierMatrix>;
+};
+/**
+ * Request parameters for deleteSpecifiedNotification operation in NotificationV1alpha1UcApi.
+ * @export
+ * @interface NotificationV1alpha1UcApiDeleteSpecifiedNotificationRequest
+ */
+export interface NotificationV1alpha1UcApiDeleteSpecifiedNotificationRequest {
+    /**
+     * Username
+     * @type {string}
+     * @memberof NotificationV1alpha1UcApiDeleteSpecifiedNotification
+     */
+    readonly username: string;
+    /**
+     * Notification name
+     * @type {string}
+     * @memberof NotificationV1alpha1UcApiDeleteSpecifiedNotification
+     */
+    readonly name: string;
+}
+/**
+ * Request parameters for listUserNotificationPreferences operation in NotificationV1alpha1UcApi.
+ * @export
+ * @interface NotificationV1alpha1UcApiListUserNotificationPreferencesRequest
+ */
+export interface NotificationV1alpha1UcApiListUserNotificationPreferencesRequest {
+    /**
+     * Username
+     * @type {string}
+     * @memberof NotificationV1alpha1UcApiListUserNotificationPreferences
+     */
+    readonly username: string;
+}
+/**
+ * Request parameters for listUserNotifications operation in NotificationV1alpha1UcApi.
+ * @export
+ * @interface NotificationV1alpha1UcApiListUserNotificationsRequest
+ */
+export interface NotificationV1alpha1UcApiListUserNotificationsRequest {
+    /**
+     * Username
+     * @type {string}
+     * @memberof NotificationV1alpha1UcApiListUserNotifications
+     */
+    readonly username: string;
+    /**
+     * Page number. Default is 0.
+     * @type {number}
+     * @memberof NotificationV1alpha1UcApiListUserNotifications
+     */
+    readonly page?: number;
+    /**
+     * Size number. Default is 0.
+     * @type {number}
+     * @memberof NotificationV1alpha1UcApiListUserNotifications
+     */
+    readonly size?: number;
+    /**
+     * Label selector. e.g.: hidden!&#x3D;true
+     * @type {Array<string>}
+     * @memberof NotificationV1alpha1UcApiListUserNotifications
+     */
+    readonly labelSelector?: Array<string>;
+    /**
+     * Field selector. e.g.: metadata.name&#x3D;&#x3D;halo
+     * @type {Array<string>}
+     * @memberof NotificationV1alpha1UcApiListUserNotifications
+     */
+    readonly fieldSelector?: Array<string>;
+    /**
+     * Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
+     * @type {Array<string>}
+     * @memberof NotificationV1alpha1UcApiListUserNotifications
+     */
+    readonly sort?: Array<string>;
+    /**
+     * Keyword
+     * @type {string}
+     * @memberof NotificationV1alpha1UcApiListUserNotifications
+     */
+    readonly keyword?: string;
+}
+/**
+ * Request parameters for markNotificationAsRead operation in NotificationV1alpha1UcApi.
+ * @export
+ * @interface NotificationV1alpha1UcApiMarkNotificationAsReadRequest
+ */
+export interface NotificationV1alpha1UcApiMarkNotificationAsReadRequest {
+    /**
+     * Username
+     * @type {string}
+     * @memberof NotificationV1alpha1UcApiMarkNotificationAsRead
+     */
+    readonly username: string;
+    /**
+     * Notification name
+     * @type {string}
+     * @memberof NotificationV1alpha1UcApiMarkNotificationAsRead
+     */
+    readonly name: string;
+}
+/**
+ * Request parameters for markNotificationsAsRead operation in NotificationV1alpha1UcApi.
+ * @export
+ * @interface NotificationV1alpha1UcApiMarkNotificationsAsReadRequest
+ */
+export interface NotificationV1alpha1UcApiMarkNotificationsAsReadRequest {
+    /**
+     * Username
+     * @type {string}
+     * @memberof NotificationV1alpha1UcApiMarkNotificationsAsRead
+     */
+    readonly username: string;
+    /**
+     *
+     * @type {MarkSpecifiedRequest}
+     * @memberof NotificationV1alpha1UcApiMarkNotificationsAsRead
+     */
+    readonly markSpecifiedRequest: MarkSpecifiedRequest;
+}
+/**
+ * Request parameters for saveUserNotificationPreferences operation in NotificationV1alpha1UcApi.
+ * @export
+ * @interface NotificationV1alpha1UcApiSaveUserNotificationPreferencesRequest
+ */
+export interface NotificationV1alpha1UcApiSaveUserNotificationPreferencesRequest {
+    /**
+     * Username
+     * @type {string}
+     * @memberof NotificationV1alpha1UcApiSaveUserNotificationPreferences
+     */
+    readonly username: string;
+    /**
+     *
+     * @type {ReasonTypeNotifierCollectionRequest}
+     * @memberof NotificationV1alpha1UcApiSaveUserNotificationPreferences
+     */
+    readonly reasonTypeNotifierCollectionRequest?: ReasonTypeNotifierCollectionRequest;
+}
+/**
+ * NotificationV1alpha1UcApi - object-oriented interface
+ * @export
+ * @class NotificationV1alpha1UcApi
+ * @extends {BaseAPI}
+ */
+export declare class NotificationV1alpha1UcApi extends BaseAPI {
+    /**
+     * Delete the specified notification.
+     * @param {NotificationV1alpha1UcApiDeleteSpecifiedNotificationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationV1alpha1UcApi
+     */
+    deleteSpecifiedNotification(requestParameters: NotificationV1alpha1UcApiDeleteSpecifiedNotificationRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<Notification, any>>;
+    /**
+     * List notification preferences for the authenticated user.
+     * @param {NotificationV1alpha1UcApiListUserNotificationPreferencesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationV1alpha1UcApi
+     */
+    listUserNotificationPreferences(requestParameters: NotificationV1alpha1UcApiListUserNotificationPreferencesRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<ReasonTypeNotifierMatrix, any>>;
+    /**
+     * List notifications for the authenticated user.
+     * @param {NotificationV1alpha1UcApiListUserNotificationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationV1alpha1UcApi
+     */
+    listUserNotifications(requestParameters: NotificationV1alpha1UcApiListUserNotificationsRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<NotificationList, any>>;
+    /**
+     * Mark the specified notification as read.
+     * @param {NotificationV1alpha1UcApiMarkNotificationAsReadRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationV1alpha1UcApi
+     */
+    markNotificationAsRead(requestParameters: NotificationV1alpha1UcApiMarkNotificationAsReadRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<Notification, any>>;
+    /**
+     * Mark the specified notifications as read.
+     * @param {NotificationV1alpha1UcApiMarkNotificationsAsReadRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationV1alpha1UcApi
+     */
+    markNotificationsAsRead(requestParameters: NotificationV1alpha1UcApiMarkNotificationsAsReadRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<string[], any>>;
+    /**
+     * Save notification preferences for the authenticated user.
+     * @param {NotificationV1alpha1UcApiSaveUserNotificationPreferencesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationV1alpha1UcApi
+     */
+    saveUserNotificationPreferences(requestParameters: NotificationV1alpha1UcApiSaveUserNotificationPreferencesRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<ReasonTypeNotifierMatrix, any>>;
+}