Class WebhookSubscriptionsApi

WebhookSubscriptionsApi - object-oriented interface

export

Hierarchy

BaseAPI
- WebhookSubscriptionsApi

Index

Constructors

constructor

Methods

Constructors

constructor

new WebhookSubscriptionsApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): WebhookSubscriptionsApi

Inherited from BaseAPI.constructor
- Defined in base.ts:51
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns WebhookSubscriptionsApi

Methods

createWebhookSubscription

createWebhookSubscription(requestParameters: WebhookSubscriptionsApiCreateWebhookSubscriptionRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<WebhookSubscription, any>>

- Defined in api.ts:19316
Create a webhook-subscription

throws
{RequiredError}

memberof
WebhookSubscriptionsApi

Parameters
- requestParameters: WebhookSubscriptionsApiCreateWebhookSubscriptionRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<WebhookSubscription, any>>

deleteWebhookSubscription

deleteWebhookSubscription(requestParameters: WebhookSubscriptionsApiDeleteWebhookSubscriptionRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<void, any>>

- Defined in api.ts:19335
Delete a webhook-subscription.

throws
{RequiredError}

memberof
WebhookSubscriptionsApi

Parameters
- requestParameters: WebhookSubscriptionsApiDeleteWebhookSubscriptionRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<void, any>>

getWebhookSubscription

getWebhookSubscription(requestParameters: WebhookSubscriptionsApiGetWebhookSubscriptionRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<WebhookSubscription, any>>

- Defined in api.ts:19351
Get a webhook-subscription.

throws
{RequiredError}

memberof
WebhookSubscriptionsApi

Parameters
- requestParameters: WebhookSubscriptionsApiGetWebhookSubscriptionRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<WebhookSubscription, any>>

getWebhookSubscriptions

getWebhookSubscriptions(requestParameters?: WebhookSubscriptionsApiGetWebhookSubscriptionsRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<WebhookSubscriptionList, any>>

- Defined in api.ts:19367
Get webhook-subscriptions.

throws
{RequiredError}

memberof
WebhookSubscriptionsApi

Parameters
- requestParameters: WebhookSubscriptionsApiGetWebhookSubscriptionsRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<WebhookSubscriptionList, any>>

updateWebhookSubscription

updateWebhookSubscription(requestParameters: WebhookSubscriptionsApiUpdateWebhookSubscriptionRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<WebhookSubscription, any>>

- Defined in api.ts:19387
Update a webhook-subscription.

throws
{RequiredError}

memberof
WebhookSubscriptionsApi

Parameters
- requestParameters: WebhookSubscriptionsApiUpdateWebhookSubscriptionRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<WebhookSubscription, any>>