Package com.ringcentral.paths.webinar.notifications.v1.subscriptions

Class Index

java.lang.Object

com.ringcentral.paths.webinar.notifications.v1.subscriptions.Index

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Index	parent
RestClient	rc
String	subscriptionId

Constructor Summary

Constructors

Constructor	Description
Index(Index parent, String subscriptionId)

Method Summary

Modifier and Type	Method	Description
String	delete()	Cancels the existing webinar subscription.
SubscriptionInfo	get()	Returns the webinar subscription by ID HTTP Method: get Endpoint: /webinar/notifications/v1/subscriptions/{subscriptionId} Rate Limit Group: Light
SubscriptionListResource	list()	Returns a list of webinar subscriptions created by the user for the current authorized client application.
String	path()
String	path(Boolean withParameter)
SubscriptionInfo	post(CreateWebhookSubscriptionRequest createWebhookSubscriptionRequest)	Creates a new webinar subscription for the current authorized user / client application.
SubscriptionInfo	put(UpdateSubscriptionRequest updateSubscriptionRequest)	Updates the existing subscription.
Index	renew()

Methods inherited from class java.lang.Object

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

Field Details

rc

public RestClient rc

parent

public Index parent

subscriptionId

public String subscriptionId

Constructor Details

Index

public Index(Index parent,
 String subscriptionId)

Method Details

path

public String path(Boolean withParameter)

path

public String path()

list

public SubscriptionListResource list()
                              throws RestException,
IOException

Returns a list of webinar subscriptions created by the user for the current authorized client application. HTTP Method: get Endpoint: /webinar/notifications/v1/subscriptions Rate Limit Group: Light

Throws:

RestException

IOException

post

public SubscriptionInfo post(CreateWebhookSubscriptionRequest createWebhookSubscriptionRequest)
                      throws RestException,
IOException

Creates a new webinar subscription for the current authorized user / client application. HTTP Method: post Endpoint: /webinar/notifications/v1/subscriptions Rate Limit Group: Medium

Throws:

RestException

IOException

get

public SubscriptionInfo get()
                     throws RestException,
IOException

Returns the webinar subscription by ID HTTP Method: get Endpoint: /webinar/notifications/v1/subscriptions/{subscriptionId} Rate Limit Group: Light

Throws:

RestException

IOException

put

public SubscriptionInfo put(UpdateSubscriptionRequest updateSubscriptionRequest)
                     throws RestException,
IOException

Updates the existing subscription. The client application can extend/narrow the list of events for which it receives notifications within this subscription. If event filters are specified, calling this method modifies them for the existing subscription. The method also allows to set the subscription expiration time. If other than `events` and `expiresIn` parameters are passed in the request they will be ignored. If the request body is empty then the specified subscription will be just renewed without any event filter modifications and with default expiration time.

HTTP Method: put Endpoint: /webinar/notifications/v1/subscriptions/{subscriptionId} Rate Limit Group: Medium

Throws:

RestException

IOException

delete

public String delete()
              throws RestException,
IOException

Cancels the existing webinar subscription. HTTP Method: delete Endpoint: /webinar/notifications/v1/subscriptions/{subscriptionId} Rate Limit Group: Medium

Throws:

RestException

IOException

renew

public Index renew()