Class HookApi

HookApi - object-oriented interface

Export

HookApi

Hierarchy

BaseAPI
- HookApi

Index

Constructors

constructor

new HookApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): 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: Configuration | undefined

Methods

hookControllerCreate

hookControllerCreate(
hookCreateDTO?: HookCreateDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<HookOutputDTOAPI, any>>
Required permissions: MANAGE_MODULES
OperationId: HookControllerCreate
Parameters
- OptionalhookCreateDTO: HookCreateDTO
  HookCreateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<HookOutputDTOAPI, any>>
Throws
Memberof
HookApi
- Defined in packages/lib-apiclient/src/generated/api.ts:22691

hookControllerGetExecutions

hookControllerGetExecutions(
    id: string,
    success?: any,
    eventSearchInputDTO?: EventSearchInputDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<EventOutputArrayDTOAPI, any>>
Required permissions: READ_MODULES
OperationId: HookControllerGetExecutions
Parameters
- id: string
- Optionalsuccess: any
- OptionaleventSearchInputDTO: EventSearchInputDTO
  EventSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EventOutputArrayDTOAPI, any>>
Throws
Memberof
HookApi
- Defined in packages/lib-apiclient/src/generated/api.ts:22707

hookControllerGetOne

hookControllerGetOne(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<HookOutputDTOAPI, any>>
Required permissions: READ_MODULES
OperationId: HookControllerGetOne
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<HookOutputDTOAPI, any>>
Throws
Memberof
HookApi
- Defined in packages/lib-apiclient/src/generated/api.ts:22726

hookControllerRemove

hookControllerRemove(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput, any>>
Required permissions: MANAGE_MODULES
OperationId: HookControllerRemove
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Throws
Memberof
HookApi
- Defined in packages/lib-apiclient/src/generated/api.ts:22740

hookControllerSearch

hookControllerSearch(
hookSearchInputDTO?: HookSearchInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<HookOutputArrayDTOAPI, any>>
Search hooks Required permissions: READ_MODULES
OperationId: HookControllerSearch
Parameters
- OptionalhookSearchInputDTO: HookSearchInputDTO
  HookSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<HookOutputArrayDTOAPI, any>>
Throws
Memberof
HookApi
- Defined in packages/lib-apiclient/src/generated/api.ts:22754

hookControllerTrigger

hookControllerTrigger(
hookTriggerDTO?: HookTriggerDTO,
options?: RawAxiosRequestConfig,
): 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
OperationId: HookControllerTrigger
Parameters
- OptionalhookTriggerDTO: HookTriggerDTO
  HookTriggerDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
HookApi
- Defined in packages/lib-apiclient/src/generated/api.ts:22768

hookControllerUpdate

hookControllerUpdate(
    id: string,
    hookUpdateDTO?: HookUpdateDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<HookOutputDTOAPI, any>>
Required permissions: MANAGE_MODULES
OperationId: HookControllerUpdate
Parameters
- id: string
- OptionalhookUpdateDTO: HookUpdateDTO
  HookUpdateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<HookOutputDTOAPI, any>>
Throws
Memberof
HookApi
- Defined in packages/lib-apiclient/src/generated/api.ts:22783

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>>

Throws

Memberof

hookControllerGetExecutions

Parameters

Returns Promise<AxiosResponse<EventOutputArrayDTOAPI, any>>

Throws

Memberof

hookControllerGetOne

Parameters

Returns Promise<AxiosResponse<HookOutputDTOAPI, any>>

Throws

Memberof

hookControllerRemove

Parameters

Returns Promise<AxiosResponse<APIOutput, any>>

Throws

Memberof

hookControllerSearch

Parameters

Returns Promise<AxiosResponse<HookOutputArrayDTOAPI, any>>

Throws

Memberof

hookControllerTrigger

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

hookControllerUpdate

Parameters

Returns Promise<AxiosResponse<HookOutputDTOAPI, any>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration