open-index/open-npm huggingface dataset:
npm package: @fiftyten/service-contracts
Description: OpenAPI client for @fiftyten/service-contracts
Author: OpenAPI-Generator Contributors
Latest version: 0.0.4

## @fiftyten/service-contracts@0.0.4

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 @fiftyten/service-contracts@0.0.4 --save
```

_unPublished (not recommended):_

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

### Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**apiHealthGet**](docs/DefaultApi.md#apihealthget) | **GET** /api/health | Health check
*DefaultApi* | [**apiTasksPost**](docs/DefaultApi.md#apitaskspost) | **POST** /api/tasks | Submit tasks (single or batch)
*DefaultApi* | [**apiWorkersHeartbeatPost**](docs/DefaultApi.md#apiworkersheartbeatpost) | **POST** /api/workers/heartbeat | Send worker heartbeat
*DefaultApi* | [**apiWorkersRegisterPost**](docs/DefaultApi.md#apiworkersregisterpost) | **POST** /api/workers/register | Register a worker
*DefaultApi* | [**apiWorkersTaskResultPost**](docs/DefaultApi.md#apiworkerstaskresultpost) | **POST** /api/workers/task-result | Submit task result


### Documentation For Models

 - [ApiHealthGet200Response](docs/ApiHealthGet200Response.md)
 - [ApiTasksPostRequest](docs/ApiTasksPostRequest.md)
 - [ApiTasksPostRequestOneOf](docs/ApiTasksPostRequestOneOf.md)
 - [BaseMarketContext](docs/BaseMarketContext.md)
 - [Candle](docs/Candle.md)
 - [CandleStore](docs/CandleStore.md)
 - [CryptoMarketContext](docs/CryptoMarketContext.md)
 - [CryptoMarketType](docs/CryptoMarketType.md)
 - [DataUpdateEvent](docs/DataUpdateEvent.md)
 - [DataUpdateEventContext](docs/DataUpdateEventContext.md)
 - [EventMetadata](docs/EventMetadata.md)
 - [ExchangeType](docs/ExchangeType.md)
 - [Interval](docs/Interval.md)
 - [LoadContext](docs/LoadContext.md)
 - [Symbol](docs/Symbol.md)
 - [Task](docs/Task.md)
 - [TaskResult](docs/TaskResult.md)
 - [WorkerRegistration](docs/WorkerRegistration.md)
 - [WorkerStatus](docs/WorkerStatus.md)


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

Endpoints do not require authorization.