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

# \ChannelEndpointsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_endpoint**](ChannelEndpointsApi.md#create_endpoint) | **POST** /v1/channel-endpoints/ | POST /v1/channel-endpoints
[**delete_endpoint**](ChannelEndpointsApi.md#delete_endpoint) | **DELETE** /v1/channel-endpoints/{id}/ | DELETE /v1/channel-endpoints/:identifier
[**get_endpoint**](ChannelEndpointsApi.md#get_endpoint) | **GET** /v1/channel-endpoints/{id}/ | GET /v1/channel-endpoints/:identifier
[**list_endpoints**](ChannelEndpointsApi.md#list_endpoints) | **GET** /v1/channel-endpoints/ | GET /v1/channel-endpoints
[**update_endpoint**](ChannelEndpointsApi.md#update_endpoint) | **PATCH** /v1/channel-endpoints/{id}/ | PATCH /v1/channel-endpoints/:identifier



## create_endpoint

> models::ChannelEndpointRecord create_endpoint(create_channel_endpoint)
POST /v1/channel-endpoints

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_channel_endpoint** | [**CreateChannelEndpoint**](CreateChannelEndpoint.md) |  | [required] |

### Return type

[**models::ChannelEndpointRecord**](ChannelEndpointRecord.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_endpoint

> delete_endpoint(id)
DELETE /v1/channel-endpoints/:identifier

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Channel endpoint 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_endpoint

> models::ChannelEndpointRecord get_endpoint(id)
GET /v1/channel-endpoints/:identifier

### Parameters


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

### Return type

[**models::ChannelEndpointRecord**](ChannelEndpointRecord.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_endpoints

> models::PaginatedChannelEndpointRecord list_endpoints(limit, offset, q, filter_by)
GET /v1/channel-endpoints

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**limit** | Option<**u32**> | Maximum number of items to return (1–100, default: 10). |  |
**offset** | Option<**u32**> | Number of items to skip before returning results (default: 0). |  |
**q** | Option<**String**> | Optional full-text search query. When present, listing is powered by Typesense full-text search. |  |
**filter_by** | Option<**String**> | Optional Typesense filter expression for narrowing results. Example: `identifier:=acme-corp` or `name:=General`. |  |

### Return type

[**models::PaginatedChannelEndpointRecord**](Paginated_ChannelEndpointRecord.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_endpoint

> models::ChannelEndpointRecord update_endpoint(id, update_channel_endpoint)
PATCH /v1/channel-endpoints/:identifier

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Channel endpoint ID | [required] |
**update_channel_endpoint** | [**UpdateChannelEndpoint**](UpdateChannelEndpoint.md) |  | [required] |

### Return type

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