Class NotificationDestinationsClient

Index

Constructors

Methods

createNotificationDestination deleteNotificationDestination getNotificationDestination listNotificationDestinations listNotificationDestinationsIter updateNotificationDestination

Constructors

constructor

new NotificationDestinationsClient(
options: ClientOptions,
): NotificationDestinationsClient
Parameters
- options: ClientOptions
Returns NotificationDestinationsClient
- Defined in client.ts:56

Methods

createNotificationDestination

createNotificationDestination(
req: CreateNotificationDestinationRequest,
options?: CallOptions,
): Promise<NotificationDestination>
Creates a notification destination. Requires workspace admin permissions.
Parameters
- req: CreateNotificationDestinationRequest
- Optionaloptions: CallOptions
Returns Promise<NotificationDestination>
- Defined in client.ts:72

deleteNotificationDestination

deleteNotificationDestination(
req: DeleteNotificationDestinationRequest,
options?: CallOptions,
): Promise<Empty>
Deletes a notification destination. Requires workspace admin permissions.
Parameters
- req: DeleteNotificationDestinationRequest
- Optionaloptions: CallOptions
Returns Promise<Empty>
- Defined in client.ts:105

getNotificationDestination

getNotificationDestination(
req: GetNotificationDestinationRequest,
options?: CallOptions,
): Promise<NotificationDestination>
Gets a notification destination.
Parameters
- req: GetNotificationDestinationRequest
- Optionaloptions: CallOptions
Returns Promise<NotificationDestination>
- Defined in client.ts:134

listNotificationDestinations

listNotificationDestinations(
req: ListNotificationDestinationsRequest,
options?: CallOptions,
): Promise<ListNotificationDestinationsResponse>
Lists notification destinations.
Parameters
- req: ListNotificationDestinationsRequest
- Optionaloptions: CallOptions
Returns Promise<ListNotificationDestinationsResponse>
- Defined in client.ts:163

listNotificationDestinationsIter

listNotificationDestinationsIter(
req: ListNotificationDestinationsRequest,
options?: CallOptions,
): AsyncGenerator<ListNotificationDestinationsResult>
Parameters
- req: ListNotificationDestinationsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<ListNotificationDestinationsResult>
- Defined in client.ts:203

updateNotificationDestination

updateNotificationDestination(
req: UpdateNotificationDestinationRequest,
options?: CallOptions,
): Promise<NotificationDestination>
Updates a notification destination. Requires workspace admin permissions. At least one field is required in the request body.
Parameters
- req: UpdateNotificationDestinationRequest
- Optionaloptions: CallOptions
Returns Promise<NotificationDestination>
- Defined in client.ts:221