Class SettingsApi

Index

Constructors

Methods

clear clearWithHttpInfo configure configureWithHttpInfo getAll getAllWithHttpInfo

Constructors

constructor

new SettingsApi(configuration, requestFactory?, responseProcessor?): SettingsApi
Parameters
- configuration: Configuration
- OptionalrequestFactory: SettingsApiRequestFactory
- OptionalresponseProcessor: SettingsApiResponseProcessor
Returns SettingsApi
- Defined in codegen/webhooks/types/PromiseAPI.ts:19

Methods

clear

clear(appId, _options?): Promise<void>
Delete the webhook settings for the specified app. Event subscriptions will not be deleted, but will be paused until another webhook is created. Delete webhook settings
Parameters
- appId: number
  The ID of the app.
- Optional_options: Configuration
Returns Promise<void>
- Defined in codegen/webhooks/types/PromiseAPI.ts:42

clearWithHttpInfo

clearWithHttpInfo(appId, _options?): Promise<HttpInfo<void>>
Delete the webhook settings for the specified app. Event subscriptions will not be deleted, but will be paused until another webhook is created. Delete webhook settings
Parameters
- appId: number
  The ID of the app.
- Optional_options: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/webhooks/types/PromiseAPI.ts:32

configure

configure(appId, settingsChangeRequest, _options?): Promise<SettingsResponse>
Update webhook settings for the specified app. Delete webhook settings
Parameters
- appId: number
  The ID of the app.
- settingsChangeRequest: SettingsChangeRequest
- Optional_options: Configuration
Returns Promise<SettingsResponse>
- Defined in codegen/webhooks/types/PromiseAPI.ts:64

configureWithHttpInfo

configureWithHttpInfo(appId, settingsChangeRequest, _options?): Promise<HttpInfo<SettingsResponse>>
Update webhook settings for the specified app. Delete webhook settings
Parameters
- appId: number
  The ID of the app.
- settingsChangeRequest: SettingsChangeRequest
- Optional_options: Configuration
Returns Promise<HttpInfo<SettingsResponse>>
- Defined in codegen/webhooks/types/PromiseAPI.ts:53

getAll

getAll(appId, _options?): Promise<SettingsResponse>
Retrieve the webhook settings for the specified app, including the webhook’s target URL, throttle configuration, and create/update date. Read webhook settings
Parameters
- appId: number
  The ID of the app.
- Optional_options: Configuration
Returns Promise<SettingsResponse>
- Defined in codegen/webhooks/types/PromiseAPI.ts:84

getAllWithHttpInfo

getAllWithHttpInfo(appId, _options?): Promise<HttpInfo<SettingsResponse>>
Retrieve the webhook settings for the specified app, including the webhook’s target URL, throttle configuration, and create/update date. Read webhook settings
Parameters
- appId: number
  The ID of the app.
- Optional_options: Configuration
Returns Promise<HttpInfo<SettingsResponse>>
- Defined in codegen/webhooks/types/PromiseAPI.ts:74