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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401

# \SubscribersApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**bulk_create**](SubscribersApi.md#bulk_create) | **POST** /v1/subscribers/bulk/ | POST /v1/subscribers/bulk — create multiple subscribers at once
[**bulk_update_preferences**](SubscribersApi.md#bulk_update_preferences) | **PATCH** /v1/subscribers/{id}/preferences/bulk/ | PATCH /v1/subscribers/:id/preferences/bulk — update multiple workflow preferences at once
[**create_subscriber**](SubscribersApi.md#create_subscriber) | **POST** /v1/subscribers/ | POST /v1/subscribers
[**delete_subscriber**](SubscribersApi.md#delete_subscriber) | **DELETE** /v1/subscribers/{id}/ | DELETE /v1/subscribers/:subscriber_id
[**get_subscriber**](SubscribersApi.md#get_subscriber) | **GET** /v1/subscribers/{id}/ | GET /v1/subscribers/:subscriber_id
[**list_subscriber_subscriptions**](SubscribersApi.md#list_subscriber_subscriptions) | **GET** /v1/subscribers/{id}/subscriptions/ | GET /v1/subscribers/:id/subscriptions — list topic subscriptions for a subscriber
[**list_subscribers**](SubscribersApi.md#list_subscribers) | **GET** /v1/subscribers/ | GET /v1/subscribers
[**mark_all_messages**](SubscribersApi.md#mark_all_messages) | **POST** /v1/subscribers/{id}/messages/mark-all/ | POST /v1/subscribers/:id/messages/mark-all — mark all messages
[**mark_messages**](SubscribersApi.md#mark_messages) | **POST** /v1/subscribers/{id}/messages/mark-as/ | POST /v1/subscribers/:id/messages/mark-as — mark messages as read/seen/unseen
[**subscriber_feed**](SubscribersApi.md#subscriber_feed) | **GET** /v1/subscribers/{id}/notifications/feed/ | GET /v1/subscribers/:id/notifications/feed — cursor-paginated message list
[**unseen_count**](SubscribersApi.md#unseen_count) | **GET** /v1/subscribers/{id}/notifications/unseen/ | GET /v1/subscribers/:id/notifications/unseen — unseen count
[**update_online_status**](SubscribersApi.md#update_online_status) | **PATCH** /v1/subscribers/{id}/online-status/ | PATCH /v1/subscribers/:id/online-status — set online/offline
[**update_subscriber**](SubscribersApi.md#update_subscriber) | **PATCH** /v1/subscribers/{id}/ | PATCH /v1/subscribers/:subscriber_id



## bulk_create

> models::BulkResult bulk_create(bulk_create_subscribers)
POST /v1/subscribers/bulk — create multiple subscribers at once

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_create_subscribers** | [**BulkCreateSubscribers**](BulkCreateSubscribers.md) |  | [required] |

### Return type

[**models::BulkResult**](BulkResult.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)


## bulk_update_preferences

> bulk_update_preferences(id, bulk_preferences)
PATCH /v1/subscribers/:id/preferences/bulk — update multiple workflow preferences at once

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Subscriber ID | [required] |
**bulk_preferences** | [**BulkPreferences**](BulkPreferences.md) |  | [required] |

### Return type

 (empty response body)

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **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)


## create_subscriber

> models::SubscriberRecord create_subscriber(create_subscriber)
POST /v1/subscribers

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_subscriber** | [**CreateSubscriber**](CreateSubscriber.md) |  | [required] |

### Return type

[**models::SubscriberRecord**](SubscriberRecord.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_subscriber

> delete_subscriber(id)
DELETE /v1/subscribers/:subscriber_id

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Subscriber 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)


## get_subscriber

> models::SubscriberRecord get_subscriber(id)
GET /v1/subscribers/:subscriber_id

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Subscriber ID | [required] |

### Return type

[**models::SubscriberRecord**](SubscriberRecord.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)


## list_subscriber_subscriptions

> Vec<models::TopicSubscription> list_subscriber_subscriptions(id)
GET /v1/subscribers/:id/subscriptions — list topic subscriptions for a subscriber

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Subscriber ID | [required] |

### Return type

[**Vec<models::TopicSubscription>**](TopicSubscription.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)


## list_subscribers

> models::PaginatedSubscriberRecord list_subscribers(limit, offset, q, filter_by)
GET /v1/subscribers

Lists subscribers for the current project. When the optional `q` query parameter is provided, the list is powered by Typesense full-text search (searching across email, name, phone, subscriber_id). Without `q`, a standard paginated listing from the primary store is returned.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**limit** | Option<**i32**> | Maximum number of items to return (1–100, default 10). |  |
**offset** | Option<**i32**> | Number of items to skip (default 0). |  |
**q** | Option<**String**> | Optional full-text search query (e.g., an email, name, or phone number). When present, search is powered by Typesense. |  |
**filter_by** | Option<**String**> | Optional filter expression for narrowing results. Example: `is_online:=true` or `locale:=en-US`. |  |

### Return type

[**models::PaginatedSubscriberRecord**](Paginated_SubscriberRecord.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)


## mark_all_messages

> models::MarkResult mark_all_messages(id, mark_all)
POST /v1/subscribers/:id/messages/mark-all — mark all messages

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Subscriber ID | [required] |
**mark_all** | [**MarkAll**](MarkAll.md) |  | [required] |

### Return type

[**models::MarkResult**](MarkResult.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)


## mark_messages

> models::MarkResult mark_messages(id, mark_messages)
POST /v1/subscribers/:id/messages/mark-as — mark messages as read/seen/unseen

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Subscriber ID | [required] |
**mark_messages** | [**MarkMessages**](MarkMessages.md) |  | [required] |

### Return type

[**models::MarkResult**](MarkResult.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)


## subscriber_feed

> models::CursorPaginatedFeedItem subscriber_feed(id, limit, after, before, channel, read, seen)
GET /v1/subscribers/:id/notifications/feed — cursor-paginated message list

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Subscriber ID | [required] |
**limit** | Option<**i32**> |  |  |
**after** | Option<**String**> |  |  |
**before** | Option<**String**> |  |  |
**channel** | Option<**String**> |  |  |
**read** | Option<**bool**> |  |  |
**seen** | Option<**bool**> |  |  |

### Return type

[**models::CursorPaginatedFeedItem**](CursorPaginated_FeedItem.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)


## unseen_count

> models::UnseenCount unseen_count(id)
GET /v1/subscribers/:id/notifications/unseen — unseen count

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Subscriber ID | [required] |

### Return type

[**models::UnseenCount**](UnseenCount.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_online_status

> models::SubscriberRecord update_online_status(id, online_status)
PATCH /v1/subscribers/:id/online-status — set online/offline

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Subscriber ID | [required] |
**online_status** | [**OnlineStatus**](OnlineStatus.md) |  | [required] |

### Return type

[**models::SubscriberRecord**](SubscriberRecord.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)


## update_subscriber

> models::SubscriberRecord update_subscriber(id, update_subscriber)
PATCH /v1/subscribers/:subscriber_id

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Subscriber ID | [required] |
**update_subscriber** | [**UpdateSubscriber**](UpdateSubscriber.md) |  | [required] |

### Return type

[**models::SubscriberRecord**](SubscriberRecord.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)