## @vipr/api@0.1.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 @vipr/api@0.1.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
------------ | ------------- | ------------- | -------------
*CompareApi* | [**cancelTaskApiCompareCancelTaskIdPost**](docs/CompareApi.md#canceltaskapicomparecanceltaskidpost) | **POST** /api/compare/cancel/{task_id} | Cancel Task
*CompareApi* | [**getTaskProgressApiCompareProgressTaskIdGet**](docs/CompareApi.md#gettaskprogressapicompareprogresstaskidget) | **GET** /api/compare/progress/{task_id} | Get Task Progress
*CompareApi* | [**healthCheckApiCompareHealthGet**](docs/CompareApi.md#healthcheckapicomparehealthget) | **GET** /api/compare/health | Health Check
*CompareApi* | [**runCompareAsyncApiCompareRunPost**](docs/CompareApi.md#runcompareasyncapicomparerunpost) | **POST** /api/compare/run | Run Compare Async
*DebugApi* | [**getApiMappingApiDebugApiMappingGet**](docs/DebugApi.md#getapimappingapidebugapimappingget) | **GET** /api/debug/api-mapping | Get Api Mapping
*DebugApi* | [**getPluginStatusApiDebugPluginStatusGet**](docs/DebugApi.md#getpluginstatusapidebugpluginstatusget) | **GET** /api/debug/plugin-status | Get Plugin Status
*DiscoveryApi* | [**getExampleConfig**](docs/DiscoveryApi.md#getexampleconfig) | **GET** /api/discovery/example-config | Get Endpoint
*DiscoveryApi* | [**getFilterTypes**](docs/DiscoveryApi.md#getfiltertypes) | **GET** /api/discovery/filter-types | Get Endpoint
*DiscoveryApi* | [**getHookTypes**](docs/DiscoveryApi.md#gethooktypes) | **GET** /api/discovery/hook-types | Get Endpoint
*DiscoveryApi* | [**getPluginSummary**](docs/DiscoveryApi.md#getpluginsummary) | **GET** /api/discovery/plugins | Get Endpoint
*DiscoveryApi* | [**listComponents**](docs/DiscoveryApi.md#listcomponents) | **GET** /api/discovery/components | Get Endpoint
*DiscoveryApi* | [**listDataLoaders**](docs/DiscoveryApi.md#listdataloaders) | **GET** /api/discovery/data-loaders | Get Endpoint
*DiscoveryApi* | [**listExampleConfigs**](docs/DiscoveryApi.md#listexampleconfigs) | **GET** /api/discovery/example-configs | Get Endpoint
*DiscoveryApi* | [**listFilters**](docs/DiscoveryApi.md#listfilters) | **GET** /api/discovery/filters | Get Endpoint
*DiscoveryApi* | [**listHooks**](docs/DiscoveryApi.md#listhooks) | **GET** /api/discovery/hooks | Get Endpoint
*DiscoveryApi* | [**listModelLoaders**](docs/DiscoveryApi.md#listmodelloaders) | **GET** /api/discovery/model-loaders | Get Endpoint
*DiscoveryApi* | [**listPostprocessors**](docs/DiscoveryApi.md#listpostprocessors) | **GET** /api/discovery/postprocessors | Get Endpoint
*DiscoveryApi* | [**listPredictors**](docs/DiscoveryApi.md#listpredictors) | **GET** /api/discovery/predictors | Get Endpoint
*FilesApi* | [**fetchFileApiFetchFileFilePathGet**](docs/FilesApi.md#fetchfileapifetchfilefilepathget) | **GET** /api/fetch_file/{file_path} | Fetch File
*FilesApi* | [**getHdf5MetadataApiHdf5MetadataFilePathGet**](docs/FilesApi.md#gethdf5metadataapihdf5metadatafilepathget) | **GET** /api/hdf5_metadata/{file_path} | Get Hdf5 Metadata
*FilesApi* | [**getHdf5PreviewApiHdf5PreviewPost**](docs/FilesApi.md#gethdf5previewapihdf5previewpost) | **POST** /api/hdf5_preview | Get Hdf5 Preview
*FilesApi* | [**uploadFileApiFileuploadPost**](docs/FilesApi.md#uploadfileapifileuploadpost) | **POST** /api/fileupload | Upload File
*FlowModelsApi* | [**getAvailableFlowModelsApiFlowModelsModelsGet**](docs/FlowModelsApi.md#getavailableflowmodelsapiflowmodelsmodelsget) | **GET** /api/flow_models/models | Get Available Flow Models
*FlowModelsApi* | [**getFlowModelParametersApiFlowModelsModelParametersGet**](docs/FlowModelsApi.md#getflowmodelparametersapiflowmodelsmodelparametersget) | **GET** /api/flow_models/{model}/parameters | Get Flow Model Parameters
*InferenceApi* | [**cancelTaskApiInferenceCancelTaskIdPost**](docs/InferenceApi.md#canceltaskapiinferencecanceltaskidpost) | **POST** /api/inference/cancel/{task_id} | Cancel Task
*InferenceApi* | [**exportCliYamlApiInferenceExportCliYamlPost**](docs/InferenceApi.md#exportcliyamlapiinferenceexportcliyamlpost) | **POST** /api/inference/export-cli-yaml | Export Cli Yaml
*InferenceApi* | [**getTaskProgressApiInferenceProgressTaskIdGet**](docs/InferenceApi.md#gettaskprogressapiinferenceprogresstaskidget) | **GET** /api/inference/progress/{task_id} | Get Task Progress
*InferenceApi* | [**healthCheckApiInferenceHealthGet**](docs/InferenceApi.md#healthcheckapiinferencehealthget) | **GET** /api/inference/health | Health Check
*InferenceApi* | [**runInferenceAsyncApiInferenceRunPost**](docs/InferenceApi.md#runinferenceasyncapiinferencerunpost) | **POST** /api/inference/run | Run Inference Async
*InferenceApi* | [**validateConfigApiInferenceValidateConfigPost**](docs/InferenceApi.md#validateconfigapiinferencevalidateconfigpost) | **POST** /api/inference/validate-config | Validate Config
*PanpeApi* | [**getAvailablePanpeModelsApiPanpeModelsGet**](docs/PanpeApi.md#getavailablepanpemodelsapipanpemodelsget) | **GET** /api/panpe/models | Get Available Panpe Models
*PanpeApi* | [**getPanpeParametersApiPanpeConfigNameParametersGet**](docs/PanpeApi.md#getpanpeparametersapipanpeconfignameparametersget) | **GET** /api/panpe/{config_name}/parameters | Get Panpe Parameters
*ReflectorchApi* | [**getAvailableModelsApiReflectorchModelsGet**](docs/ReflectorchApi.md#getavailablemodelsapireflectorchmodelsget) | **GET** /api/reflectorch/models | Get Available Models
*ReflectorchApi* | [**getParametersApiReflectorchModelParametersGet**](docs/ReflectorchApi.md#getparametersapireflectorchmodelparametersget) | **GET** /api/reflectorch/{model}/parameters | Get Parameters
*ReflectorchApi* | [**getStandardConfigApiReflectorchStandardConfigGet**](docs/ReflectorchApi.md#getstandardconfigapireflectorchstandardconfigget) | **GET** /api/reflectorch/standard-config | Get Standard Config
*StreamingApi* | [**getConsumerStatsApiStreamingStatsConsumerIdGet**](docs/StreamingApi.md#getconsumerstatsapistreamingstatsconsumeridget) | **GET** /api/streaming/stats/{consumer_id} | Get Consumer Stats
*StreamingApi* | [**getConsumerTasksApiStreamingTasksConsumerIdGet**](docs/StreamingApi.md#getconsumertasksapistreamingtasksconsumeridget) | **GET** /api/streaming/tasks/{consumer_id} | Get Consumer Tasks
*StreamingApi* | [**listActiveConsumersApiStreamingConsumersGet**](docs/StreamingApi.md#listactiveconsumersapistreamingconsumersget) | **GET** /api/streaming/consumers | List Active Consumers
*StreamingApi* | [**startStreamingPredictionApiStreamingStartPost**](docs/StreamingApi.md#startstreamingpredictionapistreamingstartpost) | **POST** /api/streaming/start | Start Streaming Prediction
*StreamingApi* | [**stopAllStreamingConsumersApiStreamingStopAllPost**](docs/StreamingApi.md#stopallstreamingconsumersapistreamingstopallpost) | **POST** /api/streaming/stop-all | Stop All Streaming Consumers
*StreamingApi* | [**stopStreamingPredictionApiStreamingStopConsumerIdPost**](docs/StreamingApi.md#stopstreamingpredictionapistreamingstopconsumeridpost) | **POST** /api/streaming/stop/{consumer_id} | Stop Streaming Prediction
*UiApi* | [**cleanupUIStorage**](docs/UiApi.md#cleanupuistorage) | **POST** /api/ui/storage/cleanup | Cleanup Old Storage Files
*UiApi* | [**getResultConfig**](docs/UiApi.md#getresultconfig) | **GET** /api/ui/result/config | Get Result Configuration
*UiApi* | [**getUIResult**](docs/UiApi.md#getuiresult) | **GET** /api/ui/result | Get Stored UI Result
*UiApi* | [**getUIResultStatus**](docs/UiApi.md#getuiresultstatus) | **GET** /api/ui/result/status | Check UI Result Status
*UiApi* | [**getUIStorageInfo**](docs/UiApi.md#getuistorageinfo) | **GET** /api/ui/storage/info | Get UI Storage Information
*UiApi* | [**listUIResults**](docs/UiApi.md#listuiresults) | **GET** /api/ui/results/list | List All Stored Results


### Documentation For Models

 - [AvailableModel](docs/AvailableModel.md)
 - [BodyUploadFileApiFileuploadPost](docs/BodyUploadFileApiFileuploadPost.md)
 - [BoundWidthRanges](docs/BoundWidthRanges.md)
 - [CallbackEntry](docs/CallbackEntry.md)
 - [CeleryExecutionMode](docs/CeleryExecutionMode.md)
 - [CeleryHealthStatus](docs/CeleryHealthStatus.md)
 - [CeleryState](docs/CeleryState.md)
 - [ClassBasedComponent](docs/ClassBasedComponent.md)
 - [CompareRunRequest](docs/CompareRunRequest.md)
 - [ComponentsResponse](docs/ComponentsResponse.md)
 - [ComponentsSummary](docs/ComponentsSummary.md)
 - [ConsumerStatsInfo](docs/ConsumerStatsInfo.md)
 - [ConsumerStatsResponse](docs/ConsumerStatsResponse.md)
 - [ConsumerTasksResponse](docs/ConsumerTasksResponse.md)
 - [CurveMetrics](docs/CurveMetrics.md)
 - [Diagram](docs/Diagram.md)
 - [DiagramMetadata](docs/DiagramMetadata.md)
 - [ExampleConfigDetail](docs/ExampleConfigDetail.md)
 - [ExampleConfigEntry](docs/ExampleConfigEntry.md)
 - [FileValidationResponse](docs/FileValidationResponse.md)
 - [HDF5Dataset](docs/HDF5Dataset.md)
 - [HDF5Metadata](docs/HDF5Metadata.md)
 - [HDF5PreviewData](docs/HDF5PreviewData.md)
 - [HTTPValidationError](docs/HTTPValidationError.md)
 - [HandlerConfig](docs/HandlerConfig.md)
 - [HandlerEntry](docs/HandlerEntry.md)
 - [HealthCheckResponse](docs/HealthCheckResponse.md)
 - [HooksValueInner](docs/HooksValueInner.md)
 - [Image](docs/Image.md)
 - [InferenceConfig](docs/InferenceConfig.md)
 - [ItemData](docs/ItemData.md)
 - [LocationInner](docs/LocationInner.md)
 - [LogEntry](docs/LogEntry.md)
 - [ModelParameterRanges](docs/ModelParameterRanges.md)
 - [NameBasedComponent](docs/NameBasedComponent.md)
 - [ParameterBounds](docs/ParameterBounds.md)
 - [PluginSummaryResponse](docs/PluginSummaryResponse.md)
 - [RabbitMQConfig](docs/RabbitMQConfig.md)
 - [RawInputData](docs/RawInputData.md)
 - [ReflectometryModelParameters](docs/ReflectometryModelParameters.md)
 - [ScaleType](docs/ScaleType.md)
 - [SeriesDefinition](docs/SeriesDefinition.md)
 - [SolutionMetrics](docs/SolutionMetrics.md)
 - [StoredResultResponseUIData](docs/StoredResultResponseUIData.md)
 - [StreamingConfig](docs/StreamingConfig.md)
 - [StreamingResponse](docs/StreamingResponse.md)
 - [StreamingTask](docs/StreamingTask.md)
 - [Table](docs/Table.md)
 - [TaskProgressResponse](docs/TaskProgressResponse.md)
 - [UIData](docs/UIData.md)
 - [VIPRConfigWithStreaming](docs/VIPRConfigWithStreaming.md)
 - [VIPRInferenceInput](docs/VIPRInferenceInput.md)
 - [VIPRInferenceOutput](docs/VIPRInferenceOutput.md)
 - [ValidationError](docs/ValidationError.md)


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

Endpoints do not require authorization.

