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

Class DynamicWebhookApi

java.lang.Object

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

public class DynamicWebhookApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Completable	deleteWebhookById(ContainerForWebhookIDs containerForWebhookIDs, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete webhooks by ID Removes webhooks by ID.
io.reactivex.Single<PageBeanWebhook>	getDynamicWebhooksForApp(Optional<Long> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get dynamic webhooks for app Returns the webhooks registered by the calling app.
io.reactivex.Single<WebhooksExpirationDate>	refreshWebhooks(ContainerForWebhookIDs containerForWebhookIDs, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Extend webhook life Webhooks registered through the REST API expire after 30 days.
io.reactivex.Single<ContainerForRegisteredWebhooks>	registerDynamicWebhooks(WebhookRegistrationDetails webhookRegistrationDetails, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Register dynamic webhooks Registers webhooks.

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicWebhookApi

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

Method Detail

deleteWebhookById

public io.reactivex.Completable deleteWebhookById(ContainerForWebhookIDs containerForWebhookIDs,
                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete webhooks by ID

Removes webhooks by ID. Only webhooks registered by the calling Connect app are removed. If webhooks created by other apps are specified, they are ignored.

Permissions required: Only Connect apps can use this operation.

Parameters:

containerForWebhookIDs - (required)

restRequestEnhancer -

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

Returns:

Completable

getDynamicWebhooksForApp

public io.reactivex.Single<PageBeanWebhook> getDynamicWebhooksForApp(Optional<Long> startAt,
                                                                     Optional<Integer> maxResults,
                                                                     Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get dynamic webhooks for app

Returns the webhooks registered by the calling app.

Permissions required: Only Connect apps can use this operation.

Parameters:

startAt -

The index of the first item to return in a page of results (page offset).

(optional, default to 0l)

maxResults -

The maximum number of items to return per page.

(optional, default to 100)

restRequestEnhancer -

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

Returns:

Single<PageBeanWebhook>

refreshWebhooks

public io.reactivex.Single<WebhooksExpirationDate> refreshWebhooks(ContainerForWebhookIDs containerForWebhookIDs,
                                                                   Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Extend webhook life

Webhooks registered through the REST API expire after 30 days. Call this resource periodically to keep them alive.

Unrecognized webhook IDs (nonexistent or belonging to other apps) are ignored. Permissions required: Only Connect apps can use this operation.

Parameters:

containerForWebhookIDs - (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<WebhooksExpirationDate>

registerDynamicWebhooks

public io.reactivex.Single<ContainerForRegisteredWebhooks> registerDynamicWebhooks(WebhookRegistrationDetails webhookRegistrationDetails,
                                                                                   Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Register dynamic webhooks

Registers webhooks.

Permissions required: Only Connect apps can use this operation.

Parameters:

webhookRegistrationDetails - (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<ContainerForRegisteredWebhooks>