npm package: @skillvl/fastapi-backend-client
Description: OpenAPI client for @skillvl/fastapi-backend-client
Author: OpenAPI-Generator Contributors
Latest version: 1.8.0

## @skillvl/fastapi-backend-client@1.8.0

This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:

Environment
* Node.js
* Webpack
* Browserify

Language level
* ES5 - you must have a Promises/A+ library installed
* ES6

Module system
* CommonJS
* ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))

### Building

To build and compile the typescript sources to javascript use:
```
npm install
npm run build
```

### Publishing

First build the package then run `npm publish`

### Consuming

navigate to the folder of your consuming project and run one of the following commands.

_published:_

```
npm install @skillvl/fastapi-backend-client@1.8.0 --save
```

_unPublished (not recommended):_

```
npm install PATH_TO_GENERATED_PACKAGE --save
```

### Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ClusterApi* | [**clusterResourcesGet**](docs/ClusterApi.md#clusterresourcesget) | **GET** /cluster/resources/{virtualroom} | Resources
*ClusterApi* | [**clusterVirtualroomInfoGet**](docs/ClusterApi.md#clustervirtualroominfoget) | **GET** /cluster/virtualroom/{virtualroom}/info | Virtualroom Vm Infos
*ClusterApi* | [**clusterVmInfoGet**](docs/ClusterApi.md#clustervminfoget) | **GET** /cluster/vm/{vm}/info | Vm Info
*ClusterApi* | [**clusterVmShutdownPost**](docs/ClusterApi.md#clustervmshutdownpost) | **POST** /cluster/vm/{vm}/shutdown | Vm Shutdown
*ClusterApi* | [**clusterVmStartPost**](docs/ClusterApi.md#clustervmstartpost) | **POST** /cluster/vm/{vm}/start | Vm Start
*IsoApi* | [**isoGet**](docs/IsoApi.md#isoget) | **GET** /iso/{iso_id} | Get Iso
*IsoApi* | [**isoList**](docs/IsoApi.md#isolist) | **GET** /iso/ | Get Iso List
*VirtualroomApi* | [**virtualroomCreate**](docs/VirtualroomApi.md#virtualroomcreate) | **POST** /virtualroom/ | Create Virtualroom
*VirtualroomApi* | [**virtualroomDelete**](docs/VirtualroomApi.md#virtualroomdelete) | **DELETE** /virtualroom/{virtualroom} | Delete Virtualroom
*VirtualroomApi* | [**virtualroomGet**](docs/VirtualroomApi.md#virtualroomget) | **GET** /virtualroom/{virtualroom} | Get Virtualroom
*VirtualroomApi* | [**virtualroomList**](docs/VirtualroomApi.md#virtualroomlist) | **GET** /virtualroom/ | Get Virtualroom List
*VirtualroomApi* | [**virtualroomMetadataGet**](docs/VirtualroomApi.md#virtualroommetadataget) | **GET** /virtualroom/{virtualroom}/metadata | Get Virtualroom Metadata
*VirtualroomApi* | [**virtualroomTemplateCreate**](docs/VirtualroomApi.md#virtualroomtemplatecreate) | **POST** /virtualroom/template | Create Template
*VirtualroomApi* | [**virtualroomTemplateDelete**](docs/VirtualroomApi.md#virtualroomtemplatedelete) | **DELETE** /virtualroom/template/{virtualroomtemplate} | Delete Template
*VirtualroomApi* | [**virtualroomTemplateGet**](docs/VirtualroomApi.md#virtualroomtemplateget) | **GET** /virtualroom/template/{virtualroomtemplate} | Get Template
*VirtualroomApi* | [**virtualroomTemplateList**](docs/VirtualroomApi.md#virtualroomtemplatelist) | **GET** /virtualroom/template | Get Template List
*VirtualroomApi* | [**virtualroomTemplateMetadataGet**](docs/VirtualroomApi.md#virtualroomtemplatemetadataget) | **GET** /virtualroom/template/{virtualroomtemplate}/metadata | Get Virtualroomtemplate Metadata
*VirtualroomApi* | [**virtualroomTemplatePut**](docs/VirtualroomApi.md#virtualroomtemplateput) | **PUT** /virtualroom/template/{virtualroomtemplate} | Put Template
*VncApi* | [**vncVncProxyGet**](docs/VncApi.md#vncvncproxyget) | **GET** /vnc/vnc-proxy/{node}/{vm} | Vnc Proxy


### Documentation For Models

 - [EnumAudioDevice](docs/EnumAudioDevice.md)
 - [EnumAudioDriver](docs/EnumAudioDriver.md)
 - [EnumCPUType](docs/EnumCPUType.md)
 - [EnumDiskCache](docs/EnumDiskCache.md)
 - [EnumDiskMedia](docs/EnumDiskMedia.md)
 - [EnumISOOSTypes](docs/EnumISOOSTypes.md)
 - [EnumNetModel](docs/EnumNetModel.md)
 - [EnumSpiceVideoStreaming](docs/EnumSpiceVideoStreaming.md)
 - [EnumVGAType](docs/EnumVGAType.md)
 - [EnumVMArch](docs/EnumVMArch.md)
 - [EnumVMBios](docs/EnumVMBios.md)
 - [EnumVMMachine](docs/EnumVMMachine.md)
 - [EnumVMOSType](docs/EnumVMOSType.md)
 - [EnumVMSCSIHW](docs/EnumVMSCSIHW.md)
 - [EnumVirtualRoomState](docs/EnumVirtualRoomState.md)
 - [HTTPValidationError](docs/HTTPValidationError.md)
 - [HardwareResourceModel](docs/HardwareResourceModel.md)
 - [HardwareResources](docs/HardwareResources.md)
 - [ISO](docs/ISO.md)
 - [IdeDisk](docs/IdeDisk.md)
 - [JobCreatedResponseModel](docs/JobCreatedResponseModel.md)
 - [JobCreatedResponseTrackingModel](docs/JobCreatedResponseTrackingModel.md)
 - [LocationInner](docs/LocationInner.md)
 - [Metadata](docs/Metadata.md)
 - [MetadataCreate](docs/MetadataCreate.md)
 - [Nic](docs/Nic.md)
 - [PermissionTicketModel](docs/PermissionTicketModel.md)
 - [ResourceLimitExceededModel](docs/ResourceLimitExceededModel.md)
 - [ResourceLimitMaintainedModel](docs/ResourceLimitMaintainedModel.md)
 - [Response401VirtualroomMetadataGet](docs/Response401VirtualroomMetadataGet.md)
 - [SataDisk](docs/SataDisk.md)
 - [ScsiDisk](docs/ScsiDisk.md)
 - [StringReasonModel](docs/StringReasonModel.md)
 - [Switch](docs/Switch.md)
 - [SwitchCreate](docs/SwitchCreate.md)
 - [User](docs/User.md)
 - [VM](docs/VM.md)
 - [VMAudio](docs/VMAudio.md)
 - [VMAudioCreate](docs/VMAudioCreate.md)
 - [VMBootOrder](docs/VMBootOrder.md)
 - [VMConfig](docs/VMConfig.md)
 - [VMCreate](docs/VMCreate.md)
 - [VMIdeDisk](docs/VMIdeDisk.md)
 - [VMIdeDiskCreate](docs/VMIdeDiskCreate.md)
 - [VMNic](docs/VMNic.md)
 - [VMNicCreate](docs/VMNicCreate.md)
 - [VMSataDisk](docs/VMSataDisk.md)
 - [VMSataDiskCreate](docs/VMSataDiskCreate.md)
 - [VMScsiDisk](docs/VMScsiDisk.md)
 - [VMScsiDiskCreate](docs/VMScsiDiskCreate.md)
 - [VMVirtioDisk](docs/VMVirtioDisk.md)
 - [VMVirtioDiskCreate](docs/VMVirtioDiskCreate.md)
 - [VNCProxyData](docs/VNCProxyData.md)
 - [ValidationError](docs/ValidationError.md)
 - [VirtioDisk](docs/VirtioDisk.md)
 - [VirtualRoom](docs/VirtualRoom.md)
 - [VirtualRoomCreate](docs/VirtualRoomCreate.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="JWTBearer"></a>
### JWTBearer

- **Type**: Bearer authentication (JWT)