Class Webhooks

Hierarchy

Webhooks

Index

Constructors

constructor

new Webhooks(client): Webhooks
Parameters
- client: Client
Returns Webhooks
- Defined in api/webhooks.ts:7

Properties

`Private` client

client: Client

Methods

createWebhook

createWebhook<T>(parameters, callback): Promise<void>
Create a new webhook.
Type Parameters
- T = Webhook
Parameters
- parameters: CreateWebhook
- callback: Callback<T>
Returns Promise<void>
- Defined in api/webhooks.ts:10
createWebhook<T>(parameters, callback?): Promise<T>
Create a new webhook.
Type Parameters
- T = Webhook
Parameters
- parameters: CreateWebhook
- Optional callback: undefined
Returns Promise<T>
- Defined in api/webhooks.ts:12

deleteWebhook

deleteWebhook<T>(parameters, callback): Promise<void>
Delete a webhook by ID.
Type Parameters
- T = unknown
Parameters
- parameters: DeleteWebhook
- callback: Callback<T>
Returns Promise<void>
- Defined in api/webhooks.ts:67
deleteWebhook<T>(parameters, callback?): Promise<T>
Delete a webhook by ID.
Type Parameters
- T = unknown
Parameters
- parameters: DeleteWebhook
- Optional callback: undefined
Returns Promise<T>
- Defined in api/webhooks.ts:69

getWebhook

getWebhook<T>(parameters, callback): Promise<void>
Get a webhook by ID.
Type Parameters
- T = Webhook
Parameters
- parameters: GetWebhook
- callback: Callback<T>
Returns Promise<void>
- Defined in api/webhooks.ts:32
getWebhook<T>(parameters, callback?): Promise<T>
Get a webhook by ID.
Type Parameters
- T = Webhook
Parameters
- parameters: GetWebhook
- Optional callback: undefined
Returns Promise<T>
- Defined in api/webhooks.ts:34

getWebhookField

getWebhookField<T>(parameters, callback): Promise<void>
Get a field on a Webhook
Type Parameters
- T = unknown
Parameters
- parameters: GetWebhookField
- callback: Callback<T>
Returns Promise<void>
- Defined in api/webhooks.ts:80
getWebhookField<T>(parameters, callback?): Promise<T>
Get a field on a Webhook
Type Parameters
- T = unknown
Parameters
- parameters: GetWebhookField
- Optional callback: undefined
Returns Promise<T>
- Defined in api/webhooks.ts:82

updateWebhook

updateWebhook<T>(parameters, callback): Promise<void>
Update a webhook by ID.
Type Parameters
- T = Webhook
Parameters
- parameters: UpdateWebhook
- callback: Callback<T>
Returns Promise<void>
- Defined in api/webhooks.ts:45
updateWebhook<T>(parameters, callback?): Promise<T>
Update a webhook by ID.
Type Parameters
- T = Webhook
Parameters
- parameters: UpdateWebhook
- Optional callback: undefined
Returns Promise<T>
- Defined in api/webhooks.ts:47

Class Webhooks

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: Client

Returns Webhooks

Properties

Private client

Methods

createWebhook

Type Parameters

T = Webhook

Parameters

parameters: CreateWebhook

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = Webhook

Parameters

parameters: CreateWebhook

Optional callback: undefined

Returns Promise<T>

deleteWebhook

Type Parameters

T = unknown

Parameters

parameters: DeleteWebhook

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: DeleteWebhook

Optional callback: undefined

Returns Promise<T>

getWebhook

Type Parameters

T = Webhook

Parameters

parameters: GetWebhook

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = Webhook

Parameters

parameters: GetWebhook

Optional callback: undefined

Returns Promise<T>

getWebhookField

Type Parameters

T = unknown

Parameters

parameters: GetWebhookField

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: GetWebhookField

Optional callback: undefined

Returns Promise<T>

updateWebhook

Type Parameters

T = Webhook

Parameters

parameters: UpdateWebhook

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = Webhook

Parameters

parameters: UpdateWebhook

Optional callback: undefined

Returns Promise<T>

Settings

`Private` client

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined