Skip to content

Mosquito-Alert/mosquito-alert-dart-sdk

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
.openapi-generator
.openapi-generator
 
 
doc
doc
 
 
lib
lib
 
 
test
test
 
 
.gitignore
.gitignore
 
 
.openapi-generator-ignore
.openapi-generator-ignore
 
 
README.md
README.md
 
 
analysis_options.yaml
analysis_options.yaml
 
 
build.sh
build.sh
 
 
pubspec.yaml
pubspec.yaml
 
 

Repository files navigation

mosquito_alert (EXPERIMENTAL)

Introducing API v1 for Mosquito Alert platform, a project desgined to facilitate citizen science initiatives and enable collaboration among scientists, public health officials, and environmental managers in the investigation and control of disease-carrying mosquitoes.

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: v1
  • Generator version: 7.14.0
  • Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements

Installation & Usage

pub.dev

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  mosquito_alert: 0.1.21

Github

If this Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
  mosquito_alert:
    git:
      url: https://github.com/Mosquito-Alert/mosquito-alert-dart-sdk.git
      #ref: main

Local development

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  mosquito_alert:
    path: /path/to/mosquito_alert

Getting Started

Please follow the installation procedure and then run the following:

import 'package:mosquito_alert/mosquito_alert.dart';


final api = MosquitoAlert().getAuthApi();
final PasswordChangeRequest passwordChangeRequest = ; // PasswordChangeRequest | 

try {
    api.changePassword(passwordChangeRequest);
} catch on DioException (e) {
    print("Exception when calling AuthApi->changePassword: $e\n");
}

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}/
PermissionsApi retrieveMine GET /me/permissions/
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: HTTP Bearer Token authentication (JWT)

tokenAuth

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

Author

[email protected]

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

3 watching

Forks

1 fork
Report repository

Releases

11 tags

Packages

No packages published

Languages