# mycoreapi.api.AlarmApi

## Load the API package
```dart
import 'package:mycoreapi/api.dart';
```

All URIs are relative to *https://localhost:5001*

Method | HTTP request | Description
------------- | ------------- | -------------
[**alarmActivate**](AlarmApi.md#alarmactivate) | **POST** /api/alarm/activate/{alarmModeId} | Activate specified alarm mode
[**alarmCreate**](AlarmApi.md#alarmcreate) | **POST** /api/alarm | Create an alarm mode
[**alarmCreateDefaultAlarms**](AlarmApi.md#alarmcreatedefaultalarms) | **POST** /api/alarm/defaults/{homeId} | Create default alarm modes
[**alarmDelete**](AlarmApi.md#alarmdelete) | **DELETE** /api/alarm/{alarmModeId} | Delete an alarm mode
[**alarmDeleteAllForHome**](AlarmApi.md#alarmdeleteallforhome) | **DELETE** /api/alarm/home/{homeId} | Delete all alarm mode for a specified home
[**alarmGetAll**](AlarmApi.md#alarmgetall) | **GET** /api/alarm/{homeId} | Get all alarm modes for the specified home
[**alarmGetDetail**](AlarmApi.md#alarmgetdetail) | **GET** /api/alarm/detail/{alarmModeId} | Get detail info of a specified alarm mode
[**alarmUpdate**](AlarmApi.md#alarmupdate) | **PUT** /api/alarm | Update an alarm mode


# **alarmActivate**
> String alarmActivate(alarmModeId)

Activate specified alarm mode

### Example 
```dart
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');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **alarmModeId** | **String**| Alarm mode to activate | 

### Return type

**String**

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **alarmCreate**
> AlarmModeDetailDTO alarmCreate(alarmModeCreateOrUpdateDetailDTO)

Create an alarm mode

### Example 
```dart
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 alarmModeCreateOrUpdateDetailDTO = AlarmModeCreateOrUpdateDetailDTO(); // AlarmModeCreateOrUpdateDetailDTO | Alarm mode to create

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **alarmModeCreateOrUpdateDetailDTO** | [**AlarmModeCreateOrUpdateDetailDTO**](AlarmModeCreateOrUpdateDetailDTO.md)| Alarm mode to create | 

### Return type

[**AlarmModeDetailDTO**](AlarmModeDetailDTO.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **alarmCreateDefaultAlarms**
> bool alarmCreateDefaultAlarms(homeId)

Create default alarm modes

### Example 
```dart
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 homeId = homeId_example; // String | Home Id

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **homeId** | **String**| Home Id | 

### Return type

**bool**

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **alarmDelete**
> String alarmDelete(alarmModeId)

Delete an alarm mode

### Example 
```dart
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 | Id of alarm mode to delete

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **alarmModeId** | **String**| Id of alarm mode to delete | 

### Return type

**String**

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **alarmDeleteAllForHome**
> String alarmDeleteAllForHome(homeId)

Delete all alarm mode for a specified home

### Example 
```dart
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 homeId = homeId_example; // String | Home Id

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **homeId** | **String**| Home Id | 

### Return type

**String**

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **alarmGetAll**
> List<AlarmModeDTO> alarmGetAll(homeId)

Get all alarm modes for the specified home

### Example 
```dart
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 homeId = homeId_example; // String | Home Id

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **homeId** | **String**| Home Id | 

### Return type

[**List<AlarmModeDTO>**](AlarmModeDTO.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **alarmGetDetail**
> AlarmModeDetailDTO alarmGetDetail(alarmModeId)

Get detail info of a specified alarm mode

### Example 
```dart
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 id

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **alarmModeId** | **String**| alarm id | 

### Return type

[**AlarmModeDetailDTO**](AlarmModeDetailDTO.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **alarmUpdate**
> AlarmModeDetailDTO alarmUpdate(alarmModeCreateOrUpdateDetailDTO)

Update an alarm mode

### Example 
```dart
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 alarmModeCreateOrUpdateDetailDTO = AlarmModeCreateOrUpdateDetailDTO(); // AlarmModeCreateOrUpdateDetailDTO | alarm mode to update

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **alarmModeCreateOrUpdateDetailDTO** | [**AlarmModeCreateOrUpdateDetailDTO**](AlarmModeCreateOrUpdateDetailDTO.md)| alarm mode to update | 

### Return type

[**AlarmModeDetailDTO**](AlarmModeDetailDTO.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)