Metadata-Version: 2.4
Name: wst_api_client
Version: 0.0.1
Summary: wst-api
Home-page: 
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <team@openapitools.org>
License: Proprietary. All rights reserved. See LICENSE file.
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Keywords: OpenAPI,OpenAPI-Generator,wst-api
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# wst_api_client
Api which exposes data about the current status of the Westerschelde tunnel

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.0.1
- Package version: 0.0.1
- Generator version: 7.14.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import wst_api_client
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import wst_api_client
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import wst_api_client
from wst_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wststatusboard.nl
# See configuration.py for a list of all supported configuration parameters.
configuration = wst_api_client.Configuration(
    host = "https://api.wststatusboard.nl"
)



# Enter a context with an instance of the API client
with wst_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wst_api_client.AssetsApi(api_client)
    translation = 'translation_example' # str | the i18n code for the translation

    try:
        # Your GET endpoint
        api_response = api_instance.get_assets_i18n_translation_json(translation)
        print("The response of AssetsApi->get_assets_i18n_translation_json:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AssetsApi->get_assets_i18n_translation_json: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.wststatusboard.nl*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AssetsApi* | [**get_assets_i18n_translation_json**](docs/AssetsApi.md#get_assets_i18n_translation_json) | **GET** /assets/i18n/{translation}.json | Your GET endpoint
*IncidentApi* | [**get_incident_active**](docs/IncidentApi.md#get_incident_active) | **GET** /incident/active | Your GET endpoint
*IncidentApi* | [**get_incident_scheduled**](docs/IncidentApi.md#get_incident_scheduled) | **GET** /incident/scheduled | Your GET endpoint
*MapApi* | [**get_map**](docs/MapApi.md#get_map) | **GET** /map | Your GET endpoint
*MetadataApi* | [**get_translations**](docs/MetadataApi.md#get_translations) | **GET** /metadata/translations | Your GET endpoint
*SituationApi* | [**get_situation**](docs/SituationApi.md#get_situation) | **GET** /situation | Your GET endpoint


## Documentation For Models

 - [AdditionalInformation](docs/AdditionalInformation.md)
 - [Detour](docs/Detour.md)
 - [Incident](docs/Incident.md)
 - [IncidentState](docs/IncidentState.md)
 - [InlineObject](docs/InlineObject.md)
 - [InlineObject1](docs/InlineObject1.md)
 - [InlineObject1Nl](docs/InlineObject1Nl.md)
 - [InlineObject1NlAlternative](docs/InlineObject1NlAlternative.md)
 - [InlineObject1NlAlternativeFrom](docs/InlineObject1NlAlternativeFrom.md)
 - [InlineObject1NlChannel](docs/InlineObject1NlChannel.md)
 - [InlineObject1NlDirection](docs/InlineObject1NlDirection.md)
 - [InlineObject1NlExtraTravelTime](docs/InlineObject1NlExtraTravelTime.md)
 - [InlineObject1NlIncidents](docs/InlineObject1NlIncidents.md)
 - [InlineObject1NlIncidentsExtraTravelTime](docs/InlineObject1NlIncidentsExtraTravelTime.md)
 - [InlineObject1NlIncidentsNoIncidents](docs/InlineObject1NlIncidentsNoIncidents.md)
 - [InlineObject1NlRoad](docs/InlineObject1NlRoad.md)
 - [InlineObject1NlStatus](docs/InlineObject1NlStatus.md)
 - [InlineObject1NlStatusState](docs/InlineObject1NlStatusState.md)
 - [InlineObject1NlSubscriptionGroup](docs/InlineObject1NlSubscriptionGroup.md)
 - [InlineObject1NlWidget](docs/InlineObject1NlWidget.md)
 - [InlineObjectDate](docs/InlineObjectDate.md)
 - [InlineObjectDetour](docs/InlineObjectDetour.md)
 - [InlineObjectIncidentPopup](docs/InlineObjectIncidentPopup.md)
 - [InlineObjectIncidentPopupError](docs/InlineObjectIncidentPopupError.md)
 - [InlineObjectIncidentPopupTitle](docs/InlineObjectIncidentPopupTitle.md)
 - [InlineObjectIncidentPopupTitleError](docs/InlineObjectIncidentPopupTitleError.md)
 - [InlineObjectIncidentStatusTimeline](docs/InlineObjectIncidentStatusTimeline.md)
 - [InlineObjectNavigation](docs/InlineObjectNavigation.md)
 - [InlineObjectScheduledIncidents](docs/InlineObjectScheduledIncidents.md)
 - [InlineObjectSituationMap](docs/InlineObjectSituationMap.md)
 - [InlineObjectSituationMapActiveIncidents](docs/InlineObjectSituationMapActiveIncidents.md)
 - [InlineObjectSituationMapMessage](docs/InlineObjectSituationMapMessage.md)
 - [Road](docs/Road.md)
 - [RoadSituation](docs/RoadSituation.md)
 - [RoadState](docs/RoadState.md)
 - [Situation](docs/Situation.md)
 - [SituationStatus](docs/SituationStatus.md)
 - [State](docs/State.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization

Endpoints do not require authorization.


## Author




