Skip to content

Mosquito-Alert/anomaly-detection-typescript-sdk

Repository files navigation

anomaly-detection@0.1.0

This generator creates TypeScript/JavaScript client that utilizes 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)

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 anomaly-detection@0.1.0 --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to https://metrics.mosquitoalert.com/api/v1

Class Method HTTP request Description
MetricsApi batchCreate POST /metrics/batch/
MetricsApi lastDateRetrieve GET /metrics/dates/last/
MetricsApi list GET /metrics/
MetricsApi retrieve GET /metrics/{id}/
MetricsApi seasonalityRetrieve GET /metrics/{id}/seasonality/
MetricsApi tilesRetrieve GET /metrics/tiles/{z}/{x}/{y}/
MetricsApi trendRetrieve GET /metrics/{id}/trend/
RegionsApi list GET /regions/
RegionsApi retrieve GET /regions/{id}/
RegionsApi tilesRetrieve GET /regions/tiles/{z}/{x}/{y}/
SchemaApi openapiJsonRetrieve GET /schema/openapi.json
SchemaApi openapiYmlRetrieve GET /schema/openapi.yml

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

tokenAuth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published