![\"npm](\"https://badge.fury.io/js/awv-api.svg\"){kind=icon}
\n ![\"MIT\"](\"https://img.shields.io/github/license/NilsBaumgartner1994/awv-api\")
\n ![\"last](\"https://img.shields.io/github/last-commit/NilsBaumgartner1994/awv-api?logo=git\")
\n ![\"downloads](\"https://img.shields.io/npm/dm/awv-api.svg\")
\n ![\"downloads](\"https://img.shields.io/npm/dt/awv-api.svg\")
\n ![\"dependencies\"](\"https://david-dm.org/NilsBaumgartner1994/awv-api/status.svg\")
\n ![](\"https://app.fossa.com/api/projects/git%2Bgithub.com%2FNilsBaumgartner1994%2Fawv-api.svg?type=shield\"/)
\n ![](\"https://img.shields.io/badge/code%20style-google-blueviolet.svg\"/){kind=icon}
\n ![](\"https://img.shields.io/badge/uses-TypeScript-blue.svg\"/){kind=icon}
\n ![](\"https://img.shields.io/badge/uses-Lint%20Action-blue.svg\"/){kind=icon}
\n\n \n \n \n \n
\n \n \n \n \n
\n ![\"Npm](\"https://github.com/NilsBaumgartner1994/awv-api/actions/workflows/npmPublish.yml/badge.svg\"){kind=icon}
\n ![\"Build](\"https://github.com/NilsBaumgartner1994/awv-api/actions/workflows/linter.yml/badge.svg\"){kind=icon}
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n Abfallwirtschaft Vechta - API\n
\n\n## Disclaimer\n\nThis is not an official package from the \"Abfallwirtschaft Vechta\". It is only an API by parsing the informations from the website.\n\n## About\n\nSince https://www.abfallwirtschaft-vechta.de/ is not offering an open and simple api for their calendar of trash-pickup dates was this package created. It offers a possibility to download all trash-pickup events for a specific year, downloading all cities and streets and puts them in a nice object.\n\n## Installation\n\n```\nnpm install awv-api\n```\n\n## Usage\n\n```\nimport {AwvAPI} from \"awv-api\";\n\nconst allCities = await AwvAPI.downloadAllCities(year);\n//or any other Function\n```\n\n## Models\n\n### City\n\n```\ncity.id : number // the id of the city\ncity.label : string // the display name of the city\ncity.value : string // the name of the city\ncity.getStreets() : Street[] // returns all associated streets\n```\n\n### Street\n\n```\nstreet.id : number // the id of the street\nstreet.label : string // the display name of the city\nstreet.value : string // the name of the city\nstreet.pamo: string // the district for pamo, 0 if not available\nstreet.siemer: string // the district for siemer, 0 if not available\nstreet.abfuhrbezirk: string // the district for the normal\nstreet.getEvents() : Event[] // returns all associated events\n```\n\n### Event\n\n```\nevent.date: string // the date as String DD.MM.YYYY when the event happens\nevent.label: string // the trash which gets picked up\nevent.provider: string // the name of the provider\n```\n\n### Provider\n\nAn enum:\n\n```\nVECHTA = 'AVZ Vechta'\nSIEMER = 'Siemer'\nPAMO = 'Pamo'\n```\n\n## Documentation\n\n### params:\n\n- year: number (for example: 2021)\n- city: City (see /models/City.ts)\n- street: Street (see /models/Street.ts)\n- event: Event (see /models/Event.ts)\n\n### functions\n\n- AwvAPI.downloadAllCitiesAndStreetsAndEvents(year)\n\n - Downloads all cities and streets and events as a list of cities\n\n- AwvAPI.downloadAllCitiesAndStreets(year)\n - Downloads all cities and streets\n- AwvAPI.downloadAllCities(year)\n - Downloads all cities\n- AwvAPI.downloadAllStreetsForCity(year, city)\n - Downloads all streets for a city\n- AwvAPI.downloadEventsForStreet(year, city, street)\n - Downloads all events for a specific street in a city\n\n## Contributors\n\n