R API client for MosquitoAlert

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.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI spec from a remote server, you can easily generate an API client.

• API version: v1
• Package version: 1.0.0
• Generator version: 7.10.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.RClientCodegen

Installation

Prerequisites

Install the dependencies

install.packages("jsonlite")
install.packages("httr")
install.packages("base64enc")

Build the package

git clone https://github.com/Mosquito-Alert/mosquito-alert-R-sdk
cd mosquito-alert-R-sdk
R CMD build .
R CMD check MosquitoAlert_1.0.0.tar.gz --no-manual
R CMD INSTALL --preclean MosquitoAlert_1.0.0.tar.gz

Install the package

install.packages("MosquitoAlert")

To install directly from Github, use devtools:

install.packages("devtools")
library(devtools)
install_github("Mosquito-Alert/mosquito-alert-R-sdk")

To install the package from a local file:

install.packages("MosquitoAlert_1.0.0.tar.gz", repos = NULL, type = "source")

Usage

library(MosquitoAlert)

Reformat code

To reformat code using styler, please run the following in the R console:

install.packages("remotes")
remotes::install_github("r-lib/styler@v1.7.0.9003")
library("styler")
style_dir()

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
BitesApi	bites_create	POST /bites/
BitesApi	bites_destroy	DELETE /bites/{uuid}/
BitesApi	bites_list	GET /bites/
BitesApi	bites_retrieve	GET /bites/{uuid}/
BreedingSitesApi	breeding_sites_create	POST /breeding-sites/
BreedingSitesApi	breeding_sites_destroy	DELETE /breeding-sites/{uuid}/
BreedingSitesApi	breeding_sites_list	GET /breeding-sites/
BreedingSitesApi	breeding_sites_retrieve	GET /breeding-sites/{uuid}/
CampaignsApi	campaigns_list	GET /campaigns/
CampaignsApi	campaigns_retrieve	GET /campaigns/{id}/
CountriesApi	countries_retrieve	GET /countries/{id}/
FixesApi	fixes_create	POST /fixes/
NotificationsApi	notifications_create	POST /notifications/
NotificationsApi	notifications_list	GET /notifications/
NotificationsApi	notifications_partial_update	PATCH /notifications/{id}/
NotificationsApi	notifications_retrieve	GET /notifications/{id}/
NotificationsApi	notifications_update	PUT /notifications/{id}/
ObservationsApi	observations_create	POST /observations/
ObservationsApi	observations_destroy	DELETE /observations/{uuid}/
ObservationsApi	observations_list	GET /observations/
ObservationsApi	observations_prediction_create	POST /observations/{uuid}/prediction/
ObservationsApi	observations_prediction_destroy	DELETE /observations/{uuid}/prediction/
ObservationsApi	observations_prediction_retrieve	GET /observations/{uuid}/prediction/
ObservationsApi	observations_retrieve	GET /observations/{uuid}/
PartnersApi	partners_list	GET /partners/
PartnersApi	partners_retrieve	GET /partners/{id}/
PhotosApi	photos_prediction_create	POST /photos/{uuid}/prediction/
PhotosApi	photos_prediction_destroy	DELETE /photos/{uuid}/prediction/
PhotosApi	photos_prediction_retrieve	GET /photos/{uuid}/prediction/
PhotosApi	photos_retrieve	GET /photos/{uuid}/
TokenApi	token_create	POST /token/
TokenApi	token_refresh_create	POST /token/refresh/
UsersApi	users_create	POST /users/
UsersApi	users_partial_update	PATCH /users/{uuid}/
UsersApi	users_retrieve	GET /users/{uuid}/
UsersApi	users_update	PUT /users/{uuid}/

Documentation for Models

• AppUserTokenObtainPair
• AppUserTokenObtainPairRequest
• Bite
• BiteRequest
• BoundingBox
• BoundingBoxRequest
• BreedingSite
• BreedingSiteRequest
• Campaign
• Country
• CreateNotification
• CreateUser
• CreateUserRequest
• Device
• DeviceRequest
• Fix
• FixLocation
• FixLocationRequest
• FixRequest
• Location
• LocationPoint
• LocationRequest
• MetaNotificationRequest
• Notification
• NotificationRequest
• Observation
• ObservationPrediction
• ObservationPredictionRequest
• ObservationRequest
• Package
• PackageRequest
• PaginatedBiteList
• PaginatedBreedingSiteList
• PaginatedCampaignList
• PaginatedNotificationList
• PaginatedObservationList
• PaginatedPartnerList
• Partner
• PartnerPoint
• PatchedNotificationRequest
• PatchedUserRequest
• Photo
• PhotoPrediction
• PhotoPredictionRequest
• PredictionScore
• PredictionScoreRequest
• SimplePhoto
• SimplePhotoRequest
• TokenRefresh
• TokenRefreshRequest
• TopicNotificationCreateRequest
• User
• UserNotificationCreateRequest
• UserRequest

Documentation for Authorization

Authentication schemes defined for the API:

cookieAuth

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

jwtAuth

• Type: Bearer authentication
• Bearer Format: JWT

tokenAuth

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

Author

it@mosquitoalert.com