Class WebhooksApi

WebhooksApi - object-oriented interface

Export

Hierarchy

BaseAPI
- WebhooksApi

Index

Constructors

constructor

new WebhooksApi(configuration?, basePath?, axios?): WebhooksApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns WebhooksApi
Inherited from BaseAPI.constructor
- Defined in base.ts:53

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

webhooksCreate

webhooksCreate(requestParameters, options?): Promise<AxiosResponse<WebhookRead, any>>
Parameters
- requestParameters: WebhooksApiWebhooksCreateRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<WebhookRead, any>>

Summary
Method creates a webhook

Throws

Memberof
WebhooksApi
- Defined in api-client/webhooks-api.ts:1260

webhooksCreateDeliveriesRedelivery

webhooksCreateDeliveriesRedelivery(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: WebhooksApiWebhooksCreateDeliveriesRedeliveryRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
Method redeliver a specific webhook delivery

Throws

Memberof
WebhooksApi
- Defined in api-client/webhooks-api.ts:1272

webhooksCreatePing

webhooksCreatePing(requestParameters, options?): Promise<AxiosResponse<WebhookDeliveryRead, any>>
Parameters
- requestParameters: WebhooksApiWebhooksCreatePingRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<WebhookDeliveryRead, any>>

Summary
Method send ping webhook

Throws

Memberof
WebhooksApi
- Defined in api-client/webhooks-api.ts:1284

webhooksDestroy

webhooksDestroy(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: WebhooksApiWebhooksDestroyRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
Method deletes a webhook

Throws

Memberof
WebhooksApi
- Defined in api-client/webhooks-api.ts:1296

webhooksList

webhooksList(requestParameters?, options?): Promise<AxiosResponse<PaginatedWebhookReadList, any>>
Parameters
- requestParameters: WebhooksApiWebhooksListRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedWebhookReadList, any>>

Summary
Method returns a paginated list of webhook according to query parameters

Throws

Memberof
WebhooksApi
- Defined in api-client/webhooks-api.ts:1308

webhooksListDeliveries

webhooksListDeliveries(requestParameters, options?): Promise<AxiosResponse<PaginatedWebhookDeliveryReadList, any>>
Parameters
- requestParameters: WebhooksApiWebhooksListDeliveriesRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedWebhookDeliveryReadList, any>>

Summary
Method return a list of deliveries for a specific webhook

Throws

Memberof
WebhooksApi
- Defined in api-client/webhooks-api.ts:1320

webhooksPartialUpdate

webhooksPartialUpdate(requestParameters, options?): Promise<AxiosResponse<WebhookRead, any>>
Parameters
- requestParameters: WebhooksApiWebhooksPartialUpdateRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<WebhookRead, any>>

Summary
Methods does a partial update of chosen fields in a webhook

Throws

Memberof
WebhooksApi
- Defined in api-client/webhooks-api.ts:1332

webhooksRetrieve

webhooksRetrieve(requestParameters, options?): Promise<AxiosResponse<WebhookRead, any>>
Parameters
- requestParameters: WebhooksApiWebhooksRetrieveRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<WebhookRead, any>>

Summary
Method returns details of a webhook

Throws

Memberof
WebhooksApi
- Defined in api-client/webhooks-api.ts:1344

webhooksRetrieveDeliveries

webhooksRetrieveDeliveries(requestParameters, options?): Promise<AxiosResponse<WebhookDeliveryRead, any>>
Parameters
- requestParameters: WebhooksApiWebhooksRetrieveDeliveriesRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<WebhookDeliveryRead, any>>

Summary
Method return a specific delivery for a specific webhook

Throws

Memberof
WebhooksApi
- Defined in api-client/webhooks-api.ts:1356

webhooksRetrieveEvents

webhooksRetrieveEvents(requestParameters?, options?): Promise<AxiosResponse<Events, any>>
Parameters
- requestParameters: WebhooksApiWebhooksRetrieveEventsRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<Events, any>>

Summary
Method return a list of available webhook events

Throws

Memberof
WebhooksApi
- Defined in api-client/webhooks-api.ts:1368

webhooksUpdate

webhooksUpdate(requestParameters, options?): Promise<AxiosResponse<WebhookRead, any>>
Parameters
- requestParameters: WebhooksApiWebhooksUpdateRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<WebhookRead, any>>

Summary
Method updates a webhook by id

Throws

Memberof
WebhooksApi
- Defined in api-client/webhooks-api.ts:1380

Class WebhooksApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional configuration: Configuration

basePath: string = BASE_PATH

axios: AxiosInstance = globalAxios

Returns WebhooksApi

Properties

Protected axios

Protected basePath

Protected configuration

Methods

webhooksCreate

Parameters

requestParameters: WebhooksApiWebhooksCreateRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<WebhookRead, any>>

Summary

Throws

Memberof

webhooksCreateDeliveriesRedelivery

Parameters

requestParameters: WebhooksApiWebhooksCreateDeliveriesRedeliveryRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

webhooksCreatePing

Parameters

requestParameters: WebhooksApiWebhooksCreatePingRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<WebhookDeliveryRead, any>>

Summary

Throws

Memberof

webhooksDestroy

Parameters

requestParameters: WebhooksApiWebhooksDestroyRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

webhooksList

Parameters

requestParameters: WebhooksApiWebhooksListRequest = {}

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<PaginatedWebhookReadList, any>>

Summary

Throws

Memberof

webhooksListDeliveries

Parameters

requestParameters: WebhooksApiWebhooksListDeliveriesRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<PaginatedWebhookDeliveryReadList, any>>

Summary

Throws

Memberof

webhooksPartialUpdate

Parameters

requestParameters: WebhooksApiWebhooksPartialUpdateRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<WebhookRead, any>>

Summary

Throws

Memberof

webhooksRetrieve

Parameters

requestParameters: WebhooksApiWebhooksRetrieveRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<WebhookRead, any>>

`Optional` configuration: Configuration

`Protected` axios

`Protected` basePath

`Protected` configuration

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>