# Rust API client for p7m-alarm

## API for generating and tracking alarms

This is the API of what P7M mainly uses within the Telfas service.


## Overview

This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.

- API version: 0.2.1
- Package version: 0.2.1
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`

## Installation

Put the package under your project folder in a directory named `p7m-alarm` and add the following to `Cargo.toml` under `[dependencies]`:

```
p7m-alarm = { path = "./p7m-alarm" }
```

## Documentation for API Endpoints

All URIs are relative to *https://alarm.api.p7m.de/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AlarmApi* | [**delete_alarms_id**](docs/AlarmApi.md#delete_alarms_id) | **DELETE** /alarms/{id} | Delete an alarm by its ID
*AlarmApi* | [**get_alarms**](docs/AlarmApi.md#get_alarms) | **GET** /alarms | Get a list of all alarms
*AlarmApi* | [**get_alarms_id**](docs/AlarmApi.md#get_alarms_id) | **GET** /alarms/{id} | Get a single alarm by its ID
*AlarmApi* | [**post_alarm**](docs/AlarmApi.md#post_alarm) | **POST** /alarms | Create a new alarm and by that trigger signalling
*AlarmApi* | [**put_alarms_id**](docs/AlarmApi.md#put_alarms_id) | **PUT** /alarms/{id} | Update an existing alarm
*AlarmRecipientApi* | [**delete_alarms_recipients_id**](docs/AlarmRecipientApi.md#delete_alarms_recipients_id) | **DELETE** /alarms/{aid}/recipients/{id} | Delete a single alarm recipient by its ID
*AlarmRecipientApi* | [**get_alarms_recipients**](docs/AlarmRecipientApi.md#get_alarms_recipients) | **GET** /alarms/{aid}/recipients | Get the list of receipients of an alarm
*AlarmRecipientApi* | [**get_alarms_recipients_id**](docs/AlarmRecipientApi.md#get_alarms_recipients_id) | **GET** /alarms/{aid}/recipients/{id} | Get a single recipient of an alarm by its ID
*AlarmRecipientApi* | [**post_alarm_recipients**](docs/AlarmRecipientApi.md#post_alarm_recipients) | **POST** /alarms/{aid}/recipients | Add a new recipient to an existing alarm
*AlarmRecipientApi* | [**put_alarms_recipients_id**](docs/AlarmRecipientApi.md#put_alarms_recipients_id) | **PUT** /alarms/{aid}/recipients/{id} | Update an existing recipient of an alarm
*AlarmTypeApi* | [**delete_alarm_types**](docs/AlarmTypeApi.md#delete_alarm_types) | **DELETE** /alarmtypes/{id} | Delete a single alarm type by its ID
*AlarmTypeApi* | [**get_alarm_types**](docs/AlarmTypeApi.md#get_alarm_types) | **GET** /alarmtypes | Get list of all alarm types
*AlarmTypeApi* | [**get_alarm_types_id**](docs/AlarmTypeApi.md#get_alarm_types_id) | **GET** /alarmtypes/{id} | Get a single alarm type by its ID
*AlarmTypeApi* | [**post_alarm_types**](docs/AlarmTypeApi.md#post_alarm_types) | **POST** /alarmtypes | Create a new alarm type
*AlarmTypeApi* | [**put_alarm_types**](docs/AlarmTypeApi.md#put_alarm_types) | **PUT** /alarmtypes/{id} | Update an existing alarm type


## Documentation For Models

 - [Alarm](docs/Alarm.md)
 - [AlarmConfirmation](docs/AlarmConfirmation.md)
 - [AlarmData](docs/AlarmData.md)
 - [AlarmGuidance](docs/AlarmGuidance.md)
 - [AlarmMedium](docs/AlarmMedium.md)
 - [AlarmRecipient](docs/AlarmRecipient.md)
 - [AlarmRecipientData](docs/AlarmRecipientData.md)
 - [AlarmType](docs/AlarmType.md)
 - [AlarmTypeData](docs/AlarmTypeData.md)
 - [NewAlarm](docs/NewAlarm.md)
 - [NewAlarmRecipient](docs/NewAlarmRecipient.md)
 - [NewAlarmType](docs/NewAlarmType.md)


To get access to the crate's generated documentation, use:

```
cargo doc --open
```

## Author

tech@p7m.de