Ballerina library

covid19

Module covid19

OverviewQuickstart

API

Client

Definitions

Cases
ClientHttp1Settings
ConnectionConfig
CovidAll
CovidAppleData
CovidappledataData
CovidAppleSubregions
CovidContinent
CovidcontinentContinentinfo
CovidCountry
CovidcountryCountryinfo
CovidHistoricalAll
CovidHistoricalCountry
CovidhistoricalInner
CovidHistoricalProvince
CovidhistoricaluscountyInner
CovidJHUCountry
CovidjhucountryCoordinates
CovidjhucountryStats
CovidJHUCounty
CovidnytcountyInner
CovidnytstateInner
CovidnytusaInner
CovidState
FullvaccinetimelineInner
ILINet
InfluenzaILINet
InfluenzaUSCL
InfluenzaUSPHL
Phases
ProxyConfig
SimpleVaccineTimeline
Therapeutic
Therapeutics
Timeline
TimelineDeaths
USCL
USPHL
Vaccine
VaccineCountryCoverage
Vaccines
VaccineStateCoverage

VaccineCoverage

ballerinax/covid19 Ballerina library

1.5.1

Overview

This is a generated connector from Novel COVID-19 API v3.0.0 OpenAPI Specification.

Ballerina connector for COVID-19 provides easy access to latest COVID-19 related data across the world. Please refer to API documentation for more detail.

Quickstart

To use the COVID-19 connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

Copy
import ballerinax/covid19

Step 2: Create a new connector instance

Copy
covid19:Client covid19Client = check new ();

Step 3: Invoke connector operation

  1. Get COVID-19 status by country
Copy
public function main() {
    covid19:CovidCountry statusByCountry = check covid19Client->getStatusByCountry("sri lanka");
}
  1. Use bal run command to compile and run the Ballerina program.

Clients

covid19: Client

Isolated

This is a generated connector from Novel COVID-19 API version 3.0.0 OpenAPI Specification. Ballerina connector for COVID-19 provides easy access to latest COVID-19 related data across the world. Please refer to API documentation for more detail.

Constructor

Gets invoked to initialize the connector. The connector initialization doesn't require setting the API credentials.

init (ConnectionConfig config, string serviceUrl)
  • config ConnectionConfig {} - The configurations to be used when initializing the connector
  • serviceUrl string "https://disease.sh" - URL of the target service

getGlobalStatus

Isolated FunctionRemote Function
function getGlobalStatus(string? yesterday, string? twoDaysAgo, string? allowNull) returns CovidAll|error

Get global COVID-19 totals for today, yesterday and two days ago

Parameters
  • yesterday string? (default ()) - Enter true(1) to receive data reported a day ago. Default is false(0)
  • twoDaysAgo string? (default ()) - Enter true(1) to receive data reported two days ago. Default is false(0)
  • allowNull string? (default ()) - By default, value is 0. Enter 1 to allow nulls to be returned
Return Type

getAllUSAStatesStatus

Isolated FunctionRemote Function
function getAllUSAStatesStatus(string? sort, string? yesterday, string? allowNull) returns CovidStates|error

Get COVID-19 totals for all US States

Parameters
  • sort string? (default ()) - Provided a key (e.g. cases, todayCases, deaths, active), result will be sorted from greatest to least
  • yesterday string? (default ()) - Enter true(1) to receive data reported a day ago. Default is false(0)
  • allowNull string? (default ()) - By default, value is 0. Enter 1 to allow nulls to be returned
Return Type
  • CovidStates|error - Status OK

getUSAStatusByState

Isolated FunctionRemote Function
function getUSAStatusByState(string states, string? yesterday, string? allowNull) returns CovidState|error

Get COVID-19 totals for specific US State(s)

Parameters
  • states string - State name or comma separated names spelled correctly
  • yesterday string? (default ()) - Enter true(1) to receive data reported a day ago. Default is false(0)
  • allowNull string? (default ()) - By default, value is 0. Enter 1 to allow nulls to be returned
Return Type

getAllContinentsStatus

Isolated FunctionRemote Function
function getAllContinentsStatus(string? yesterday, string? twoDaysAgo, string? sort, string? allowNull) returns CovidContinents|error

Get COVID-19 totals for all continents

Parameters
  • yesterday string? (default ()) - Enter true(1) to receive data reported a day ago. Default is false(0)
  • twoDaysAgo string? (default ()) - Enter true(1) to receive data reported two days ago. Default is false(0)
  • sort string? (default ()) - Provided a key (e.g. cases, todayCases, deaths, recovered, active), results will be sorted from greatest to least
  • allowNull string? (default ()) - By default, value is 0. Enter 1 to allow nulls to be returned
Return Type
  • CovidContinents|error - Status OK

getStatusByContinent

Isolated FunctionRemote Function
function getStatusByContinent(string continent, string? yesterday, string? twoDaysAgo, string strict, string? allowNull) returns CovidContinent|error

Get COVID-19 totals for a specific continent

Parameters
  • continent string - Continent name
  • yesterday string? (default ()) - Enter true(1) to receive data reported a day ago. Default is false(0)
  • twoDaysAgo string? (default ()) - Enter true(1) to receive data reported two days ago. Default is false(0)
  • strict string (default "true") - Setting to false gives you the ability to fuzzy search continents (i.e. Oman vs. rOMANia)
  • allowNull string? (default ()) - By default, value is 0. Enter 1 to allow nulls to be returned
Return Type

getAllCountriesStatus

Isolated FunctionRemote Function
function getAllCountriesStatus(string? yesterday, string? twoDaysAgo, string? sort, string? allowNull) returns CovidCountries|error

Get COVID-19 totals for all countries

Parameters
  • yesterday string? (default ()) - Enter true(1) to receive data reported a day ago. Default is false(0)
  • twoDaysAgo string? (default ()) - Enter true(1) to receive data reported two days ago. Default is false(0)
  • sort string? (default ()) - Provided a key (e.g. cases, todayCases, deaths, recovered, active), the result will be sorted from greatest to least
  • allowNull string? (default ()) - By default, value is 0. Enter 1 to allow nulls to be returned
Return Type
  • CovidCountries|error - Status OK

getStatusByCountry

Isolated FunctionRemote Function
function getStatusByCountry(string country, string? yesterday, string? twoDaysAgo, string strict, string? allowNull) returns CovidCountry|error

Get COVID-19 totals for a specific country

Parameters
  • country string - A country name, iso2, iso3, or country ID code
  • yesterday string? (default ()) - Enter true(1) to receive data reported a day ago. Default is false(0)
  • twoDaysAgo string? (default ()) - Enter true(1) to receive data reported two days ago. Default is false(0)
  • strict string (default "true") - Setting to false gives you the ability to fuzzy search countries (i.e. Oman vs. rOMANia)
  • allowNull string? (default ()) - By default, value is 0. Enter 1 to allow nulls to be returned
Return Type

getMultipleCountriesStatus

Isolated FunctionRemote Function
function getMultipleCountriesStatus(string countries, string? yesterday, string? twoDaysAgo, string? allowNull) returns CovidCountries|error

Get COVID-19 totals for a specific set of countries

Parameters
  • countries string - Multiple country names, iso2, iso3, or country IDs separated by commas
  • yesterday string? (default ()) - Enter true(1) to receive data reported a day ago. Default is false(0)
  • twoDaysAgo string? (default ()) - Enter true(1) to receive data reported two days ago. Default is false(0)
  • allowNull string? (default ()) - By default, value is 0. Enter 1 to allow nulls to be returned
Return Type
  • CovidCountries|error - Status OK

getAllCountriesAndProvincesStatus

Isolated FunctionRemote Function
function getAllCountriesAndProvincesStatus() returns CovidJHUCountries|error

Get COVID-19 totals for all countries and their provinces

Return Type
  • CovidJHUCountries|error - Status OK

getUSCountiesStatus

Isolated FunctionRemote Function
function getUSCountiesStatus() returns CovidJHUCounties|error

Get COVID-19 totals for all US counties

Return Type
  • CovidJHUCounties|error - Status OK

getUSAStatusByCounty

Isolated FunctionRemote Function
function getUSAStatusByCounty(string county) returns CovidJHUCounties|error

Get COVID-19 totals for a specific county

Parameters
  • county string - Name of any county in the USA. All counties are listed in the /v3/covid-19/jhucsse/counties/ endpoint
Return Type
  • CovidJHUCounties|error - Status OK

getTimeSeriesForAllCountriesAndProvinces

Isolated FunctionRemote Function
function getTimeSeriesForAllCountriesAndProvinces(string lastdays) returns CovidHistorical|error

Get COVID-19 time series data for all countries and their provinces

Parameters
  • lastdays string (default "30") - Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)
Return Type
  • CovidHistorical|error - Status OK

getGlobalStatusInTimeSeries

