myhomie_app/mycore_api/README.md

mycoreapi

API description

This Dart package is automatically generated by the OpenAPI Generator 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 and then run the following:

import 'package:mycoreapi/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	POST /api/alarm/activate/{alarmModeId}	Activate current alarm mode
AlarmApi	alarmCreate	POST /api/alarm	Create an alarm mode
AlarmApi	alarmCreateDefaultAlarms	POST /api/alarm/defaults/{homeId}	Create default alarm modes
AlarmApi	alarmDelete	DELETE /api/alarm/{alarmModeId}	Delete an alarm mode
AlarmApi	alarmDeleteAllForHome	DELETE /api/alarm/home/{homeId}	Delete all alarm mode for a specified home
AlarmApi	alarmGetAll	GET /api/alarm/{homeId}	Get all alarm modes for the specified home
AlarmApi	alarmGetDetail	GET /api/alarm/detail/{alarmId}	Get detail info of a specified alarm mode
AlarmApi	alarmUpdate	PUT /api/alarm	Update an alarm mode
AuthenticationApi	authenticationAuthenticateWithForm	POST /api/Authentication/Token	Authenticate with form parameters (used by Swagger test client)
AuthenticationApi	authenticationAuthenticateWithJson	POST /api/Authentication/Authenticate	Authenticate with Json parameters (used by most clients)
AutomationApi	automationCreate	POST /api/automation	Create an automation
AutomationApi	automationDelete	DELETE /api/automation/{automationId}	Delete an automation
AutomationApi	automationDeleteAllForHome	DELETE /api/automation/home/{homeId}	Delete all automation for a specified home
AutomationApi	automationGetAll	GET /api/automation/{homeId}	Get all automations for the specified home
AutomationApi	automationGetDetail	GET /api/automation/detail/{automationId}	Get detail info of a specified automation
AutomationApi	automationUpdate	PUT /api/automation	Update an automation
AzureApi	azureCreate	POST /azure
BooksApi	booksCreate	POST /api/books
BooksApi	booksDelete	DELETE /api/books/{id}
BooksApi	booksGet	GET /api/books/{id}
BooksApi	booksGetAll	GET /api/books
BooksApi	booksUpdate	PUT /api/books/{id}
DeviceApi	deviceCreate	POST /api/device	Create a device
DeviceApi	deviceCreateDevicesFromProvider	POST /api/device/{homeId}/fromProvider/{providerId}	Create devices from provider
DeviceApi	deviceDelete	DELETE /api/device/{deviceId}	Delete a device
DeviceApi	deviceDeleteAllForHome	DELETE /api/device/home/{homeId}	Delete all device for a specified home
DeviceApi	deviceDeleteDevicesFromProvider	DELETE /api/device/{homeId}/fromProvider/{providerId}	Delete devices from provider
DeviceApi	deviceGetAll	GET /api/device/{homeId}	Get all devices summary
DeviceApi	deviceGetDetail	GET /api/device/detail/{deviceId}	Get a specific device info
DeviceApi	deviceGetDevicesByType	GET /api/device/{homeId}/type/{type}	Get list of devices from a type
DeviceApi	deviceGetDevicesFromProvider	GET /api/device/{homeId}/fromProvider/{providerId}	Get devices from provider
DeviceApi	deviceGetDevicesFromZigbee2Mqtt	GET /api/device/zigbee2Mqtt/{homeId}	Get all zigbee2Mqtt devices
DeviceApi	deviceUpdate	PUT /api/device/{deviceId}	Update a device
EnergyApi	energyGetElectricityProduction	GET /api/energy/electricity	Get summary production of Kwh/Year
EventApi	eventDelete	DELETE /api/event/{eventId}	Delete an event
EventApi	eventDeleteAllForHome	DELETE /api/event/home/{homeId}	Delete all events for a specified home
EventApi	eventGet	GET /api/event/{homeId}	Get events for the specified home
EventApi	eventGetDetail	GET /api/event/detail/{eventId}	Get detail info of a specified event
FacebookApi	facebookCreate	POST /facebook
GoogleApi	googleCreate	POST /google
GroupApi	groupCreate	POST /api/group	Create a group
GroupApi	groupCreateDevicesFromZigbee2Mqtt	POST /api/group/{homeId}/fromZigbee	Create groups from provider
GroupApi	groupDelete	DELETE /api/group/{groupId}/device/{deviceId}	Delete device from a group
GroupApi	groupDelete2	DELETE /api/group/{groupId}	Delete a group
GroupApi	groupDeleteAllForHome	DELETE /api/group/home/{homeId}	Delete all group for a specified home
GroupApi	groupGetAll	GET /api/group/{homeId}	Get all groups for the specified home
GroupApi	groupGetDetail	GET /api/group/detail/{groupId}	Get detail info of a specified group
GroupApi	groupGetGroupsByType	GET /api/group/{homeId}/type/{type}	Get list of group from a type
GroupApi	groupGetGroupsFromZigbee2Mqtt	GET /api/group/zigbee2Mqtt/{homeId}	Get all zigbee2Mqtt groups
GroupApi	groupUpdate	PUT /api/group	Update a group
HomeApi	homeCreate	POST /api/home	Create a home
HomeApi	homeDelete	DELETE /api/home/{homeId}	Delete a home
HomeApi	homeGetAll	GET /api/home/{userId}	Get all home for specified user
HomeApi	homeGetDetail	GET /api/home/detail/{homeId}	Get detail info of a specified home
HomeApi	homeUpdate	PUT /api/home	Update a home
IOTApi	iOTGetSmartPrinterMessages	GET /api/iot/smartprinter/{idDevice}	Retrieve all SmartPrinterMessage
IOTApi	iOTPostToDBPrinter	POST /api/iot/smartprinter/{idDevice}	It's the method to post data from mqtt broker to Database (Thanks Rpi!)
IOTApi	iOTPostToDBSmartGarden	POST /api/iot/smartgarden/{idDevice}	It's the method to post data from mqtt broker to Database (Thanks Rpi!)
LayoutApi	layoutGet	GET /api/layout/panelSection	It's a test ! :)
MQTTApi	mQTTPublishMessage	POST /api/mqtt	Publish mqtt test
OddApi	oddGetAll	GET /api/odd/{oddRequest}	Get odds for one country and one odd value maximum
OddApi	oddGetForCountry	GET /api/odd/country/{id}/{oddRequest}	Get odds for one country and one odd value maximum
ProviderApi	providerCreate	POST /api/provider	Create a provider
ProviderApi	providerDelete	DELETE /api/provider/{providerId}	Delete a provider
ProviderApi	providerGetAll	GET /api/provider/{homeId}	Get all home providers
ProviderApi	providerUpdate	PUT /api/provider	Update a provider
RoomApi	roomCreate	POST /api/room	Create a room
RoomApi	roomDelete	DELETE /api/room/{roomId}/device/{deviceId}	Delete device from a room
RoomApi	roomDelete2	DELETE /api/room/{roomId}	Delete a room
RoomApi	roomDeleteAllForHome	DELETE /api/room/home/{homeId}	Delete all rooms for a specified home
RoomApi	roomGetAll	GET /api/room/{homeId}	Get all rooms for the specified home
RoomApi	roomGetDetail	GET /api/room/detail/{roomId}	Get detail info of a specified room
RoomApi	roomUpdate	PUT /api/room	Update a room
ScreenDeviceApi	screenDeviceCreateDevice	POST /api/device/screen	Create screen device
ScreenDeviceApi	screenDeviceDeleteDevice	DELETE /api/device/screen/{deviceId}	Delete device
ScreenDeviceApi	screenDeviceGetAllScreenDevices	GET /api/device/screen	Get all screen devices
ScreenDeviceApi	screenDeviceGetDeviceInfo	GET /api/device/screen/{screenDeviceId}	Get screen device info
ScreenDeviceApi	screenDeviceUpdateDevice	PUT /api/device/screen	Update screen device
TokenApi	tokenConnectUser	POST /api/token	Connect user
TokenApi	tokenCreate	POST /token
TwitterApi	twitterCreate	POST /twitter
UserApi	userCreateUser	POST /api/user	Create an user
UserApi	userDeleteUser	DELETE /api/user/{id}	Delete an user
UserApi	userGet	GET /api/user/{id}	Get a specific user
UserApi	userGetAll	GET /api/user	Get a list of user
UserApi	userUpdateUser	PUT /api/user	Update an user
ValuesApi	valuesDelete	DELETE /api/test/{id}
ValuesApi	valuesGet	GET /api/test/{id}
ValuesApi	valuesGetAll	GET /api/test	It's a test ! :)
ValuesApi	valuesPost	POST /api/test
ValuesApi	valuesPut	PUT /api/test/{id}

