Class HookApi

HookApi - object-oriented interface

Export

HookApi

Hierarchy

BaseAPI
- HookApi

Index

Constructors

constructor

new HookApi(configuration?, basePath?, axios?): HookApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns HookApi
Inherited from BaseAPI.constructor
- Defined in packages/lib-apiclient/src/generated/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

hookControllerCreate

hookControllerCreate(hookCreateDTO?, options?): Promise<AxiosResponse<HookOutputDTOAPI, any>>
Required permissions: MANAGE_MODULES
Parameters
- OptionalhookCreateDTO: HookCreateDTO
  HookCreateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<HookOutputDTOAPI, any>>
Summary
Create

Throws
Memberof
HookApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16832

hookControllerGetExecutions

hookControllerGetExecutions(id, success?, eventSearchInputDTO?, options?): Promise<AxiosResponse<EventOutputArrayDTOAPI, any>>
Required permissions: READ_MODULES
Parameters
- id: string
- Optionalsuccess: any
- OptionaleventSearchInputDTO: EventSearchInputDTO
  EventSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EventOutputArrayDTOAPI, any>>
Summary
Get executions

Throws
Memberof
HookApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16848

hookControllerGetOne

hookControllerGetOne(id, options?): Promise<AxiosResponse<HookOutputDTOAPI, any>>
Required permissions: READ_MODULES
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<HookOutputDTOAPI, any>>
Summary
Get one

Throws
Memberof
HookApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16867

hookControllerRemove

hookControllerRemove(id, options?): Promise<AxiosResponse<APIOutput, any>>
Required permissions: MANAGE_MODULES
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Summary
Remove

Throws
Memberof
HookApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16881

hookControllerSearch

hookControllerSearch(hookSearchInputDTO?, options?): Promise<AxiosResponse<HookOutputArrayDTOAPI, any>>
Required permissions: READ_MODULES
Parameters
- OptionalhookSearchInputDTO: HookSearchInputDTO
  HookSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<HookOutputArrayDTOAPI, any>>
Summary
Search

Throws
Memberof
HookApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16895

hookControllerTrigger

hookControllerTrigger(hookTriggerDTO?, options?): Promise<AxiosResponse<void, any>>
Trigger a hook. This is used for testing purposes, the event will not actually be created but the hook-logic will be executed. You can pass any data you want, but it must validate against the corresponding event metadata. Eg to trigger the chat-message event, you must pass an object with a message property Required permissions: MANAGE_MODULES
Parameters
- OptionalhookTriggerDTO: HookTriggerDTO
  HookTriggerDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Trigger

Throws
Memberof
HookApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16909

hookControllerUpdate

hookControllerUpdate(id, hookUpdateDTO?, options?): Promise<AxiosResponse<HookOutputDTOAPI, any>>
Required permissions: MANAGE_MODULES
Parameters
- id: string
- OptionalhookUpdateDTO: HookUpdateDTO
  HookUpdateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<HookOutputDTOAPI, any>>
Summary
Update

Throws
Memberof
HookApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16924

Class HookApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns HookApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

hookControllerCreate

Parameters

Returns Promise<AxiosResponse<HookOutputDTOAPI, any>>

Summary

Throws

Memberof

hookControllerGetExecutions

Parameters

Returns Promise<AxiosResponse<EventOutputArrayDTOAPI, any>>

Summary

Throws

Memberof

hookControllerGetOne

Parameters

Returns Promise<AxiosResponse<HookOutputDTOAPI, any>>

Summary

Throws

Memberof

hookControllerRemove

Parameters

Returns Promise<AxiosResponse<APIOutput, any>>

Summary

Throws

Memberof

hookControllerSearch

Parameters

Returns Promise<AxiosResponse<HookOutputArrayDTOAPI, any>>

Summary

Throws

Memberof

hookControllerTrigger

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

hookControllerUpdate

Parameters

Returns Promise<AxiosResponse<HookOutputDTOAPI, any>>

Summary

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration