net.leanix.webhooks.api

Class SubscriptionsApi

java.lang.Object

net.leanix.webhooks.api.SubscriptionsApi

public class SubscriptionsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SubscriptionsApi()
SubscriptionsApi(ApiClient apiClient)

Method Summary

Methods

Modifier and Type	Method and Description
SubscriptionResponse	createSubscription(Subscription body) createSubscription Endpoint to create a subscription.
SubscriptionResponse	deleteSubscription(String id) deleteSubscription Endpoint to delete a subscription.
ApiClient	getApiClient()
SubscriptionResponse	getSubscription(String id) getSubscription returns a subscription with a given id
DeliveryListResponse	getSubscriptionDeliveries(String id, Integer page, Integer size, String sort) getSubscriptionDeliveries Endpoint to list the deliveries
EventListResponse	getSubscriptionEvents(String id, Boolean withPayload, Integer page, Integer size, String sort) getSubscriptionEvents Endpoint to list the events
SubscriptionListResponse	getSubscriptions(String workspaceId, String identifier) getSubscriptions Endpoint to list the subscriptions.
void	setApiClient(ApiClient apiClient)
SubscriptionResponse	updateSubscription(String id, Subscription body) updateSubscription Endpoint to update a subscription.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionsApi

public SubscriptionsApi()

SubscriptionsApi

public SubscriptionsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createSubscription

public SubscriptionResponse createSubscription(Subscription body)
                                        throws ApiException

createSubscription Endpoint to create a subscription.

Parameters:

body - (required)

Returns:

SubscriptionResponse

Throws:

ApiException - if fails to make API call

deleteSubscription

public SubscriptionResponse deleteSubscription(String id)
                                        throws ApiException

deleteSubscription Endpoint to delete a subscription.

Parameters:

id - (required)

Returns:

SubscriptionResponse

Throws:

ApiException - if fails to make API call

getSubscription

public SubscriptionResponse getSubscription(String id)
                                     throws ApiException

getSubscription returns a subscription with a given id

Parameters:

id - the UUID of the subscription (required)

Returns:

SubscriptionResponse

Throws:

ApiException - if fails to make API call

getSubscriptionDeliveries

public DeliveryListResponse getSubscriptionDeliveries(String id,
                                             Integer page,
                                             Integer size,
                                             String sort)
                                               throws ApiException

getSubscriptionDeliveries Endpoint to list the deliveries

Parameters:

id - (required)

page - The page number to access (1 indexed, defaults to 1) (optional, default to 1)

size - The page size requested (defaults to 30, max 100) (optional, default to 30)

sort - Comma-separated list of sorting (default createdAt-DESC) (optional, default to createdAt-desc)

Returns:

DeliveryListResponse

Throws:

ApiException - if fails to make API call

getSubscriptionEvents

public EventListResponse getSubscriptionEvents(String id,
                                      Boolean withPayload,
                                      Integer page,
                                      Integer size,
                                      String sort)
                                        throws ApiException

getSubscriptionEvents Endpoint to list the events

Parameters:

id - (required)

withPayload - Include the payload (true by default) (optional, default to true)

page - The page number to access (1 indexed, defaults to 1) (optional, default to 1)

size - The page size requested (defaults to 100, max 100) (optional, default to 100)

sort - Comma-separated list of sorting (default createdAt-ASC) (optional, default to createdAt-ASC)

Returns:

EventListResponse

Throws:

ApiException - if fails to make API call

getSubscriptions

public SubscriptionListResponse getSubscriptions(String workspaceId,
                                        String identifier)
                                          throws ApiException

getSubscriptions Endpoint to list the subscriptions.

Parameters:

workspaceId - an optional workspace UUID (optional)

identifier - an optional subscription identifier (optional)

Returns:

SubscriptionListResponse

Throws:

ApiException - if fails to make API call

updateSubscription

public SubscriptionResponse updateSubscription(String id,
                                      Subscription body)
                                        throws ApiException

updateSubscription Endpoint to update a subscription.

Parameters:

id - (required)

body - (required)

Returns:

SubscriptionResponse

Throws:

ApiException - if fails to make API call