Class FunctionApi

FunctionApi - object-oriented interface

Export

FunctionApi

Hierarchy

BaseAPI
- FunctionApi

Index

Constructors

constructor

new FunctionApi(configuration?, basePath?, axios?): FunctionApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns FunctionApi
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

functionControllerCreate

functionControllerCreate(functionCreateDTO?, options?): Promise<AxiosResponse<FunctionOutputDTOAPI, any>>
Required permissions: MANAGE_MODULES
Parameters
- OptionalfunctionCreateDTO: FunctionCreateDTO
  FunctionCreateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<FunctionOutputDTOAPI, any>>
Summary
Create

Throws
Memberof
FunctionApi
- Defined in packages/lib-apiclient/src/generated/api.ts:13814

functionControllerGetOne

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

Throws
Memberof
FunctionApi
- Defined in packages/lib-apiclient/src/generated/api.ts:13828

functionControllerRemove

functionControllerRemove(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
FunctionApi
- Defined in packages/lib-apiclient/src/generated/api.ts:13842

functionControllerSearch

functionControllerSearch(functionSearchInputDTO?, options?): Promise<AxiosResponse<FunctionOutputArrayDTOAPI, any>>
Required permissions: READ_MODULES
Parameters
- OptionalfunctionSearchInputDTO: FunctionSearchInputDTO
  FunctionSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<FunctionOutputArrayDTOAPI, any>>
Summary
Search

Throws
Memberof
FunctionApi
- Defined in packages/lib-apiclient/src/generated/api.ts:13856

functionControllerUpdate

functionControllerUpdate(id, functionUpdateDTO?, options?): Promise<AxiosResponse<FunctionOutputDTOAPI, any>>
Required permissions: MANAGE_MODULES
Parameters
- id: string
- OptionalfunctionUpdateDTO: FunctionUpdateDTO
  FunctionUpdateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<FunctionOutputDTOAPI, any>>
Summary
Update

Throws
Memberof
FunctionApi
- Defined in packages/lib-apiclient/src/generated/api.ts:13871

Class FunctionApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FunctionApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

functionControllerCreate

Parameters

Returns Promise<AxiosResponse<FunctionOutputDTOAPI, any>>

Summary

Throws

Memberof

functionControllerGetOne

Parameters

Returns Promise<AxiosResponse<FunctionOutputDTOAPI, any>>

Summary

Throws

Memberof

functionControllerRemove

Parameters

Returns Promise<AxiosResponse<APIOutput, any>>

Summary

Throws

Memberof

functionControllerSearch

Parameters

Returns Promise<AxiosResponse<FunctionOutputArrayDTOAPI, any>>

Summary

Throws

Memberof

functionControllerUpdate

Parameters

Returns Promise<AxiosResponse<FunctionOutputDTOAPI, any>>

Summary

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration