org.everit.atlassian.restclient.jiracloud.v2.api

Class IssueNotificationSchemesApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v2.api.IssueNotificationSchemesApi

public class IssueNotificationSchemesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
IssueNotificationSchemesApi(org.everit.http.restclient.RestClient restClient)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<Object>	addNotifications(String id, Map<String,Object> requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Add notifications to notification scheme Adds notifications to a notification scheme.
io.reactivex.Single<NotificationSchemeId>	createNotificationScheme(Map<String,Object> requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create notification scheme Creates a notification scheme with notifications.
io.reactivex.Single<Object>	deleteNotificationScheme(String notificationSchemeId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete notification scheme Deletes a notification scheme.
io.reactivex.Single<NotificationScheme>	getNotificationScheme(Long id, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get notification scheme Returns a [notification scheme](https://confluence.atlassian.com/x/8YdKLg), including the list of events and the recipients who will receive notifications for those events.
io.reactivex.Single<PageBeanNotificationScheme>	getNotificationSchemes(Optional<String> startAt, Optional<String> maxResults, Optional<List<String>> id, Optional<List<String>> projectId, Optional<Boolean> onlyDefault, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get notification schemes paginated Returns a [paginated](#pagination) list of [notification schemes](https://confluence.atlassian.com/x/8YdKLg) ordered by the display name.
io.reactivex.Single<PageBeanNotificationSchemeAndProjectMappingJsonBean>	getNotificationSchemeToProjectMappings(Optional<String> startAt, Optional<String> maxResults, Optional<List<String>> notificationSchemeId, Optional<List<String>> projectId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get projects using notification schemes paginated Returns a [paginated](#pagination) mapping of project that have notification scheme assigned.
io.reactivex.Single<Object>	removeNotificationFromNotificationScheme(String notificationSchemeId, String notificationId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Remove notification from notification scheme Removes a notification from a notification scheme.
io.reactivex.Single<Object>	updateNotificationScheme(String id, Map<String,Object> requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update notification scheme Updates a notification scheme.

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueNotificationSchemesApi

public IssueNotificationSchemesApi(org.everit.http.restclient.RestClient restClient)

Method Detail

addNotifications

public io.reactivex.Single<Object> addNotifications(String id,
                                                    Map<String,Object> requestBody,
                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Add notifications to notification scheme Adds notifications to a notification scheme. You can add up to 1000 notifications per request. *Deprecated: The notification type `EmailAddress` is no longer supported in Cloud. Refer to the [changelog](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-1031) for more details.* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of the notification scheme. (required)

requestBody - (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Object>

createNotificationScheme

public io.reactivex.Single<NotificationSchemeId> createNotificationScheme(Map<String,Object> requestBody,
                                                                          Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create notification scheme Creates a notification scheme with notifications. You can create up to 1000 notifications per request. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

requestBody - (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<NotificationSchemeId>

deleteNotificationScheme

public io.reactivex.Single<Object> deleteNotificationScheme(String notificationSchemeId,
                                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete notification scheme Deletes a notification scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

notificationSchemeId - The ID of the notification scheme. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Object>

getNotificationScheme

public io.reactivex.Single<NotificationScheme> getNotificationScheme(Long id,
                                                                     Optional<String> expand,
                                                                     Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get notification scheme Returns a [notification scheme](https://confluence.atlassian.com/x/8YdKLg), including the list of events and the recipients who will receive notifications for those events. **[Permissions](#permissions) required:** Permission to access Jira, however, the user must have permission to administer at least one project associated with the notification scheme.

Parameters:

id - The ID of the notification scheme. Use [Get notification schemes paginated](#api-rest-api-2-notificationscheme-get) to get a list of notification scheme IDs. (required)

expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * `all` Returns all expandable information * `field` Returns information about any custom fields assigned to receive an event * `group` Returns information about any groups assigned to receive an event * `notificationSchemeEvents` Returns a list of event associations. This list is returned for all expandable information * `projectRole` Returns information about any project roles assigned to receive an event * `user` Returns information about any users assigned to receive an event (optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<NotificationScheme>

getNotificationSchemeToProjectMappings

public io.reactivex.Single<PageBeanNotificationSchemeAndProjectMappingJsonBean> getNotificationSchemeToProjectMappings(Optional<String> startAt,
                                                                                                                       Optional<String> maxResults,
                                                                                                                       Optional<List<String>> notificationSchemeId,
                                                                                                                       Optional<List<String>> projectId,
                                                                                                                       Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get projects using notification schemes paginated Returns a [paginated](#pagination) mapping of project that have notification scheme assigned. You can provide either one or multiple notification scheme IDs or project IDs to filter by. If you don't provide any, this will return a list of all mappings. Note that only company-managed (classic) projects are supported. This is because team-managed projects don't have a concept of a default notification scheme. The mappings are ordered by projectId. **[Permissions](#permissions) required:** Permission to access Jira.

Parameters:

startAt - The index of the first item to return in a page of results (page offset). (optional, default to "0")

maxResults - The maximum number of items to return per page. (optional, default to "50")

notificationSchemeId - The list of notifications scheme IDs to be filtered out (optional, default to new ArrayList<>())

projectId - The list of project IDs to be filtered out (optional, default to new ArrayList<>())

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<PageBeanNotificationSchemeAndProjectMappingJsonBean>

getNotificationSchemes

public io.reactivex.Single<PageBeanNotificationScheme> getNotificationSchemes(Optional<String> startAt,
                                                                              Optional<String> maxResults,
                                                                              Optional<List<String>> id,
                                                                              Optional<List<String>> projectId,
                                                                              Optional<Boolean> onlyDefault,
                                                                              Optional<String> expand,
                                                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get notification schemes paginated Returns a [paginated](#pagination) list of [notification schemes](https://confluence.atlassian.com/x/8YdKLg) ordered by the display name. *Note that you should allow for events without recipients to appear in responses.* **[Permissions](#permissions) required:** Permission to access Jira, however, the user must have permission to administer at least one project associated with a notification scheme for it to be returned.

Parameters:

startAt - The index of the first item to return in a page of results (page offset). (optional, default to "0")

maxResults - The maximum number of items to return per page. (optional, default to "50")

id - The list of notification schemes IDs to be filtered by (optional, default to new ArrayList<>())

projectId - The list of projects IDs to be filtered by (optional, default to new ArrayList<>())

onlyDefault - When set to true, returns only the default notification scheme. If you provide project IDs not associated with the default, returns an empty page. The default value is false. (optional, default to false)

expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * `all` Returns all expandable information * `field` Returns information about any custom fields assigned to receive an event * `group` Returns information about any groups assigned to receive an event * `notificationSchemeEvents` Returns a list of event associations. This list is returned for all expandable information * `projectRole` Returns information about any project roles assigned to receive an event * `user` Returns information about any users assigned to receive an event (optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<PageBeanNotificationScheme>

removeNotificationFromNotificationScheme

public io.reactivex.Single<Object> removeNotificationFromNotificationScheme(String notificationSchemeId,
                                                                            String notificationId,
                                                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Remove notification from notification scheme Removes a notification from a notification scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

notificationSchemeId - The ID of the notification scheme. (required)

notificationId - The ID of the notification. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Object>

updateNotificationScheme

public io.reactivex.Single<Object> updateNotificationScheme(String id,
                                                            Map<String,Object> requestBody,
                                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update notification scheme Updates a notification scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of the notification scheme. (required)

requestBody - (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Object>