Class GAWebhooks

Hierarchy

GlobalApi
- GAWebhooks

Index

Constructors

constructor

Properties

config

Methods

Constructors

constructor

new GAWebhooks(instanceConfig?: IGlobalApiSdkConfig): GAWebhooks

Inherited from GlobalApi.constructor
- Defined in src/GlobalAPI.ts:39
Parameters
- Optional instanceConfig: IGlobalApiSdkConfig
Returns GAWebhooks

Properties

Static config

config: IGlobalApiSdkConfig

Methods

Protected makeApiCall

makeApiCall(action: string, data?: indexedObject): IGlobalApiCallConfig

Inherited from GlobalApi.makeApiCall
- Defined in src/GlobalAPI.ts:51
Parameters
- action: string
- Optional data: indexedObject
Returns IGlobalApiCallConfig

Static createWebhook

createWebhook(body: { url: string }, instanceConfig?: IGlobalApiSdkConfig): Promise<IApiResponseObj<{ message: string }>>

- Defined in src/GAWebhooks.ts:15
Parameters
- body: { url: string }
  - url: string
- Optional instanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<{ message: string }>>

Static populateHeaders

populateHeaders(config: IGlobalApiSdkConfig): IGlobalApiHeaders

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

Static setConfig

setConfig(config: IGlobalApiSdkConfig): void

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

Static testWebhook

testWebhook(body: { url: string }, instanceConfig?: IGlobalApiSdkConfig): Promise<IApiResponseObj<{ message: string }>>

- Defined in src/GAWebhooks.ts:7
Parameters
- body: { url: string }
  - url: string
- Optional instanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<{ message: string }>>

Generated using TypeDoc