Function FunctionApiFactory

FunctionApi - factory interface

Export

FunctionApiFactory(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): {
    functionControllerCreate(
        functionCreateDTO?: FunctionCreateDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<FunctionOutputDTOAPI>;
    functionControllerGetOne(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<FunctionOutputDTOAPI>;
    functionControllerRemove(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<APIOutput>;
    functionControllerSearch(
        functionSearchInputDTO?: FunctionSearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<FunctionOutputArrayDTOAPI>;
    functionControllerUpdate(
        id: string,
        functionUpdateDTO?: FunctionUpdateDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<FunctionOutputDTOAPI>;
}
Parameters
- Optionalconfiguration: Configuration
- OptionalbasePath: string
- Optionalaxios: AxiosInstance
Returns {
    functionControllerCreate(
        functionCreateDTO?: FunctionCreateDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<FunctionOutputDTOAPI>;
    functionControllerGetOne(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<FunctionOutputDTOAPI>;
    functionControllerRemove(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<APIOutput>;
    functionControllerSearch(
        functionSearchInputDTO?: FunctionSearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<FunctionOutputArrayDTOAPI>;
    functionControllerUpdate(
        id: string,
        functionUpdateDTO?: FunctionUpdateDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<FunctionOutputDTOAPI>;
}
- functionControllerCreate:function
  - functionControllerCreate(
    functionCreateDTO?: FunctionCreateDTO,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<FunctionOutputDTOAPI>
  - Required permissions: MANAGE_MODULES
    OperationId: FunctionControllerCreate
    Parameters
    - OptionalfunctionCreateDTO: FunctionCreateDTO
      FunctionCreateDTO
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<FunctionOutputDTOAPI>
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:13888
- functionControllerGetOne:function
  - functionControllerGetOne(
    id: string,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<FunctionOutputDTOAPI>
  - Required permissions: READ_MODULES
    OperationId: FunctionControllerGetOne
    Parameters
    - id: string
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<FunctionOutputDTOAPI>
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:13903
- functionControllerRemove:function
  - functionControllerRemove(
    id: string,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<APIOutput>
  - Required permissions: MANAGE_MODULES
    OperationId: FunctionControllerRemove
    Parameters
    - id: string
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<APIOutput>
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:13913
- functionControllerSearch:function
  - functionControllerSearch(
    functionSearchInputDTO?: FunctionSearchInputDTO,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<FunctionOutputArrayDTOAPI>
  - Required permissions: READ_MODULES
    OperationId: FunctionControllerSearch
    Parameters
    - OptionalfunctionSearchInputDTO: FunctionSearchInputDTO
      FunctionSearchInputDTO
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<FunctionOutputArrayDTOAPI>
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:13923
- functionControllerUpdate:function
  - functionControllerUpdate(
        id: string,
        functionUpdateDTO?: FunctionUpdateDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<FunctionOutputDTOAPI>
  - Required permissions: MANAGE_MODULES
    OperationId: FunctionControllerUpdate
    Parameters
    - id: string
    - OptionalfunctionUpdateDTO: FunctionUpdateDTO
      FunctionUpdateDTO
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<FunctionOutputDTOAPI>
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:13939
- Defined in packages/lib-apiclient/src/generated/api.ts:13878

Function FunctionApiFactory

Export

Parameters

functionControllerCreate:function

Parameters

Returns AxiosPromise<FunctionOutputDTOAPI>

Throws

functionControllerGetOne:function

Parameters

Returns AxiosPromise<FunctionOutputDTOAPI>

Throws

functionControllerRemove:function

Parameters

Returns AxiosPromise<APIOutput>

Throws

functionControllerSearch:function

Parameters

Returns AxiosPromise<FunctionOutputArrayDTOAPI>

Throws

functionControllerUpdate:function

Parameters

Returns AxiosPromise<FunctionOutputDTOAPI>

Throws

Settings