Class GAWebhooks

Hierarchy (View Summary)

GlobalApi
- GAWebhooks

Index

Constructors

Properties

Methods

makeApiCall createWebhook populateHeaders setConfig testWebhook

Constructors

constructor

new GAWebhooks(instanceConfig?: IGlobalApiSdkConfig): GAWebhooks
Parameters
- OptionalinstanceConfig: IGlobalApiSdkConfig
Returns GAWebhooks
Inherited from GlobalApi.constructor
- Defined in src/GlobalAPI.ts:40

Properties

`Static`config

config: IGlobalApiSdkConfig

Methods

`Protected`makeApiCall

makeApiCall(action: string, data?: indexedObject): IGlobalApiCallConfig
Parameters
- action: string
- Optionaldata: indexedObject
Returns IGlobalApiCallConfig
Inherited from GlobalApi.makeApiCall
- Defined in src/GlobalAPI.ts:52

`Static`createWebhook

createWebhook(
body: { url: string },
instanceConfig?: IGlobalApiSdkConfig,
): Promise<IApiResponseObj<{ message: string }>>
Parameters
- body: { url: string }
- OptionalinstanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<{ message: string }>>
- Defined in src/GAWebhooks.ts:15

`Static`populateHeaders

populateHeaders(config: IGlobalApiSdkConfig): IGlobalApiHeaders
Parameters
- config: IGlobalApiSdkConfig
Returns IGlobalApiHeaders
Inherited from GlobalApi.populateHeaders
- Defined in src/GlobalAPI.ts:23

`Static`setConfig

setConfig(config: IGlobalApiSdkConfig): void
Parameters
- config: IGlobalApiSdkConfig
Returns void
Inherited from GlobalApi.setConfig
- Defined in src/GlobalAPI.ts:36

`Static`testWebhook

testWebhook(
body: { url: string },
instanceConfig?: IGlobalApiSdkConfig,
): Promise<IApiResponseObj<{ message: string }>>
Parameters
- body: { url: string }
- OptionalinstanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<{ message: string }>>
- Defined in src/GAWebhooks.ts:7