Class VariableApi

VariableApi - object-oriented interface

Export

VariableApi

Hierarchy

BaseAPI
- VariableApi

Index

Constructors

constructor

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

variableControllerCreate

variableControllerCreate(
variableCreateDTO?: VariableCreateDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<VariableOutputDTOAPI, any>>
Required permissions: MANAGE_VARIABLES
OperationId: VariableControllerCreate
Parameters
- OptionalvariableCreateDTO: VariableCreateDTO
  VariableCreateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<VariableOutputDTOAPI, any>>
Throws
Memberof
VariableApi
- Defined in packages/lib-apiclient/src/generated/api.ts:32667

variableControllerDelete

variableControllerDelete(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput, any>>
Required permissions: MANAGE_VARIABLES
OperationId: VariableControllerDelete
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Throws
Memberof
VariableApi
- Defined in packages/lib-apiclient/src/generated/api.ts:32681

variableControllerFindOne

variableControllerFindOne(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<VariableOutputDTOAPI, any>>
Required permissions: READ_VARIABLES
OperationId: VariableControllerFindOne
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<VariableOutputDTOAPI, any>>
Throws
Memberof
VariableApi
- Defined in packages/lib-apiclient/src/generated/api.ts:32695

variableControllerSearch

variableControllerSearch(
variableSearchInputDTO?: VariableSearchInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<VariableOutputArrayDTOAPI, any>>
Search variables Required permissions: READ_VARIABLES
OperationId: VariableControllerSearch
Parameters
- OptionalvariableSearchInputDTO: VariableSearchInputDTO
  VariableSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<VariableOutputArrayDTOAPI, any>>
Throws
Memberof
VariableApi
- Defined in packages/lib-apiclient/src/generated/api.ts:32709

variableControllerUpdate

variableControllerUpdate(
    id: string,
    variableUpdateDTO?: VariableUpdateDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<VariableOutputDTOAPI, any>>
Required permissions: MANAGE_VARIABLES
OperationId: VariableControllerUpdate
Parameters
- id: string
- OptionalvariableUpdateDTO: VariableUpdateDTO
  VariableUpdateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<VariableOutputDTOAPI, any>>
Throws
Memberof
VariableApi
- Defined in packages/lib-apiclient/src/generated/api.ts:32724

Class VariableApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns VariableApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

variableControllerCreate

Parameters

Returns Promise<AxiosResponse<VariableOutputDTOAPI, any>>

Throws

Memberof

variableControllerDelete

Parameters

Returns Promise<AxiosResponse<APIOutput, any>>

Throws

Memberof

variableControllerFindOne

Parameters

Returns Promise<AxiosResponse<VariableOutputDTOAPI, any>>

Throws

Memberof

variableControllerSearch

Parameters

Returns Promise<AxiosResponse<VariableOutputArrayDTOAPI, any>>

Throws

Memberof

variableControllerUpdate

Parameters

Returns Promise<AxiosResponse<VariableOutputDTOAPI, any>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration