org.ow2.proactive.notification.client.api

Class UserSubscriptionsRestApi

java.lang.Object

org.ow2.proactive.notification.client.api.UserSubscriptionsRestApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-01-21T13:55:10.013685-05:00[America/New_York]")
public class UserSubscriptionsRestApi
extends Object

Constructor Summary

Constructors

Constructor and Description
UserSubscriptionsRestApi()
UserSubscriptionsRestApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
UserSettings	confirmNotificationMethod(String sessionid, String token, String notificationMethod) Confirms a notification method parameter to be used as recipient for notifications
ApiResponse<UserSettings>	confirmNotificationMethodWithHttpInfo(String sessionid, String token, String notificationMethod) Confirms a notification method parameter to be used as recipient for notifications
UserSubscriptions	deleteUserSubscriptions(String sessionid) Deletes a userSubscriptions
ApiResponse<UserSubscriptions>	deleteUserSubscriptionsWithHttpInfo(String sessionid) Deletes a userSubscriptions
ApiClient	getApiClient() Get the API client
UserSubscriptionsResponse	getUserSubscriptions(String sessionid) Gets the users userSubscriptions
ApiResponse<UserSubscriptionsResponse>	getUserSubscriptionsWithHttpInfo(String sessionid) Gets the users userSubscriptions
UserSettings	resendNotificationMethodConfirmation(String sessionid, String data, String notificationMethod) Resends a notification method confirmation request
ApiResponse<UserSettings>	resendNotificationMethodConfirmationWithHttpInfo(String sessionid, String data, String notificationMethod) Resends a notification method confirmation request
void	setApiClient(ApiClient apiClient) Set the API client
UserSettings	updateUserSettings(String sessionid, UserSettings userSettings) updates a userSubscriptions user settings
ApiResponse<UserSettings>	updateUserSettingsWithHttpInfo(String sessionid, UserSettings userSettings) updates a userSubscriptions user settings

Methods inherited from class java.lang.Object

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

Constructor Detail

UserSubscriptionsRestApi

public UserSubscriptionsRestApi()

UserSubscriptionsRestApi

public UserSubscriptionsRestApi(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

confirmNotificationMethod

public UserSettings confirmNotificationMethod(String sessionid,
                                              String token,
                                              String notificationMethod)
                                       throws ApiException

Confirms a notification method parameter to be used as recipient for notifications

Parameters:

sessionid - (required)

token - (required)

notificationMethod - (required)

Returns:

UserSettings

Throws:

ApiException - if fails to make API call

confirmNotificationMethodWithHttpInfo

public ApiResponse<UserSettings> confirmNotificationMethodWithHttpInfo(String sessionid,
                                                                       String token,
                                                                       String notificationMethod)
                                                                throws ApiException

Confirms a notification method parameter to be used as recipient for notifications

Parameters:

sessionid - (required)

token - (required)

notificationMethod - (required)

Returns:

ApiResponse<UserSettings>

Throws:

ApiException - if fails to make API call

deleteUserSubscriptions

public UserSubscriptions deleteUserSubscriptions(String sessionid)
                                          throws ApiException

Deletes a userSubscriptions

Parameters:

sessionid - (required)

Returns:

UserSubscriptions

Throws:

ApiException - if fails to make API call

deleteUserSubscriptionsWithHttpInfo

public ApiResponse<UserSubscriptions> deleteUserSubscriptionsWithHttpInfo(String sessionid)
                                                                   throws ApiException

Deletes a userSubscriptions

Parameters:

sessionid - (required)

Returns:

ApiResponse<UserSubscriptions>

Throws:

ApiException - if fails to make API call

getUserSubscriptions

public UserSubscriptionsResponse getUserSubscriptions(String sessionid)
                                               throws ApiException

Gets the users userSubscriptions

Parameters:

sessionid - (required)

Returns:

UserSubscriptionsResponse

Throws:

ApiException - if fails to make API call

getUserSubscriptionsWithHttpInfo

public ApiResponse<UserSubscriptionsResponse> getUserSubscriptionsWithHttpInfo(String sessionid)
                                                                        throws ApiException

Gets the users userSubscriptions

Parameters:

sessionid - (required)

Returns:

ApiResponse<UserSubscriptionsResponse>

Throws:

ApiException - if fails to make API call

resendNotificationMethodConfirmation

public UserSettings resendNotificationMethodConfirmation(String sessionid,
                                                         String data,
                                                         String notificationMethod)
                                                  throws ApiException

Resends a notification method confirmation request

Parameters:

sessionid - (required)

data - (required)

notificationMethod - (required)

Returns:

UserSettings

Throws:

ApiException - if fails to make API call

resendNotificationMethodConfirmationWithHttpInfo

public ApiResponse<UserSettings> resendNotificationMethodConfirmationWithHttpInfo(String sessionid,
                                                                                  String data,
                                                                                  String notificationMethod)
                                                                           throws ApiException

Resends a notification method confirmation request

Parameters:

sessionid - (required)

data - (required)

notificationMethod - (required)

Returns:

ApiResponse<UserSettings>

Throws:

ApiException - if fails to make API call

updateUserSettings

public UserSettings updateUserSettings(String sessionid,
                                       UserSettings userSettings)
                                throws ApiException

updates a userSubscriptions user settings

Parameters:

sessionid - (required)

userSettings - (required)

Returns:

UserSettings

Throws:

ApiException - if fails to make API call

updateUserSettingsWithHttpInfo

public ApiResponse<UserSettings> updateUserSettingsWithHttpInfo(String sessionid,
                                                                UserSettings userSettings)
                                                         throws ApiException

updates a userSubscriptions user settings

Parameters:

sessionid - (required)

userSettings - (required)

Returns:

ApiResponse<UserSettings>

Throws:

ApiException - if fails to make API call