Skip to content

Mosquito-Alert/mosquito-alert-typescript-sdk

BranchesTags

Repository files navigation

mosquito-alert@0.1.16

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 mosquito-alert@0.1.16 --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

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

Class Method HTTP request Description
AuthApi changePassword POST /auth/password/change/
AuthApi obtainToken POST /auth/token/
AuthApi refreshToken POST /auth/token/refresh/
AuthApi signupGuest POST /auth/signup/guest/
AuthApi verifyToken POST /auth/token/verify/
BitesApi create POST /bites/
BitesApi destroy DELETE /bites/{uuid}/
BitesApi list GET /bites/
BitesApi listMine GET /me/bites/
BitesApi retrieve GET /bites/{uuid}/
BreedingSitesApi create POST /breeding-sites/
BreedingSitesApi destroy DELETE /breeding-sites/{uuid}/
BreedingSitesApi list GET /breeding-sites/
BreedingSitesApi listMine GET /me/breeding-sites/
BreedingSitesApi retrieve GET /breeding-sites/{uuid}/
CampaignsApi list GET /campaigns/
CampaignsApi retrieve GET /campaigns/{id}/
CountriesApi list GET /countries/
CountriesApi retrieve GET /countries/{id}/
DevicesApi create POST /devices/
DevicesApi partialUpdate PATCH /devices/{device_id}/
DevicesApi retrieve GET /devices/{device_id}/
DevicesApi update PUT /devices/{device_id}/
FixesApi create POST /fixes/
IdentificationTasksApi annotationsCreate POST /identification-tasks/{observation_uuid}/annotations/
IdentificationTasksApi annotationsList GET /identification-tasks/{observation_uuid}/annotations/
IdentificationTasksApi annotationsListMine GET /me/identification-tasks/annotations/
IdentificationTasksApi annotationsRetrieve GET /identification-tasks/{observation_uuid}/annotations/{id}/
IdentificationTasksApi assignNext POST /identification-tasks/assignments/next/
IdentificationTasksApi list GET /identification-tasks/
IdentificationTasksApi listMine GET /me/identification-tasks/
IdentificationTasksApi predictionsCreate POST /identification-tasks/{observation_uuid}/predictions/
IdentificationTasksApi predictionsDestroy DELETE /identification-tasks/{observation_uuid}/predictions/{photo_uuid}/
IdentificationTasksApi predictionsList GET /identification-tasks/{observation_uuid}/predictions/
IdentificationTasksApi predictionsPartialUpdate PATCH /identification-tasks/{observation_uuid}/predictions/{photo_uuid}/
IdentificationTasksApi predictionsRetrieve GET /identification-tasks/{observation_uuid}/predictions/{photo_uuid}/
IdentificationTasksApi predictionsUpdate PUT /identification-tasks/{observation_uuid}/predictions/{photo_uuid}/
IdentificationTasksApi retrieve GET /identification-tasks/{observation_uuid}/
NotificationsApi create POST /notifications/
NotificationsApi list GET /notifications/
NotificationsApi listMine GET /me/notifications/
NotificationsApi partialUpdate PATCH /notifications/{id}/
NotificationsApi retrieve GET /notifications/{id}/
NotificationsApi update PUT /notifications/{id}/
ObservationsApi create POST /observations/
ObservationsApi destroy DELETE /observations/{uuid}/
ObservationsApi list GET /observations/
ObservationsApi listMine GET /me/observations/
ObservationsApi retrieve GET /observations/{uuid}/
PartnersApi list GET /partners/
PartnersApi retrieve GET /partners/{id}/
PhotosApi predictionDestroy DELETE /photos/{uuid}/prediction/
PhotosApi predictionPartialUpdate PATCH /photos/{uuid}/prediction/
PhotosApi predictionRetrieve GET /photos/{uuid}/prediction/
PhotosApi predictionUpdate PUT /photos/{uuid}/prediction/
PhotosApi retrieve GET /photos/{uuid}/
TaxaApi list GET /taxa/
TaxaApi retrieve GET /taxa/{id}/
TaxaApi rootTreeRetrieve GET /taxa/tree/
TaxaApi treeRetrieve GET /taxa/{id}/tree/
UsersApi partialUpdate PATCH /users/{uuid}/
UsersApi retrieve GET /users/{uuid}/
UsersApi retrieveMine GET /me/
UsersApi update PUT /users/{uuid}/

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

cookieAuth

  • Type: API key
  • API key parameter name: sessionid
  • Location:

jwtAuth

  • Type: Bearer authentication (JWT)

tokenAuth

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

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

3 watching

Forks

0 forks
Report repository

Releases

13 tags

Packages

No packages published

Languages