liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
36 lines (35 loc) • 2.75 kB
TypeScript
import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
import type { GetMyUserNotificationsPageData, GetMyUserNotificationsPageResponses, GetUserAccountUserNotificationsPageData, GetUserAccountUserNotificationsPageResponses, GetUserNotificationData, GetUserNotificationResponses, PutUserNotificationReadData, PutUserNotificationReadResponses, PutUserNotificationUnreadData, PutUserNotificationUnreadResponses } from './types.gen';
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
/**
* You can provide a client instance returned by `createClient()` instead of
* individual options. This might be also useful if you want to implement a
* custom client.
*/
client?: Client;
/**
* You can pass arbitrary values through the `meta` object. This can be
* used to access values that aren't defined as part of the SDK function.
*/
meta?: Record<string, unknown>;
};
/**
* Retrieves the current user's notifications. Results can be paginated, filtered, searched and sorted.
*/
export declare const getMyUserNotificationsPage: <ThrowOnError extends boolean = false>(options?: Options<GetMyUserNotificationsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetMyUserNotificationsPageResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the user account's notifications. Results can be paginated, filtered, searched and sorted.
*/
export declare const getUserAccountUserNotificationsPage: <ThrowOnError extends boolean = false>(options: Options<GetUserAccountUserNotificationsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetUserAccountUserNotificationsPageResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the user notification.
*/
export declare const getUserNotification: <ThrowOnError extends boolean = false>(options: Options<GetUserNotificationData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetUserNotificationResponses, unknown, ThrowOnError, "fields">;
/**
* Mark the user notification as read.
*/
export declare const putUserNotificationRead: <ThrowOnError extends boolean = false>(options: Options<PutUserNotificationReadData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutUserNotificationReadResponses, unknown, ThrowOnError, "fields">;
/**
* Mark the user notification as unread.
*/
export declare const putUserNotificationUnread: <ThrowOnError extends boolean = false>(options: Options<PutUserNotificationUnreadData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutUserNotificationUnreadResponses, unknown, ThrowOnError, "fields">;