# mycoreapi 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.0 or later ## Installation & Usage ### Github If this Dart package is published to Github, add the following dependency to your pubspec.yaml ``` dependencies: mycoreapi: 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: mycoreapi: path: /path/to/mycoreapi ``` ## Tests TODO ## Getting Started Please follow the [installation procedure](#installation--usage) and then run the following: ```dart import 'package:mycoreapi/api.dart'; // TODO Configure OAuth2 access token for authorization: bearer //defaultApiClient.getAuthentication('bearer').accessToken = 'YOUR_ACCESS_TOKEN'; final api_instance = AuthenticationApi(); final grantType = grantType_example; // String | final username = username_example; // String | final password = password_example; // String | final clientId = clientId_example; // String | final clientSecret = clientSecret_example; // String | try { final result = api_instance.authenticationAuthenticateWithForm(grantType, username, password, clientId, clientSecret); print(result); } catch (e) { print('Exception when calling AuthenticationApi->authenticationAuthenticateWithForm: $e\n'); } ``` ## Documentation for API Endpoints All URIs are relative to *http://localhost:25049* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *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* | [**automationDeleteAllForUser**](doc\/AutomationApi.md#automationdeleteallforuser) | **DELETE** /api/automation/user/{userId} | Delete all automation for a specified *AutomationApi* | [**automationGetAll**](doc\/AutomationApi.md#automationgetall) | **GET** /api/automation/{userId} | Get all automations for the specified user *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/{userId}/fromProvider/{providerId} | Create devices from provider *DeviceApi* | [**deviceDelete**](doc\/DeviceApi.md#devicedelete) | **DELETE** /api/device/{deviceId} | Delete a device *DeviceApi* | [**deviceDeleteAllForUser**](doc\/DeviceApi.md#devicedeleteallforuser) | **DELETE** /api/device/user/{userId} | Delete all device for a specified user *DeviceApi* | [**deviceDeleteDevicesFromProvider**](doc\/DeviceApi.md#devicedeletedevicesfromprovider) | **DELETE** /api/device/{userId}/fromProvider/{providerId} | Delete devices from provider *DeviceApi* | [**deviceGetAll**](doc\/DeviceApi.md#devicegetall) | **GET** /api/device/{userId} | 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/{userId}/type/{type} | Get list of devices from a type *DeviceApi* | [**deviceGetDevicesFromProvider**](doc\/DeviceApi.md#devicegetdevicesfromprovider) | **GET** /api/device/{userId}/fromProvider/{providerId} | Get devices from provider *DeviceApi* | [**deviceGetDevicesFromZigbee2Mqtt**](doc\/DeviceApi.md#devicegetdevicesfromzigbee2mqtt) | **GET** /api/device/zigbee2Mqtt/{userId} | Get all zigbee2Mqtt devices *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 *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/{userId}/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* | [**groupDeleteAllForUser**](doc\/GroupApi.md#groupdeleteallforuser) | **DELETE** /api/group/user/{userId} | Delete all group for a specified *GroupApi* | [**groupGetAll**](doc\/GroupApi.md#groupgetall) | **GET** /api/group/{userId} | Get all groups for the specified user *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/{userId}/type/{type} | Get list of group from a type *GroupApi* | [**groupGetGroupsFromZigbee2Mqtt**](doc\/GroupApi.md#groupgetgroupsfromzigbee2mqtt) | **GET** /api/group/zigbee2Mqtt/{userId} | Get all zigbee2Mqtt groups *GroupApi* | [**groupUpdate**](doc\/GroupApi.md#groupupdate) | **PUT** /api/group | Update a group *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/{userId} | Get all user providers *ProviderApi* | [**providerUpdate**](doc\/ProviderApi.md#providerupdate) | **PUT** /api/provider | Update a provider *RoomApi* | [**roomCreate**](doc\/RoomApi.md#roomcreate) | **POST** /api/room | Create a room *RoomApi* | [**roomDelete**](doc\/RoomApi.md#roomdelete) | **DELETE** /api/room/{roomId}/device/{deviceId} | Delete device from a room *RoomApi* | [**roomDelete2**](doc\/RoomApi.md#roomdelete2) | **DELETE** /api/room/{roomId} | Delete a room *RoomApi* | [**roomDeleteAllForUser**](doc\/RoomApi.md#roomdeleteallforuser) | **DELETE** /api/room/user/{userId} | Delete all room for a specified user *RoomApi* | [**roomGetAll**](doc\/RoomApi.md#roomgetall) | **GET** /api/room/{userId} | Get all rooms for the specified user *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* | [**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) - [Automation](doc\/Automation.md) - [AutomationCreateOrUpdateDetailDTO](doc\/AutomationCreateOrUpdateDetailDTO.md) - [AutomationCreateOrUpdateDetailDTOAllOf](doc\/AutomationCreateOrUpdateDetailDTOAllOf.md) - [AutomationDTO](doc\/AutomationDTO.md) - [AutomationDetailDTO](doc\/AutomationDetailDTO.md) - [AutomationDetailDTOAllOf](doc\/AutomationDetailDTOAllOf.md) - [AutomationState](doc\/AutomationState.md) - [AzureADAuthModel](doc\/AzureADAuthModel.md) - [Book](doc\/Book.md) - [Condition](doc\/Condition.md) - [ConditionType](doc\/ConditionType.md) - [ConditionValue](doc\/ConditionValue.md) - [ConnectionStatus](doc\/ConnectionStatus.md) - [Device](doc\/Device.md) - [DeviceDetailDTO](doc\/DeviceDetailDTO.md) - [DeviceDetailDTOAllOf](doc\/DeviceDetailDTOAllOf.md) - [DeviceSummaryDTO](doc\/DeviceSummaryDTO.md) - [DeviceType](doc\/DeviceType.md) - [ElectricityProduction](doc\/ElectricityProduction.md) - [FacebookAuthModel](doc\/FacebookAuthModel.md) - [GoogleAuthModel](doc\/GoogleAuthModel.md) - [Group](doc\/Group.md) - [GroupCreateOrUpdateDetailDTO](doc\/GroupCreateOrUpdateDetailDTO.md) - [GroupCreateOrUpdateDetailDTOAllOf](doc\/GroupCreateOrUpdateDetailDTOAllOf.md) - [GroupDetailDTO](doc\/GroupDetailDTO.md) - [GroupDetailDTOAllOf](doc\/GroupDetailDTOAllOf.md) - [GroupSummaryDTO](doc\/GroupSummaryDTO.md) - [LocationDTO](doc\/LocationDTO.md) - [LoginDTO](doc\/LoginDTO.md) - [MeansOfCommunication](doc\/MeansOfCommunication.md) - [MqttMessageDTO](doc\/MqttMessageDTO.md) - [OddNice](doc\/OddNice.md) - [OddObject](doc\/OddObject.md) - [PanelMenuItem](doc\/PanelMenuItem.md) - [PanelSection](doc\/PanelSection.md) - [Provider](doc\/Provider.md) - [ProviderDTO](doc\/ProviderDTO.md) - [RoomCreateOrUpdateDetailDTO](doc\/RoomCreateOrUpdateDetailDTO.md) - [RoomDetailDTO](doc\/RoomDetailDTO.md) - [RoomSummaryDTO](doc\/RoomSummaryDTO.md) - [ScreenConfiguration](doc\/ScreenConfiguration.md) - [ScreenDevice](doc\/ScreenDevice.md) - [ScreenWidget](doc\/ScreenWidget.md) - [SmartGardenMessage](doc\/SmartGardenMessage.md) - [SmartPrinterMessage](doc\/SmartPrinterMessage.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