enbbox 1.0.1

Notification infrastructure API — open-source alternative to Novu/Courier
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

# \NotificationGroupsApi

All URIs are relative to *https://api.enbbox.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_notification_group**](NotificationGroupsApi.md#create_notification_group) | **POST** /v1/notification-groups/ | POST /v1/notification-groups
[**delete_notification_group**](NotificationGroupsApi.md#delete_notification_group) | **DELETE** /v1/notification-groups/{id}/ | DELETE /v1/notification-groups/:id
[**list_notification_groups**](NotificationGroupsApi.md#list_notification_groups) | **GET** /v1/notification-groups/ | GET /v1/notification-groups
[**update_notification_group**](NotificationGroupsApi.md#update_notification_group) | **PATCH** /v1/notification-groups/{id}/ | PATCH /v1/notification-groups/:id



## create_notification_group

> models::NotificationGroupRecord create_notification_group(create_notification_group)
POST /v1/notification-groups

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_notification_group** | [**CreateNotificationGroup**](CreateNotificationGroup.md) |  | [required] |

### Return type

[**models::NotificationGroupRecord**](NotificationGroupRecord.md)

### Authorization

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

### 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)


## delete_notification_group

> delete_notification_group(id)
DELETE /v1/notification-groups/:id

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Group ID | [required] |

### Return type

 (empty response body)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[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)


## list_notification_groups

> Vec<models::NotificationGroupRecord> list_notification_groups()
GET /v1/notification-groups

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::NotificationGroupRecord>**](NotificationGroupRecord.md)

### Authorization

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

### 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)


## update_notification_group

> models::NotificationGroupRecord update_notification_group(id, update_notification_group)
PATCH /v1/notification-groups/:id

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Group ID | [required] |
**update_notification_group** | [**UpdateNotificationGroup**](UpdateNotificationGroup.md) |  | [required] |

### Return type

[**models::NotificationGroupRecord**](NotificationGroupRecord.md)

### Authorization

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

### 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)