org.openapitools.client.api

Class SubscriptionApi

java.lang.Object

org.openapitools.client.api.SubscriptionApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-01-18T04:14:02.238-06:00[America/Chicago]")
 @Component(value="org.openapitools.client.api.SubscriptionApi")
public class SubscriptionApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SubscriptionApi()
SubscriptionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
List<Subscription>	listRoleSubscriptions(String roleTypeOrRoleId) List all Subscriptions of a Custom Role When roleType List all subscriptions of a Role.
Subscription	listRoleSubscriptionsByNotificationType(String roleTypeOrRoleId, String notificationType) List all Subscriptions of a Custom Role with a specific notification type When roleType Get subscriptions of a Role with a specific notification type.
PagedList	listRoleSubscriptionsByNotificationTypeWithPaginationInfo(String roleTypeOrRoleId, String notificationType) List all Subscriptions of a Custom Role with a specific notification type When roleType Get subscriptions of a Role with a specific notification type.
PagedList	listRoleSubscriptionsWithPaginationInfo(String roleTypeOrRoleId) List all Subscriptions of a Custom Role When roleType List all subscriptions of a Role.
List<Subscription>	listUserSubscriptions(String userId) List all Subscriptions Lists all subscriptions of a user.
Subscription	listUserSubscriptionsByNotificationType(String userId, String notificationType) List all Subscriptions by type Lists all the subscriptions of a User with a specific notification type.
PagedList	listUserSubscriptionsByNotificationTypeWithPaginationInfo(String userId, String notificationType) List all Subscriptions by type Lists all the subscriptions of a User with a specific notification type.
PagedList	listUserSubscriptionsWithPaginationInfo(String userId) List all Subscriptions Lists all subscriptions of a user.
void	setApiClient(ApiClient apiClient)
void	subscribeRoleSubscriptionByNotificationType(String roleTypeOrRoleId, String notificationType) Subscribe a Custom Role to a specific notification type When roleType Subscribes a Role to a specific notification type.
void	subscribeUserSubscriptionByNotificationType(String userId, String notificationType) Subscribe to a specific notification type Subscribes a User to a specific notification type.
void	unsubscribeRoleSubscriptionByNotificationType(String roleTypeOrRoleId, String notificationType) Unsubscribe a Custom Role from a specific notification type When roleType Unsubscribes a Role from a specific notification type.
void	unsubscribeUserSubscriptionByNotificationType(String userId, String notificationType) Unsubscribe from a specific notification type Unsubscribes a User from a specific notification type.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionApi

public SubscriptionApi()

SubscriptionApi

@Autowired
public SubscriptionApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

listRoleSubscriptions

public List<Subscription> listRoleSubscriptions(String roleTypeOrRoleId)
                                         throws org.springframework.web.client.RestClientException

List all Subscriptions of a Custom Role When roleType List all subscriptions of a Role. Else when roleId List subscriptions of a Custom Role

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

roleTypeOrRoleId - (required)

Returns:

List<Subscription>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listRoleSubscriptionsWithPaginationInfo

public PagedList listRoleSubscriptionsWithPaginationInfo(String roleTypeOrRoleId)
                                                  throws org.springframework.web.client.RestClientException

List all Subscriptions of a Custom Role When roleType List all subscriptions of a Role. Else when roleId List subscriptions of a Custom Role

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

roleTypeOrRoleId - (required)

Returns:

ResponseEntity<List<Subscription>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listRoleSubscriptionsByNotificationType

public Subscription listRoleSubscriptionsByNotificationType(String roleTypeOrRoleId,
                                                            String notificationType)
                                                     throws org.springframework.web.client.RestClientException

List all Subscriptions of a Custom Role with a specific notification type When roleType Get subscriptions of a Role with a specific notification type. Else when roleId Get subscription of a Custom Role with a specific notification type.

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

roleTypeOrRoleId - (required)

notificationType - (required)

Returns:

Subscription

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listRoleSubscriptionsByNotificationTypeWithPaginationInfo

