myhomie_app/mycore_api/README.md

# mycore_api
API description

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

- API version: Version Pre-Alpha
- Build package: org.openapitools.codegen.languages.DartClientCodegen

## Requirements

Dart 2.12 or later

## Installation & Usage

### Github
If this Dart package is published to Github, add the following dependency to your pubspec.yaml
```
dependencies:
  mycore_api:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```

### Local
To use the package in your local drive, add the following dependency to your pubspec.yaml
```
dependencies:
  mycore_api:
    path: /path/to/mycore_api
```

## Tests

TODO

## Getting Started

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

```dart
import 'package:mycore_api/api.dart';

// TODO Configure OAuth2 access token for authorization: bearer
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = AlarmApi();
final alarmModeId = alarmModeId_example; // String | Alarm mode to activate

try {
    final result = api_instance.alarmActivate(alarmModeId);
    print(result);
} catch (e) {
    print('Exception when calling AlarmApi->alarmActivate: $e\n');
}

```

## Documentation for API Endpoints

All URIs are relative to *http://192.168.31.140*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AlarmApi* | [**alarmActivate**](doc\/AlarmApi.md#alarmactivate) | **POST** /api/alarm/activate/{alarmModeId} | Activate specified alarm mode
*AlarmApi* | [**alarmCreate**](doc\/AlarmApi.md#alarmcreate) | **POST** /api/alarm | Create an alarm mode
*AlarmApi* | [**alarmCreateDefaultAlarms**](doc\/AlarmApi.md#alarmcreatedefaultalarms) | **POST** /api/alarm/defaults/{homeId} | Create default alarm modes
*AlarmApi* | [**alarmDelete**](doc\/AlarmApi.md#alarmdelete) | **DELETE** /api/alarm/{alarmModeId} | Delete an alarm mode
*AlarmApi* | [**alarmDeleteAllForHome**](doc\/AlarmApi.md#alarmdeleteallforhome) | **DELETE** /api/alarm/home/{homeId} | Delete all alarm mode for a specified home
*AlarmApi* | [**alarmGetAll**](doc\/AlarmApi.md#alarmgetall) | **GET** /api/alarm/{homeId} | Get all alarm modes for the specified home
*AlarmApi* | [**alarmGetDetail**](doc\/AlarmApi.md#alarmgetdetail) | **GET** /api/alarm/detail/{alarmModeId} | Get detail info of a specified alarm mode
*AlarmApi* | [**alarmUpdate**](doc\/AlarmApi.md#alarmupdate) | **PUT** /api/alarm | Update an alarm mode
*AuthenticationApi* | [**authenticationAuthenticateWithForm**](doc\/AuthenticationApi.md#authenticationauthenticatewithform) | **POST** /api/Authentication/Token | Authenticate with form parameters (used by Swagger test client)
*AuthenticationApi* | [**authenticationAuthenticateWithJson**](doc\/AuthenticationApi.md#authenticationauthenticatewithjson) | **POST** /api/Authentication/Authenticate | Authenticate with Json parameters (used by most clients)
*AutomationApi* | [**automationCreate**](doc\/AutomationApi.md#automationcreate) | **POST** /api/automation | Create an automation
*AutomationApi* | [**automationDelete**](doc\/AutomationApi.md#automationdelete) | **DELETE** /api/automation/{automationId} | Delete an automation
*AutomationApi* | [**automationDeleteAllForHome**](doc\/AutomationApi.md#automationdeleteallforhome) | **DELETE** /api/automation/home/{homeId} | Delete all automation for a specified home
*AutomationApi* | [**automationGetAll**](doc\/AutomationApi.md#automationgetall) | **GET** /api/automation/{homeId} | Get all automations for the specified home
*AutomationApi* | [**automationGetDetail**](doc\/AutomationApi.md#automationgetdetail) | **GET** /api/automation/detail/{automationId} | Get detail info of a specified automation
*AutomationApi* | [**automationUpdate**](doc\/AutomationApi.md#automationupdate) | **PUT** /api/automation | Update an automation
*AzureApi* | [**azureCreate**](doc\/AzureApi.md#azurecreate) | **POST** /azure | 
*BooksApi* | [**booksCreate**](doc\/BooksApi.md#bookscreate) | **POST** /api/books | 
*BooksApi* | [**booksDelete**](doc\/BooksApi.md#booksdelete) | **DELETE** /api/books/{id} | 
*BooksApi* | [**booksGet**](doc\/BooksApi.md#booksget) | **GET** /api/books/{id} | 
*BooksApi* | [**booksGetAll**](doc\/BooksApi.md#booksgetall) | **GET** /api/books | 
*BooksApi* | [**booksUpdate**](doc\/BooksApi.md#booksupdate) | **PUT** /api/books/{id} | 
*DeviceApi* | [**deviceCreate**](doc\/DeviceApi.md#devicecreate) | **POST** /api/device | Create a device
*DeviceApi* | [**deviceCreateDevicesFromProvider**](doc\/DeviceApi.md#devicecreatedevicesfromprovider) | **POST** /api/device/{homeId}/fromProvider/{providerId} | Create devices from provider
*DeviceApi* | [**deviceDelete**](doc\/DeviceApi.md#devicedelete) | **DELETE** /api/device/{deviceId} | Delete a device
*DeviceApi* | [**deviceDeleteAllForHome**](doc\/DeviceApi.md#devicedeleteallforhome) | **DELETE** /api/device/home/{homeId} | Delete all device for a specified home
*DeviceApi* | [**deviceDeleteDevicesFromProvider**](doc\/DeviceApi.md#devicedeletedevicesfromprovider) | **DELETE** /api/device/{homeId}/fromProvider/{providerId} | Delete devices from provider
*DeviceApi* | [**deviceGetAll**](doc\/DeviceApi.md#devicegetall) | **GET** /api/device/{homeId} | Get all devices summary
*DeviceApi* | [**deviceGetDetail**](doc\/DeviceApi.md#devicegetdetail) | **GET** /api/device/detail/{deviceId} | Get a specific device info
*DeviceApi* | [**deviceGetDevicesByType**](doc\/DeviceApi.md#devicegetdevicesbytype) | **GET** /api/device/{homeId}/type/{type} | Get list of devices from a type
*DeviceApi* | [**deviceGetDevicesFromProvider**](doc\/DeviceApi.md#devicegetdevicesfromprovider) | **GET** /api/device/{homeId}/fromProvider/{providerId} | Get devices from provider
*DeviceApi* | [**deviceGetDevicesFromZigbee2Mqtt**](doc\/DeviceApi.md#devicegetdevicesfromzigbee2mqtt) | **GET** /api/device/zigbee2Mqtt/{homeId} | Get all zigbee2Mqtt devices
*DeviceApi* | [**deviceSendAction**](doc\/DeviceApi.md#devicesendaction) | **POST** /api/device/action | Send action to device
*DeviceApi* | [**deviceUpdate**](doc\/DeviceApi.md#deviceupdate) | **PUT** /api/device/{deviceId} | Update a device
*EnergyApi* | [**energyGetElectricityProduction**](doc\/EnergyApi.md#energygetelectricityproduction) | **GET** /api/energy/electricity | Get summary production of Kwh/Year
*EventApi* | [**eventDelete**](doc\/EventApi.md#eventdelete) | **DELETE** /api/event/{eventId} | Delete an event
*EventApi* | [**eventDeleteAllForHome**](doc\/EventApi.md#eventdeleteallforhome) | **DELETE** /api/event/home/{homeId} | Delete all events for a specified home
*EventApi* | [**eventGet**](doc\/EventApi.md#eventget) | **GET** /api/event/{homeId} | Get events for the specified home 
*EventApi* | [**eventGetDetail**](doc\/EventApi.md#eventgetdetail) | **GET** /api/event/detail/{eventId} | Get detail info of a specified event
*FacebookApi* | [**facebookCreate**](doc\/FacebookApi.md#facebookcreate) | **POST** /facebook | 
*GoogleApi* | [**googleCreate**](doc\/GoogleApi.md#googlecreate) | **POST** /google | 
*GroupApi* | [**groupCreate**](doc\/GroupApi.md#groupcreate) | **POST** /api/group | Create a group
*GroupApi* | [**groupCreateDevicesFromZigbee2Mqtt**](doc\/GroupApi.md#groupcreatedevicesfromzigbee2mqtt) | **POST** /api/group/{homeId}/fromZigbee | Create groups from provider
*GroupApi* | [**groupDelete**](doc\/GroupApi.md#groupdelete) | **DELETE** /api/group/{groupId}/device/{deviceId} | Delete device from a group
*GroupApi* | [**groupDelete2**](doc\/GroupApi.md#groupdelete2) | **DELETE** /api/group/{groupId} | Delete a group
*GroupApi* | [**groupDeleteAllForHome**](doc\/GroupApi.md#groupdeleteallforhome) | **DELETE** /api/group/home/{homeId} | Delete all group for a specified home
*GroupApi* | [**groupGetAll**](doc\/GroupApi.md#groupgetall) | **GET** /api/group/{homeId} | Get all groups for the specified home
*GroupApi* | [**groupGetDetail**](doc\/GroupApi.md#groupgetdetail) | **GET** /api/group/detail/{groupId} | Get detail info of a specified group
*GroupApi* | [**groupGetGroupsByType**](doc\/GroupApi.md#groupgetgroupsbytype) | **GET** /api/group/{homeId}/type/{type} | Get list of group from a type
*GroupApi* | [**groupGetGroupsFromZigbee2Mqtt**](doc\/GroupApi.md#groupgetgroupsfromzigbee2mqtt) | **GET** /api/group/zigbee2Mqtt/{homeId} | Get all zigbee2Mqtt groups
*GroupApi* | [**groupUpdate**](doc\/GroupApi.md#groupupdate) | **PUT** /api/group | Update a group
*HomeApi* | [**homeCreate**](doc\/HomeApi.md#homecreate) | **POST** /api/home | Create a home
*HomeApi* | [**homeDelete**](doc\/HomeApi.md#homedelete) | **DELETE** /api/home/{homeId} | Delete a home
*HomeApi* | [**homeGetAll**](doc\/HomeApi.md#homegetall) | **GET** /api/home/{userId} | Get all home for specified user
*HomeApi* | [**homeGetDetail**](doc\/HomeApi.md#homegetdetail) | **GET** /api/home/detail/{homeId} | Get detail info of a specified home
*HomeApi* | [**homeUpdate**](doc\/HomeApi.md#homeupdate) | **PUT** /api/home | Update a home
*IOTApi* | [**iOTGetSmartPrinterMessages**](doc\/IOTApi.md#iotgetsmartprintermessages) | **GET** /api/iot/smartprinter/{idDevice} | Retrieve all SmartPrinterMessage
*IOTApi* | [**iOTPostToDBPrinter**](doc\/IOTApi.md#iotposttodbprinter) | **POST** /api/iot/smartprinter/{idDevice} | It's the method to post data from mqtt broker to Database (Thanks Rpi!)
*IOTApi* | [**iOTPostToDBSmartGarden**](doc\/IOTApi.md#iotposttodbsmartgarden) | **POST** /api/iot/smartgarden/{idDevice} | It's the method to post data from mqtt broker to Database (Thanks Rpi!)
*LayoutApi* | [**layoutGet**](doc\/LayoutApi.md#layoutget) | **GET** /api/layout/panelSection | It's a test ! :) 
*MQTTApi* | [**mQTTPublishMessage**](doc\/MQTTApi.md#mqttpublishmessage) | **POST** /api/mqtt | Publish mqtt test
*OddApi* | [**oddGetAll**](doc\/OddApi.md#oddgetall) | **GET** /api/odd/{oddRequest} | Get odds for one country and one odd value maximum
*OddApi* | [**oddGetForCountry**](doc\/OddApi.md#oddgetforcountry) | **GET** /api/odd/country/{id}/{oddRequest} | Get odds for one country and one odd value maximum
*ProviderApi* | [**providerCreate**](doc\/ProviderApi.md#providercreate) | **POST** /api/provider | Create a provider
*ProviderApi* | [**providerDelete**](doc\/ProviderApi.md#providerdelete) | **DELETE** /api/provider/{providerId} | Delete a provider
*ProviderApi* | [**providerGetAll**](doc\/ProviderApi.md#providergetall) | **GET** /api/provider/{homeId} | Get all home providers 
*ProviderApi* | [**providerUpdate**](doc\/ProviderApi.md#providerupdate) | **PUT** /api/provider | Update a provider
*RoomApi* | [**roomAddDeviceToRoom**](doc\/RoomApi.md#roomadddevicetoroom) | **PUT** /api/room/{roomId} | Add devices in the specified room
*RoomApi* | [**roomCreate**](doc\/RoomApi.md#roomcreate) | **POST** /api/room | Create a room
*RoomApi* | [**roomDelete**](doc\/RoomApi.md#roomdelete) | **DELETE** /api/room/{roomId} | Delete a room
*RoomApi* | [**roomDelete2**](doc\/RoomApi.md#roomdelete2) | **DELETE** /api/room/{roomId}/device/{deviceId} | Delete device from a room
*RoomApi* | [**roomDeleteAllForHome**](doc\/RoomApi.md#roomdeleteallforhome) | **DELETE** /api/room/home/{homeId} | Delete all rooms for a specified home
*RoomApi* | [**roomGetAll**](doc\/RoomApi.md#roomgetall) | **GET** /api/room/{homeId} | Get all rooms for the specified home
*RoomApi* | [**roomGetAllWithMainDetails**](doc\/RoomApi.md#roomgetallwithmaindetails) | **GET** /api/room/{homeId}/details | Get all rooms main details for the specified home
*RoomApi* | [**roomGetDetail**](doc\/RoomApi.md#roomgetdetail) | **GET** /api/room/detail/{roomId} | Get detail info of a specified room
*RoomApi* | [**roomUpdate**](doc\/RoomApi.md#roomupdate) | **PUT** /api/room | Update a room
*ScreenDeviceApi* | [**screenDeviceCreateDevice**](doc\/ScreenDeviceApi.md#screendevicecreatedevice) | **POST** /api/device/screen | Create screen device
*ScreenDeviceApi* | [**screenDeviceDeleteDevice**](doc\/ScreenDeviceApi.md#screendevicedeletedevice) | **DELETE** /api/device/screen/{deviceId} | Delete device
*ScreenDeviceApi* | [**screenDeviceGetAllScreenDevices**](doc\/ScreenDeviceApi.md#screendevicegetallscreendevices) | **GET** /api/device/screen | Get all screen devices
*ScreenDeviceApi* | [**screenDeviceGetDeviceInfo**](doc\/ScreenDeviceApi.md#screendevicegetdeviceinfo) | **GET** /api/device/screen/{screenDeviceId} | Get screen device info
*ScreenDeviceApi* | [**screenDeviceUpdateDevice**](doc\/ScreenDeviceApi.md#screendeviceupdatedevice) | **PUT** /api/device/screen | Update screen device
*TokenApi* | [**tokenConnectUser**](doc\/TokenApi.md#tokenconnectuser) | **POST** /api/token | Connect user
*TokenApi* | [**tokenCreate**](doc\/TokenApi.md#tokencreate) | **POST** /token | 
*TwitterApi* | [**twitterCreate**](doc\/TwitterApi.md#twittercreate) | **POST** /twitter | 
*UserApi* | [**userCreateUser**](doc\/UserApi.md#usercreateuser) | **POST** /api/user | Create an user
*UserApi* | [**userDeleteUser**](doc\/UserApi.md#userdeleteuser) | **DELETE** /api/user/{id} | Delete an user
*UserApi* | [**userGet**](doc\/UserApi.md#userget) | **GET** /api/user/{id} | Get a specific user 
*UserApi* | [**userGetAll**](doc\/UserApi.md#usergetall) | **GET** /api/user | Get a list of user 
*UserApi* | [**userGetByEmail**](doc\/UserApi.md#usergetbyemail) | **GET** /api/user/email/{email} | Get a specific user by email
*UserApi* | [**userUpdateUser**](doc\/UserApi.md#userupdateuser) | **PUT** /api/user | Update an user
*ValuesApi* | [**valuesDelete**](doc\/ValuesApi.md#valuesdelete) | **DELETE** /api/test/{id} | 
*ValuesApi* | [**valuesGet**](doc\/ValuesApi.md#valuesget) | **GET** /api/test/{id} | 
*ValuesApi* | [**valuesGetAll**](doc\/ValuesApi.md#valuesgetall) | **GET** /api/test | It's a test ! :) 
*ValuesApi* | [**valuesPost**](doc\/ValuesApi.md#valuespost) | **POST** /api/test | 
*ValuesApi* | [**valuesPut**](doc\/ValuesApi.md#valuesput) | **PUT** /api/test/{id} | 


## Documentation For Models

 - [Action](doc\/Action.md)
 - [ActionType](doc\/ActionType.md)
 - [AlarmMode](doc\/AlarmMode.md)
 - [AlarmModeCreateOrUpdateDetailDTO](doc\/AlarmModeCreateOrUpdateDetailDTO.md)
 - [AlarmModeCreateOrUpdateDetailDTOAllOf](doc\/AlarmModeCreateOrUpdateDetailDTOAllOf.md)
 - [AlarmModeDTO](doc\/AlarmModeDTO.md)
 - [AlarmModeDetailDTO](doc\/AlarmModeDetailDTO.md)
 - [AlarmModeDetailDTOAllOf](doc\/AlarmModeDetailDTOAllOf.md)
 - [AlarmModeGeolocalizedMode](doc\/AlarmModeGeolocalizedMode.md)
 - [AlarmModeProgrammedMode](doc\/AlarmModeProgrammedMode.md)
 - [AlarmTriggered](doc\/AlarmTriggered.md)
 - [AlarmType](doc\/AlarmType.md)
 - [AutomationDTO](doc\/AutomationDTO.md)
 - [AutomationDetailDTO](doc\/AutomationDetailDTO.md)
 - [AutomationDetailDTOAllOf](doc\/AutomationDetailDTOAllOf.md)
 - [AutomationState](doc\/AutomationState.md)
 - [AutomationTriggered](doc\/AutomationTriggered.md)
 - [AzureADAuthModel](doc\/AzureADAuthModel.md)
 - [Book](doc\/Book.md)
 - [Condition](doc\/Condition.md)
 - [ConditionState](doc\/ConditionState.md)
 - [ConditionType](doc\/ConditionType.md)
 - [ConditionValue](doc\/ConditionValue.md)
 - [ConnectionStatus](doc\/ConnectionStatus.md)
 - [CreateOrUpdateHomeDTO](doc\/CreateOrUpdateHomeDTO.md)
 - [CreateOrUpdateHomeDTOAllOf](doc\/CreateOrUpdateHomeDTOAllOf.md)
 - [DeviceDetailDTO](doc\/DeviceDetailDTO.md)
 - [DeviceDetailDTOAllOf](doc\/DeviceDetailDTOAllOf.md)
 - [DeviceState](doc\/DeviceState.md)
 - [DeviceSummaryDTO](doc\/DeviceSummaryDTO.md)
 - [DeviceType](doc\/DeviceType.md)
 - [ElectricityProduction](doc\/ElectricityProduction.md)
 - [EventDTO](doc\/EventDTO.md)
 - [EventDetailDTO](doc\/EventDetailDTO.md)
 - [EventDetailDTOAllOf](doc\/EventDetailDTOAllOf.md)
 - [EventFilter](doc\/EventFilter.md)
 - [EventGetDeviceTypeParameter](doc\/EventGetDeviceTypeParameter.md)
 - [EventGetEventTypeParameter](doc\/EventGetEventTypeParameter.md)
 - [EventHomeFilter](doc\/EventHomeFilter.md)
 - [EventHomeFilterAllOf](doc\/EventHomeFilterAllOf.md)
 - [EventType](doc\/EventType.md)
 - [FacebookAuthModel](doc\/FacebookAuthModel.md)
 - [GeolocalizedMode](doc\/GeolocalizedMode.md)
 - [GoogleAuthModel](doc\/GoogleAuthModel.md)
 - [GroupCreateOrUpdateDetailDTO](doc\/GroupCreateOrUpdateDetailDTO.md)
 - [GroupCreateOrUpdateDetailDTOAllOf](doc\/GroupCreateOrUpdateDetailDTOAllOf.md)
 - [GroupDetailDTO](doc\/GroupDetailDTO.md)
 - [GroupDetailDTOAllOf](doc\/GroupDetailDTOAllOf.md)
 - [GroupSummaryDTO](doc\/GroupSummaryDTO.md)
 - [HomeDTO](doc\/HomeDTO.md)
 - [HomeDTOCurrentAlarmMode](doc\/HomeDTOCurrentAlarmMode.md)
 - [HomeDetailDTO](doc\/HomeDetailDTO.md)
 - [HomeDetailDTOAllOf](doc\/HomeDetailDTOAllOf.md)
 - [ListResponseOfEventDetailDTOAndEventHomeFilter](doc\/ListResponseOfEventDetailDTOAndEventHomeFilter.md)
 - [ListResponseOfEventDetailDTOAndEventHomeFilterRequestParameters](doc\/ListResponseOfEventDetailDTOAndEventHomeFilterRequestParameters.md)
 - [LoginDTO](doc\/LoginDTO.md)
 - [MeansOfCommunication](doc\/MeansOfCommunication.md)
 - [MqttMessageDTO](doc\/MqttMessageDTO.md)
 - [OddNice](doc\/OddNice.md)
 - [OddNiceOdds](doc\/OddNiceOdds.md)
 - [OddObject](doc\/OddObject.md)
 - [PanelMenuItem](doc\/PanelMenuItem.md)
 - [PanelSection](doc\/PanelSection.md)
 - [ProgrammedMode](doc\/ProgrammedMode.md)
 - [ProviderDTO](doc\/ProviderDTO.md)
 - [ProviderType](doc\/ProviderType.md)
 - [RoomCreateOrUpdateDetailDTO](doc\/RoomCreateOrUpdateDetailDTO.md)
 - [RoomDetailDTO](doc\/RoomDetailDTO.md)
 - [RoomMainDetailDTO](doc\/RoomMainDetailDTO.md)
 - [RoomMainDetailDTOAllOf](doc\/RoomMainDetailDTOAllOf.md)
 - [RoomSummaryDTO](doc\/RoomSummaryDTO.md)
 - [ScreenDevice](doc\/ScreenDevice.md)
 - [SmartGardenMessage](doc\/SmartGardenMessage.md)
 - [SmartPrinterMessage](doc\/SmartPrinterMessage.md)
 - [TimePeriodAlarm](doc\/TimePeriodAlarm.md)
 - [TimePeriodAlarmAlarmMode](doc\/TimePeriodAlarmAlarmMode.md)
 - [TokenDTO](doc\/TokenDTO.md)
 - [Trigger](doc\/Trigger.md)
 - [TriggerType](doc\/TriggerType.md)
 - [TwitterAuthModel](doc\/TwitterAuthModel.md)
 - [User](doc\/User.md)
 - [UserInfo](doc\/UserInfo.md)
 - [UserInfoDetailDTO](doc\/UserInfoDetailDTO.md)
 - [ViewBy](doc\/ViewBy.md)


## Documentation For Authorization


## bearer

- **Type**: OAuth
- **Flow**: password
- **Authorization URL**: /authentication/Token
- **Scopes**: 
 - **MyCore-api**: MyCore WebAPI


## Author