Isolated FunctionRemote Function
function getGlobalStatusInTimeSeries(string lastdays) returns CovidHistoricalAll|error

Get global accumulated COVID-19 time series data

Parameters
  • lastdays string (default "30") - Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)
Return Type

getTimeSeriesBycountry

Isolated FunctionRemote Function
function getTimeSeriesBycountry(string country, string lastdays) returns CovidHistoricalCountry|error

Get COVID-19 time series data for a specific country

Parameters
  • country string - A country name, iso2, iso3, or country ID code
  • lastdays string (default "30") - Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)
Return Type

getTimeSeriesOfMultipleCountries

Isolated FunctionRemote Function
function getTimeSeriesOfMultipleCountries(string countries, string lastdays) returns CovidHistoricalCountries|error

Get COVID-19 time series data for a specific set of countries

Parameters
  • countries string - Multiple country names, iso2, iso3, or country IDs separated by commas
  • lastdays string (default "30") - Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)
Return Type
  • CovidHistoricalCountries|error - Status Ok

getTimeSeriesByProvince

Isolated FunctionRemote Function
function getTimeSeriesByProvince(string country, string province, string lastdays) returns CovidHistoricalProvince|error

Get COVID-19 time series data for a specific province in a country

Parameters
  • country string - A country name, iso2, iso3, or country ID code
  • province string - Province name. All available names can be found in the /v3/covid-19/historical/{query} endpoint
  • lastdays string (default "30") - Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)
Return Type

getTimeSeriesDataForMultipleProvinces

Isolated FunctionRemote Function
function getTimeSeriesDataForMultipleProvinces(string country, string provinces, string lastdays) returns CovidHistoricalProvinces|error

Get COVID-19 time series data for a set of provinces in a country

Parameters
  • country string - A country name, iso2, iso3, or country ID code
  • provinces string - Provinces spelled correctly separated by ',' or '|' delimiters, never both in the same query
  • lastdays string (default "30") - Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)
Return Type
  • CovidHistoricalProvinces|error - Status Ok

getTimeSeriesForUSACounties

Isolated FunctionRemote Function
function getTimeSeriesForUSACounties() returns CovidHistoricalUSCounties|error

Get all possible US States to query the /historical/usacounties/{state} endpoint with

Return Type
  • CovidHistoricalUSCounties|error - Status OK

getUSACountiesDataByState

Isolated FunctionRemote Function
function getUSACountiesDataByState(string state, string lastdays) returns CovidHistoricalUSCounty|error

Get COVID-19 time series data for all counties in a specified US state

Parameters
  • state string - US state name, validated in the array returned from the /v3/covid-19/historical/usacounties endpoint
  • lastdays string (default "30") - Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)
Return Type
  • CovidHistoricalUSCounty|error - Status Ok

getTimeSeriesForAllUSAStatesNYT

Isolated FunctionRemote Function
function getTimeSeriesForAllUSAStatesNYT(string lastdays) returns CovidNYTState|error

Get COVID-19 time series data for all states, with an entry for each day since the pandemic began

Parameters
  • lastdays string (default "30") - Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)
Return Type
  • CovidNYTState|error - Status Ok

getTimeSeriesByUSAStateNYT

Isolated FunctionRemote Function
function getTimeSeriesByUSAStateNYT(string state, string lastdays) returns CovidNYTState|error

Get COVID-19 time series data for a state or set of states, with an entry for each day since the pandemic began

Parameters
  • state string - State name(s), separated by commas (e.g. 'Illinois, California')
  • lastdays string (default "30") - Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)
Return Type
  • CovidNYTState|error - Status Ok

getTimeSeriesByUSACountyNYT

Isolated FunctionRemote Function
function getTimeSeriesByUSACountyNYT(string county, string lastdays) returns CovidNYTCounty|error

Get COVID-19 time series data for a county or set of counties, with an entry for each day since the pandemic began

Parameters
  • county string - County name(s), separated by commas (e.g. 'Alameda, Humboldt')
  • lastdays string (default "30") - Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)
Return Type
  • CovidNYTCounty|error - Status Ok

getTimeSeriesForUSANYT

Isolated FunctionRemote Function
function getTimeSeriesForUSANYT() returns CovidNYTUSA|error

Get COVID-19 time series data for the entire USA, with an entry for each day since the pandemic began

Return Type
  • CovidNYTUSA|error - Status Ok

getAppleMobilityDataSupportedCountries

