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

# \SubscriberCredentialsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**delete_credentials**](SubscriberCredentialsApi.md#delete_credentials) | **DELETE** /v1/subscribers/{id}/credentials/{provider_id}/ | DELETE /v1/subscribers/:id/credentials/:provider_id — remove credentials for a provider
[**get_credential**](SubscriberCredentialsApi.md#get_credential) | **GET** /v1/subscribers/{id}/credentials/{provider_id}/ | GET /v1/subscribers/:id/credentials/:provider_id — get credentials for one provider
[**list_credentials**](SubscriberCredentialsApi.md#list_credentials) | **GET** /v1/subscribers/{id}/credentials/ | GET /v1/subscribers/:id/credentials — list all provider credentials
[**set_credentials**](SubscriberCredentialsApi.md#set_credentials) | **PUT** /v1/subscribers/{id}/credentials/{provider_id}/ | PUT /v1/subscribers/:id/credentials/:provider_id — create or replace credentials for a provider
[**upsert_credentials**](SubscriberCredentialsApi.md#upsert_credentials) | **PATCH** /v1/subscribers/{id}/credentials/{provider_id}/ | PATCH /v1/subscribers/:id/credentials/:provider_id — partially update credentials for a provider



## delete_credentials

> delete_credentials(id, provider_id)
DELETE /v1/subscribers/:id/credentials/:provider_id — remove credentials for a provider

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Subscriber ID | [required] |
**provider_id** | **String** | Provider 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_credential

> models::CredentialRecord get_credential(id, provider_id)
GET /v1/subscribers/:id/credentials/:provider_id — get credentials for one provider

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Subscriber ID | [required] |
**provider_id** | **String** | Provider ID (e.g. fcm, slack, telegram) | [required] |

### Return type

[**models::CredentialRecord**](CredentialRecord.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_credentials

> Vec<models::CredentialRecord> list_credentials(id)
GET /v1/subscribers/:id/credentials — list all provider credentials

### Parameters


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

### Return type

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


## set_credentials

> models::CredentialRecord set_credentials(id, provider_id, credential)
PUT /v1/subscribers/:id/credentials/:provider_id — create or replace credentials for a provider

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Subscriber ID | [required] |
**provider_id** | **String** | Provider ID (e.g. fcm, slack, telegram) | [required] |
**credential** | [**Credential**](Credential.md) |  | [required] |

### Return type

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


## upsert_credentials

> models::CredentialRecord upsert_credentials(id, provider_id, patch_credential)
PATCH /v1/subscribers/:id/credentials/:provider_id — partially update credentials for a provider

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Subscriber ID | [required] |
**provider_id** | **String** | Provider ID (e.g. fcm, slack, telegram) | [required] |
**patch_credential** | [**PatchCredential**](PatchCredential.md) |  | [required] |

### Return type

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