Class WebhookApi

Hierarchy

BaseAPI
- WebhookApi

Index

Constructors

Properties

Methods

createWebhook createWebhookRaw getWebhook getWebhookRaw getWebhooks getWebhooksRaw pingWebhook pingWebhookRaw request unregisterWebhook unregisterWebhookRaw updateWebhook updateWebhookRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new WebhookApi(configuration?: Configuration): WebhookApi
Parameters
- configuration: Configuration = DefaultConfig
Returns WebhookApi
Inherited from BaseAPI.constructor
- Defined in runtime.ts:96

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

createWebhook

createWebhook(requestParameters?: CreateWebhookRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTWebhookInfo>
Parameters
- requestParameters: CreateWebhookRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTWebhookInfo>
- Defined in apis/WebhookApi.ts:95

createWebhookRaw

createWebhookRaw(requestParameters: CreateWebhookRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTWebhookInfo>>
Parameters
- requestParameters: CreateWebhookRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTWebhookInfo>>
- Defined in apis/WebhookApi.ts:67

getWebhook

getWebhook(requestParameters: GetWebhookRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTWebhookInfo>
Retrieve webhook by webhook ID.
Parameters
- requestParameters: GetWebhookRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTWebhookInfo>
- Defined in apis/WebhookApi.ts:133

getWebhookRaw

getWebhookRaw(requestParameters: GetWebhookRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTWebhookInfo>>
Retrieve webhook by webhook ID.
Parameters
- requestParameters: GetWebhookRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTWebhookInfo>>
- Defined in apis/WebhookApi.ts:103

getWebhooks

getWebhooks(requestParameters?: GetWebhooksRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTListResponseBTWebhookInfo>
Retrieve a list of webhooks registered for a company or user.
Parameters
- requestParameters: GetWebhooksRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTListResponseBTWebhookInfo>
- Defined in apis/WebhookApi.ts:183

getWebhooksRaw

getWebhooksRaw(requestParameters: GetWebhooksRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTListResponseBTWebhookInfo>>
Retrieve a list of webhooks registered for a company or user.
Parameters
- requestParameters: GetWebhooksRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTListResponseBTWebhookInfo>>
- Defined in apis/WebhookApi.ts:141

pingWebhook

pingWebhook(requestParameters: PingWebhookRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Parameters
- requestParameters: PingWebhookRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/WebhookApi.ts:219

pingWebhookRaw

pingWebhookRaw(requestParameters: PingWebhookRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Parameters
- requestParameters: PingWebhookRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/WebhookApi.ts:190

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in runtime.ts:116

unregisterWebhook

unregisterWebhook(requestParameters: UnregisterWebhookRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Delete webhook by webhook ID.
Parameters
- requestParameters: UnregisterWebhookRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/WebhookApi.ts:261

unregisterWebhookRaw

unregisterWebhookRaw(requestParameters: UnregisterWebhookRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Delete webhook by webhook ID.
Parameters
- requestParameters: UnregisterWebhookRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/WebhookApi.ts:227

updateWebhook

updateWebhook(requestParameters: UpdateWebhookRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTWebhookInfo>
Parameters
- requestParameters: UpdateWebhookRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTWebhookInfo>
- Defined in apis/WebhookApi.ts:300

updateWebhookRaw

updateWebhookRaw(requestParameters: UpdateWebhookRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTWebhookInfo>>
Parameters
- requestParameters: UpdateWebhookRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTWebhookInfo>>
- Defined in apis/WebhookApi.ts:268

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in runtime.ts:100

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in runtime.ts:111

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in runtime.ts:106

Generated using TypeDoc