public PagedList listRoleSubscriptionsByNotificationTypeWithPaginationInfo(String roleTypeOrRoleId,
                                                                           String notificationType)
                                                                    throws org.springframework.web.client.RestClientException

List all Subscriptions of a Custom Role with a specific notification type When roleType Get subscriptions of a Role with a specific notification type. Else when roleId Get subscription of a Custom Role with a specific notification type.

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

roleTypeOrRoleId - (required)

notificationType - (required)

Returns:

ResponseEntity<Subscription>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listUserSubscriptions

public List<Subscription> listUserSubscriptions(String userId)
                                         throws org.springframework.web.client.RestClientException

List all Subscriptions Lists all subscriptions of a user. Only lists subscriptions for current user. An AccessDeniedException message is sent if requests are made from other users.

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Returns:

List<Subscription>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listUserSubscriptionsWithPaginationInfo

public PagedList listUserSubscriptionsWithPaginationInfo(String userId)
                                                  throws org.springframework.web.client.RestClientException

List all Subscriptions Lists all subscriptions of a user. Only lists subscriptions for current user. An AccessDeniedException message is sent if requests are made from other users.

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Returns:

ResponseEntity<List<Subscription>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listUserSubscriptionsByNotificationType

public Subscription listUserSubscriptionsByNotificationType(String userId,
                                                            String notificationType)
                                                     throws org.springframework.web.client.RestClientException

List all Subscriptions by type Lists all the subscriptions of a User with a specific notification type. Only gets subscriptions for current user. An AccessDeniedException message is sent if requests are made from other users.

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

notificationType - (required)

Returns:

Subscription

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listUserSubscriptionsByNotificationTypeWithPaginationInfo

public PagedList listUserSubscriptionsByNotificationTypeWithPaginationInfo(String userId,
                                                                           String notificationType)
                                                                    throws org.springframework.web.client.RestClientException

List all Subscriptions by type Lists all the subscriptions of a User with a specific notification type. Only gets subscriptions for current user. An AccessDeniedException message is sent if requests are made from other users.

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

notificationType - (required)

Returns:

ResponseEntity<Subscription>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

subscribeRoleSubscriptionByNotificationType

public void subscribeRoleSubscriptionByNotificationType(String roleTypeOrRoleId,
                                                        String notificationType)
                                                 throws org.springframework.web.client.RestClientException

Subscribe a Custom Role to a specific notification type When roleType Subscribes a Role to a specific notification type. When you change the subscription status of a Role, it overrides the subscription of any individual user of that Role. Else when roleId Subscribes a Custom Role to a specific notification type. When you change the subscription status of a Custom Role, it overrides the subscription of any individual user of that Custom Role.

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

roleTypeOrRoleId - (required)

notificationType - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

subscribeUserSubscriptionByNotificationType

public void subscribeUserSubscriptionByNotificationType(String userId,
                                                        String notificationType)
                                                 throws org.springframework.web.client.RestClientException

Subscribe to a specific notification type Subscribes a User to a specific notification type. Only the current User can subscribe to a specific notification type. An AccessDeniedException message is sent if requests are made from other users.

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

notificationType - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

unsubscribeRoleSubscriptionByNotificationType

public void unsubscribeRoleSubscriptionByNotificationType(String roleTypeOrRoleId,
                                                          String notificationType)
                                                   throws org.springframework.web.client.RestClientException

Unsubscribe a Custom Role from a specific notification type When roleType Unsubscribes a Role from a specific notification type. When you change the subscription status of a Role, it overrides the subscription of any individual user of that Role. Else when roleId Unsubscribes a Custom Role from a specific notification type. When you change the subscription status of a Custom Role, it overrides the subscription of any individual user of that Custom Role.

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

roleTypeOrRoleId - (required)

notificationType - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

unsubscribeUserSubscriptionByNotificationType

public void unsubscribeUserSubscriptionByNotificationType(String userId,
                                                          String notificationType)
                                                   throws org.springframework.web.client.RestClientException

Unsubscribe from a specific notification type Unsubscribes a User from a specific notification type. Only the current User can unsubscribe from a specific notification type. An AccessDeniedException message is sent if requests are made from other users.

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

notificationType - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API