Class DelegatedWebhooksClient

Index

Constructors

Methods

createWebhookComplete createWebhookInit deleteWebhookComplete deleteWebhookInit getWebhook getWebhookEvent listWebhookEvents listWebhooks pingWebhookComplete pingWebhookInit updateWebhookComplete updateWebhookInit

Constructors

constructor

new DelegatedWebhooksClient(
apiOptions: DfnsBaseApiOptions,
): DelegatedWebhooksClient
Parameters
- apiOptions: DfnsBaseApiOptions
Returns DelegatedWebhooksClient
- Defined in packages/sdk/generated/webhooks/delegatedClient.ts:8

Methods

createWebhookComplete

createWebhookComplete(
request: CreateWebhookRequest,
signedChallenge: SignUserActionChallengeRequest,
): Promise<CreateWebhookResponse>
Parameters
- request: CreateWebhookRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<CreateWebhookResponse>
- Defined in packages/sdk/generated/webhooks/delegatedClient.ts:29

createWebhookInit

createWebhookInit(request: CreateWebhookRequest): Promise<UserActionChallenge>
Parameters
- request: CreateWebhookRequest
Returns Promise<UserActionChallenge>
- Defined in packages/sdk/generated/webhooks/delegatedClient.ts:10

deleteWebhookComplete

deleteWebhookComplete(
request: DeleteWebhookParams,
signedChallenge: SignUserActionChallengeRequest,
): Promise<DeleteWebhookResponse>
Parameters
- request: DeleteWebhookParams
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<DeleteWebhookResponse>
- Defined in packages/sdk/generated/webhooks/delegatedClient.ts:72

deleteWebhookInit

deleteWebhookInit(request: DeleteWebhookParams): Promise<UserActionChallenge>
Parameters
- request: DeleteWebhookParams
Returns Promise<UserActionChallenge>
- Defined in packages/sdk/generated/webhooks/delegatedClient.ts:53

getWebhook

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

getWebhookEvent

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

listWebhookEvents

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

listWebhooks

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

pingWebhookComplete

pingWebhookComplete(
request: PingWebhookParams,
signedChallenge: SignUserActionChallengeRequest,
): Promise<PingWebhookResponse>
Parameters
- request: PingWebhookParams
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<PingWebhookResponse>
- Defined in packages/sdk/generated/webhooks/delegatedClient.ts:171

pingWebhookInit

pingWebhookInit(request: PingWebhookParams): Promise<UserActionChallenge>
Parameters
- request: PingWebhookParams
Returns Promise<UserActionChallenge>
- Defined in packages/sdk/generated/webhooks/delegatedClient.ts:152

updateWebhookComplete

updateWebhookComplete(
request: UpdateWebhookRequest,
signedChallenge: SignUserActionChallengeRequest,
): Promise<UpdateWebhookResponse>
Parameters
- request: UpdateWebhookRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<UpdateWebhookResponse>
- Defined in packages/sdk/generated/webhooks/delegatedClient.ts:214

updateWebhookInit

updateWebhookInit(request: UpdateWebhookRequest): Promise<UserActionChallenge>
Parameters
- request: UpdateWebhookRequest
Returns Promise<UserActionChallenge>
- Defined in packages/sdk/generated/webhooks/delegatedClient.ts:195