Class FunctionApi

FunctionApi - object-oriented interface

Export

FunctionApi

Hierarchy

BaseAPI
- FunctionApi

Index

Constructors

constructor

new FunctionApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): 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?: FunctionCreateDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<FunctionOutputDTOAPI>>
Required permissions: MANAGE_MODULES
OperationId: FunctionControllerCreate
Parameters
- OptionalfunctionCreateDTO: FunctionCreateDTO
  FunctionCreateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<FunctionOutputDTOAPI>>
Throws
Memberof
FunctionApi
- Defined in packages/lib-apiclient/src/generated/api.ts:13966

functionControllerGetOne

functionControllerGetOne(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<FunctionOutputDTOAPI>>
Required permissions: READ_MODULES
OperationId: FunctionControllerGetOne
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<FunctionOutputDTOAPI>>
Throws
Memberof
FunctionApi
- Defined in packages/lib-apiclient/src/generated/api.ts:13980

functionControllerRemove

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

functionControllerSearch

functionControllerSearch(
functionSearchInputDTO?: FunctionSearchInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<FunctionOutputArrayDTOAPI>>
Required permissions: READ_MODULES
OperationId: FunctionControllerSearch
Parameters
- OptionalfunctionSearchInputDTO: FunctionSearchInputDTO
  FunctionSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<FunctionOutputArrayDTOAPI>>
Throws
Memberof
FunctionApi
- Defined in packages/lib-apiclient/src/generated/api.ts:14008

functionControllerUpdate

functionControllerUpdate(
    id: string,
    functionUpdateDTO?: FunctionUpdateDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<FunctionOutputDTOAPI>>
Required permissions: MANAGE_MODULES
OperationId: FunctionControllerUpdate
Parameters
- id: string
- OptionalfunctionUpdateDTO: FunctionUpdateDTO
  FunctionUpdateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<FunctionOutputDTOAPI>>
Throws
Memberof
FunctionApi
- Defined in packages/lib-apiclient/src/generated/api.ts:14023

Class FunctionApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FunctionApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

functionControllerCreate

Parameters

Returns Promise<AxiosResponse<FunctionOutputDTOAPI>>

Throws

Memberof

functionControllerGetOne

Parameters

Returns Promise<AxiosResponse<FunctionOutputDTOAPI>>

Throws

Memberof

functionControllerRemove

Parameters

Returns Promise<AxiosResponse<APIOutput>>

Throws

Memberof

functionControllerSearch

Parameters

Returns Promise<AxiosResponse<FunctionOutputArrayDTOAPI>>

Throws

Memberof

functionControllerUpdate

Parameters

Returns Promise<AxiosResponse<FunctionOutputDTOAPI>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration