org.ow2.proactive.notification.client.api

Class NotificationRestApi

java.lang.Object

org.ow2.proactive.notification.client.api.NotificationRestApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-02-12T14:56:03.264844-05:00[America/New_York]")
public class NotificationRestApi
extends Object

Constructor Summary

Constructors

Constructor and Description
NotificationRestApi()
NotificationRestApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
Notification	deleteNotification(String sessionid, Long notificationId) Deletes a notification
ApiResponse<Notification>	deleteNotificationWithHttpInfo(String sessionid, Long notificationId) Deletes a notification
ApiClient	getApiClient() Get the API client
UnreadNotificationCount	getCategorizedUnreadNotificationsCount(String sessionid) Gets the unread notification count for a user for each subscription type
ApiResponse<UnreadNotificationCount>	getCategorizedUnreadNotificationsCountWithHttpInfo(String sessionid) Gets the unread notification count for a user for each subscription type
Map<String,List<EventTypeSeverityPair>>	getEventTypes(String sessionid) Gets the event groups and types
ApiResponse<Map<String,List<EventTypeSeverityPair>>>	getEventTypesWithHttpInfo(String sessionid) Gets the event groups and types
List<Notification>	getNotifications(String sessionid, String readStatus, Long beforeId, Long afterId, Integer limit, List<String> eventGroups, List<String> eventTypes, String bucketName, String projectName, String workflowName, Boolean myJobsOnly, String eventSeverities, String sortByElement, String sortByOrder, Set<String> channels, Long jobId) Gets user filtered notifications
ApiResponse<List<Notification>>	getNotificationsWithHttpInfo(String sessionid, String readStatus, Long beforeId, Long afterId, Integer limit, List<String> eventGroups, List<String> eventTypes, String bucketName, String projectName, String workflowName, Boolean myJobsOnly, String eventSeverities, String sortByElement, String sortByOrder, Set<String> channels, Long jobId) Gets user filtered notifications
Long	getUnreadNotificationsCount(String sessionid) Gets the unread notification count for a user
ApiResponse<Long>	getUnreadNotificationsCountWithHttpInfo(String sessionid) Gets the unread notification count for a user
Notification	removeUserFromNotification(String sessionid, Long notificationId) Removes a user from a notification
ApiResponse<Notification>	removeUserFromNotificationWithHttpInfo(String sessionid, Long notificationId) Removes a user from a notification
void	setApiClient(ApiClient apiClient) Set the API client
List<Notification>	updateHasReadStatus(String sessionid, Map<String,Boolean> requestBody) Flags a notification as read/not read
ApiResponse<List<Notification>>	updateHasReadStatusWithHttpInfo(String sessionid, Map<String,Boolean> requestBody) Flags a notification as read/not read

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NotificationRestApi

public NotificationRestApi()

NotificationRestApi

public NotificationRestApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

Get the API client

Returns:

API client

setApiClient

public void setApiClient(ApiClient apiClient)

Set the API client

Parameters:

apiClient - an instance of API client

deleteNotification

public Notification deleteNotification(String sessionid,
                                       Long notificationId)
                                throws ApiException

Deletes a notification

Parameters:

sessionid - (required)

notificationId - (required)

Returns:

Notification

Throws:

ApiException - if fails to make API call

deleteNotificationWithHttpInfo

public ApiResponse<Notification> deleteNotificationWithHttpInfo(String sessionid,
                                                                Long notificationId)
                                                         throws ApiException

Deletes a notification

Parameters:

sessionid - (required)

notificationId - (required)

Returns:

ApiResponse<Notification>

Throws:

ApiException - if fails to make API call

getCategorizedUnreadNotificationsCount

public UnreadNotificationCount getCategorizedUnreadNotificationsCount(String sessionid)
                                                               throws ApiException

Gets the unread notification count for a user for each subscription type

Parameters:

sessionid - (required)

Returns:

UnreadNotificationCount

Throws:

ApiException - if fails to make API call

getCategorizedUnreadNotificationsCountWithHttpInfo

public ApiResponse<UnreadNotificationCount> getCategorizedUnreadNotificationsCountWithHttpInfo(String sessionid)
                                                                                        throws ApiException

Gets the unread notification count for a user for each subscription type

Parameters:

sessionid - (required)

Returns:

ApiResponse<UnreadNotificationCount>

Throws:

ApiException - if fails to make API call

getEventTypes

public Map<String,List<EventTypeSeverityPair>> getEventTypes(String sessionid)
                                                      throws ApiException

Gets the event groups and types

Parameters:

sessionid - (required)

Returns:

Map<String, List<EventTypeSeverityPair>>

Throws:

ApiException - if fails to make API call

getEventTypesWithHttpInfo

public ApiResponse<Map<String,List<EventTypeSeverityPair>>> getEventTypesWithHttpInfo(String sessionid)
                                                                               throws ApiException

Gets the event groups and types

Parameters:

sessionid - (required)

Returns:

ApiResponse<Map<String, List<EventTypeSeverityPair>>>

Throws:

ApiException - if fails to make API call

getNotifications

public List<Notification> getNotifications(String sessionid,
                                           String readStatus,
                                           Long beforeId,
                                           Long afterId,
                                           Integer limit,
                                           List<String> eventGroups,
                                           List<String> eventTypes,
                                           String bucketName,
                                           String projectName,
                                           String workflowName,
                                           Boolean myJobsOnly,
                                           String eventSeverities,
                                           String sortByElement,
                                           String sortByOrder,
                                           Set<String> channels,
                                           Long jobId)
                                    throws ApiException

Gets user filtered notifications

Parameters:

sessionid - (required)

readStatus - (optional)

beforeId - (optional)

afterId - (optional)

limit - (optional)

eventGroups - (optional)

eventTypes - (optional)

bucketName - (optional)

projectName - (optional)

workflowName - (optional)

myJobsOnly - (optional)

eventSeverities - (optional)

sortByElement - (optional)

sortByOrder - (optional)

channels - (optional)

jobId - (optional)

Returns:

List<Notification>

Throws:

ApiException - if fails to make API call

getNotificationsWithHttpInfo

public ApiResponse<List<Notification>> getNotificationsWithHttpInfo(String sessionid,
                                                                    String readStatus,
                                                                    Long beforeId,
                                                                    Long afterId,
                                                                    Integer limit,
                                                                    List<String> eventGroups,
                                                                    List<String> eventTypes,
                                                                    String bucketName,
                                                                    String projectName,
                                                                    String workflowName,
                                                                    Boolean myJobsOnly,
                                                                    String eventSeverities,
                                                                    String sortByElement,
                                                                    String sortByOrder,
                                                                    Set<String> channels,
                                                                    Long jobId)
                                                             throws ApiException

Gets user filtered notifications

Parameters:

sessionid - (required)

readStatus - (optional)

beforeId - (optional)

afterId - (optional)

limit - (optional)

eventGroups - (optional)

eventTypes - (optional)

bucketName - (optional)

projectName - (optional)

workflowName - (optional)

myJobsOnly - (optional)

eventSeverities - (optional)

sortByElement - (optional)

sortByOrder - (optional)

channels - (optional)

jobId - (optional)

Returns:

ApiResponse<List<Notification>>

Throws:

ApiException - if fails to make API call

getUnreadNotificationsCount

public Long getUnreadNotificationsCount(String sessionid)
                                 throws ApiException

Gets the unread notification count for a user

Parameters:

sessionid - (required)

Returns:

Long

Throws:

ApiException - if fails to make API call

getUnreadNotificationsCountWithHttpInfo

public ApiResponse<Long> getUnreadNotificationsCountWithHttpInfo(String sessionid)
                                                          throws ApiException

Gets the unread notification count for a user

Parameters:

sessionid - (required)

Returns:

ApiResponse<Long>

Throws:

ApiException - if fails to make API call

removeUserFromNotification

public Notification removeUserFromNotification(String sessionid,
                                               Long notificationId)
                                        throws ApiException

Removes a user from a notification

Parameters:

sessionid - (required)

notificationId - (required)

Returns:

Notification

Throws:

ApiException - if fails to make API call

removeUserFromNotificationWithHttpInfo

public ApiResponse<Notification> removeUserFromNotificationWithHttpInfo(String sessionid,
                                                                        Long notificationId)
                                                                 throws ApiException

Removes a user from a notification

Parameters:

sessionid - (required)

notificationId - (required)

Returns:

ApiResponse<Notification>

Throws:

ApiException - if fails to make API call

updateHasReadStatus

public List<Notification> updateHasReadStatus(String sessionid,
                                              Map<String,Boolean> requestBody)
                                       throws ApiException

Flags a notification as read/not read

Parameters:

sessionid - (required)

requestBody - (required)

Returns:

List<Notification>

Throws:

ApiException - if fails to make API call

updateHasReadStatusWithHttpInfo

public ApiResponse<List<Notification>> updateHasReadStatusWithHttpInfo(String sessionid,
                                                                       Map<String,Boolean> requestBody)
                                                                throws ApiException

Flags a notification as read/not read

Parameters:

sessionid - (required)

requestBody - (required)

Returns:

ApiResponse<List<Notification>>

Throws:

ApiException - if fails to make API call