Isolated FunctionRemote Function
function getAppleMobilityDataSupportedCountries() returns CovidAppleCountries|error

Get a list of supported countries for Apple mobility data

Return Type
  • CovidAppleCountries|error - Status Ok

getAppleMobilityDataSupportedSubRegions

Isolated FunctionRemote Function
function getAppleMobilityDataSupportedSubRegions(string country) returns CovidAppleSubregions|error

Get a list of supported subregions for specific country in the Apple mobility data set

Parameters
  • country string - A valid country name from the /v3/covid-19/apple/countries endpoint
Return Type

getStatusBySubRegionUsingAppleMobilotyData

Isolated FunctionRemote Function
function getStatusBySubRegionUsingAppleMobilotyData(string country, string subregions) returns CovidAppleData|error

Get COVID-19 Apple mobility data for subregions of a country

Parameters
  • country string - A valid country name from the /v3/covid-19/apple/countries endpoint
  • subregions string - Valid subregion(s) from the /v3/covid-19/apple/countries/{country} endpoint, separated by with commas
Return Type

getGovenrmentDataSupportedCountries

Isolated FunctionRemote Function
function getGovenrmentDataSupportedCountries() returns CovidGov|error

Get a list of supported countries for government specific data

Return Type
  • CovidGov|error - Status Ok

getGovernmentReportedDataByCountry

Isolated FunctionRemote Function
function getGovernmentReportedDataByCountry(string country, string? allowNull) returns Response|error

Get COVID-19 government reported data for a specific country

Parameters
  • country string - A valid country name from the /v3/covid-19/gov endpoint
  • allowNull string? (default ()) - By default, value is 0. Enter 1 to allow nulls to be returned
Return Type

getVaccineTrialData

Isolated FunctionRemote Function
function getVaccineTrialData() returns Vaccines|error

Get vaccine trial data from RAPS (Regulatory Affairs Professional Society). Specifically published by Jeff Craven at https://www.raps.org/news-and-articles/news-articles/2020/3/covid-19-vaccine-tracker

Return Type

getTotalGlobalVaccineDosesAdministered

Isolated FunctionRemote Function
function getTotalGlobalVaccineDosesAdministered(string lastdays, string fullData) returns VaccineCoverage|error

Get total global COVID-19 vaccine doses administered. Sourced from https://covid.ourworldindata.org/

Parameters
  • lastdays string (default "30") - Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)
  • fullData string (default "false") - Flag indicating whether to return data type as SimpleVaccineTimeline (false) or FullVaccineTimeline (true).
Return Type

getVaccineCoverageOfAllCountries

Isolated FunctionRemote Function
function getVaccineCoverageOfAllCountries(string lastdays, string fullData) returns VaccineCountriesCoverage|error

Get COVID-19 vaccine doses administered for all countries that have reported rolling out vaccination. Sourced from https://covid.ourworldindata.org/

Parameters
  • lastdays string (default "30") - Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)
  • fullData string (default "false") - Flag indicating whether to return data type as SimpleVaccineTimeline (false) or FullVaccineTimeline (true).
Return Type
  • VaccineCountriesCoverage|error - Status Ok

getVaccineCoverageByCountry

Isolated FunctionRemote Function
function getVaccineCoverageByCountry(string country, string lastdays, string fullData) returns VaccineCountryCoverage|error

Get COVID-19 vaccine doses administered for a country that has reported vaccination rollout. Sourced from https://covid.ourworldindata.org/

Parameters
  • country string - A valid country name, iso2, iso3
  • lastdays string (default "30") - Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)
  • fullData string (default "false") - Flag indicating whether to return data type as SimpleVaccineTimeline (false) or FullVaccineTimeline (true).
Return Type

getVaccineCoverageOfAllUSAStates

Isolated FunctionRemote Function
function getVaccineCoverageOfAllUSAStates(string lastdays, string fullData) returns VaccineStatesCoverage|error

Get COVID-19 vaccine doses administered for all states that have reported rolling out vaccination. Sourced from https://covid.ourworldindata.org/

Parameters
  • lastdays string (default "30") - Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)
  • fullData string (default "false") - Flag indicating whether to return data type as SimpleVaccineTimeline (false) or FullVaccineTimeline (true).
Return Type
  • VaccineStatesCoverage|error - Status Ok

getVaccineCoverageByUSAState

Isolated FunctionRemote Function
function getVaccineCoverageByUSAState(string state, string lastdays, string fullData) returns VaccineStateCoverage|error