Documentation For Models

• Action
• ActionType
• AlarmMode
• AlarmModeCreateOrUpdateDetailDTO
• AlarmModeCreateOrUpdateDetailDTOAllOf
• AlarmModeDTO
• AlarmModeDetailDTO
• AlarmModeDetailDTOAllOf
• AlarmTriggered
• AlarmType
• AutomationDTO
• AutomationDetailDTO
• AutomationDetailDTOAllOf
• AutomationState
• AutomationTriggered
• AzureADAuthModel
• Book
• Condition
• ConditionType
• ConditionValue
• ConnectionStatus
• CreateOrUpdateHomeDTO
• CreateOrUpdateHomeDTOAllOf
• DeviceDetailDTO
• DeviceDetailDTOAllOf
• DeviceState
• DeviceSummaryDTO
• DeviceType
• ElectricityProduction
• EventDTO
• EventDetailDTO
• EventDetailDTOAllOf
• EventType
• FacebookAuthModel
• GeolocalizedMode
• GoogleAuthModel
• GroupCreateOrUpdateDetailDTO
• GroupCreateOrUpdateDetailDTOAllOf
• GroupDetailDTO
• GroupDetailDTOAllOf
• GroupSummaryDTO
• HomeDTO
• HomeDetailDTO
• HomeDetailDTOAllOf
• LoginDTO
• MeansOfCommunication
• MqttMessageDTO
• OddNice
• OddObject
• PanelMenuItem
• PanelSection
• ProgrammedMode
• ProviderDTO
• ProviderType
• RoomCreateOrUpdateDetailDTO
• RoomDetailDTO
• RoomSummaryDTO
• ScreenDevice
• SmartGardenMessage
• SmartPrinterMessage
• TimePeriodAlarm
• TokenDTO
• Trigger
• TriggerType
• TwitterAuthModel
• User
• UserInfo
• UserInfoDetailDTO
• ViewBy

Documentation For Authorization

bearer

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

Author