Class WebhooksClient

Index

Constructors

Methods

createWebhook deleteWebhook getWebhook getWebhookEvent listWebhookEvents listWebhooks pingWebhook updateWebhook

Constructors

constructor

new WebhooksClient(apiOptions: DfnsApiClientOptions): WebhooksClient
Parameters
- apiOptions: DfnsApiClientOptions
Returns WebhooksClient
- Defined in packages/sdk/generated/webhooks/client.ts:10

Methods

createWebhook

createWebhook(request: CreateWebhookRequest): Promise<CreateWebhookResponse>
Parameters
- request: CreateWebhookRequest
Returns Promise<CreateWebhookResponse>
- Defined in packages/sdk/generated/webhooks/client.ts:12

deleteWebhook

deleteWebhook(request: DeleteWebhookParams): Promise<DeleteWebhookResponse>
Parameters
- request: DeleteWebhookParams
Returns Promise<DeleteWebhookResponse>
- Defined in packages/sdk/generated/webhooks/client.ts:27

getWebhook

getWebhook(request: GetWebhookParams): Promise<GetWebhookResponse>
Parameters
- request: GetWebhookParams
Returns Promise<GetWebhookResponse>
- Defined in packages/sdk/generated/webhooks/client.ts:42

getWebhookEvent

getWebhookEvent(
request: GetWebhookEventParams,
): Promise<GetWebhookEventResponse>
Parameters
- request: GetWebhookEventParams
Returns Promise<GetWebhookEventResponse>
- Defined in packages/sdk/generated/webhooks/client.ts:56

listWebhookEvents

listWebhookEvents(
request: ListWebhookEventsRequest,
): Promise<ListWebhookEventsResponse>
Parameters
- request: ListWebhookEventsRequest
Returns Promise<ListWebhookEventsResponse>
- Defined in packages/sdk/generated/webhooks/client.ts:70

listWebhooks

listWebhooks(request?: ListWebhooksRequest): Promise<ListWebhooksResponse>
Parameters
- Optionalrequest: ListWebhooksRequest
Returns Promise<ListWebhooksResponse>
- Defined in packages/sdk/generated/webhooks/client.ts:84

pingWebhook

pingWebhook(request: PingWebhookParams): Promise<PingWebhookResponse>
Parameters
- request: PingWebhookParams
Returns Promise<PingWebhookResponse>
- Defined in packages/sdk/generated/webhooks/client.ts:98

updateWebhook

updateWebhook(request: UpdateWebhookRequest): Promise<UpdateWebhookResponse>
Parameters
- request: UpdateWebhookRequest
Returns Promise<UpdateWebhookResponse>
- Defined in packages/sdk/generated/webhooks/client.ts:113