Get COVID-19 vaccine doses administered for a state that has reported vaccination rollout. Sourced from https://covid.ourworldindata.org/

Parameters
  • state string - A valid state name
  • lastdays string (default "30") - Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)
  • fullData string (default "false") - Flag indicating whether to return data type as SimpleVaccineTimeline (false) or FullVaccineTimeline (true).
Return Type

getTherapeuticsTrialData

Isolated FunctionRemote Function
function getTherapeuticsTrialData() returns Therapeutics|error

Get therapeutics trial data from RAPS (Regulatory Affairs Professional Society). Specifically published by Jeff Craven at https://www.raps.org/news-and-articles/news-articles/2020/3/covid-19-therapeutics-tracker

Return Type

getInfluenzaLikeIllnessData

Isolated FunctionRemote Function
function getInfluenzaLikeIllnessData() returns InfluenzaILINet|error

Get Influenza-like-illness data for the 2019 and 2020 outbreaks from the US Center for Disease Control

Return Type

getInfluenzaReportsByUCLA

Isolated FunctionRemote Function
function getInfluenzaReportsByUCLA() returns InfluenzaUSCL|error

Get Influenza report data for the 2019 and 2020 outbreaks from the US Center for Disease Control, reported by US clinical labs

Return Type

getInfluenzaReportsByUSPHL

Isolated FunctionRemote Function
function getInfluenzaReportsByUSPHL() returns InfluenzaUSPHL|error

Get Influenza report data for the 2019 and 2020 outbreaks from the US Center for Disease Control, reported by US public health labs

Return Type

Records

covid19: Cases

Fields

covid19: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields
  • keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
  • chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

covid19: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields
  • httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
  • timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
  • forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header
  • cache CacheConfig? - HTTP caching related configurations
  • compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header
  • circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
  • retryConfig RetryConfig? - Configurations associated with retrying
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

covid19: CovidAll

Fields

covid19: CovidAppleData

Fields

covid19: CovidappledataData

Fields

covid19: CovidAppleSubregions

Fields

covid19: CovidContinent

Fields

covid19: CovidcontinentContinentinfo

Fields

covid19: CovidCountry

Fields

covid19: CovidcountryCountryinfo

Fields

covid19: CovidHistoricalAll

Fields

covid19: CovidHistoricalCountry

Fields

covid19: CovidhistoricalInner

Fields

covid19: CovidHistoricalProvince

Fields

covid19: CovidhistoricaluscountyInner

Fields

covid19: CovidJHUCountry

Fields

covid19: CovidjhucountryCoordinates

Fields

covid19: CovidjhucountryStats

Fields

covid19: CovidJHUCounty

Fields

covid19: CovidnytcountyInner

Fields

covid19: CovidnytstateInner

Fields

covid19: CovidnytusaInner

Fields

covid19: CovidState

Fields

covid19: FullvaccinetimelineInner

Fields

covid19: ILINet

Fields

covid19: InfluenzaILINet

Fields

covid19: InfluenzaUSCL

Fields

covid19: InfluenzaUSPHL

Fields

covid19: Phases

Fields

covid19: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields
  • host string(default "") - Host name of the proxy server
  • port int(default 0) - Proxy server port
  • userName string(default "") - Proxy server username
  • password string(default "") - Proxy server password

covid19: SimpleVaccineTimeline

Fields

covid19: Therapeutic

Fields
  • developerResearcher string[]? -

covid19: Therapeutics

Fields

covid19: Timeline

Fields

covid19: TimelineDeaths

Fields

covid19: USCL

Fields

covid19: USPHL

Fields
  • 'A\(unable\ to\ sub\-type\)\+ decimal? -
  • 'A\(Subtyping\ not\ performed\) decimal? -

covid19: Vaccine

Fields

covid19: VaccineCountryCoverage

Fields

covid19: Vaccines

Fields

covid19: VaccineStateCoverage

Fields

Union types

covid19: VaccineCoverage

SimpleVaccineTimeline|FullVaccineTimeline

VaccineCoverage

Import

import ballerinax/covid19;Copy

Metadata

Released date: over 1 year ago

Version: 1.5.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 64039

Current verison: 24637

Weekly downloads

Source repository

Keywords

Lifestyle & Entertainment/News & Lifestyle

Cost/Free

Contributors

Other versions

1.5.1

1.5.01.4.01.2.01.1.0
See more...

Dependencies

ballerina/url/2.2.3ballerina/http/2.6.0

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2024 WSO2 LLC