ElasticEmail 4.2.0

Official Rust SDK for the Elastic Email REST API v4
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

# \EventsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**events_by_transactionid_get**](EventsApi.md#events_by_transactionid_get) | **GET** /events/{transactionid} | Load Email Events
[**events_channels_by_name_export_post**](EventsApi.md#events_channels_by_name_export_post) | **POST** /events/channels/{name}/export | Export Channel Events
[**events_channels_by_name_get**](EventsApi.md#events_channels_by_name_get) | **GET** /events/channels/{name} | Load Channel Events
[**events_channels_export_by_id_status_get**](EventsApi.md#events_channels_export_by_id_status_get) | **GET** /events/channels/export/{id}/status | Check Channel Export Status
[**events_export_by_id_status_get**](EventsApi.md#events_export_by_id_status_get) | **GET** /events/export/{id}/status | Check Export Status
[**events_export_post**](EventsApi.md#events_export_post) | **POST** /events/export | Export Events
[**events_get**](EventsApi.md#events_get) | **GET** /events | Load Events



## events_by_transactionid_get

> Vec<models::RecipientEvent> events_by_transactionid_get(transactionid, from, to, order_by, limit, offset)
Load Email Events

Returns a log of delivery events for the specific transaction ID. Required Access Level: ViewReports

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**transactionid** | **String** | ID number of transaction | [required] |
**from** | Option<**String**> | Starting date for search in YYYY-MM-DDThh:mm:ss format. |  |
**to** | Option<**String**> | Ending date for search in YYYY-MM-DDThh:mm:ss format. |  |
**order_by** | Option<[**EventsOrderBy**](.md)> |  |  |
**limit** | Option<**i32**> | Maximum number of returned items. |  |
**offset** | Option<**i32**> | How many items should be returned ahead. |  |

### Return type

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

### Authorization

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

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


## events_channels_by_name_export_post

> models::ExportLink events_channels_by_name_export_post(name, event_types, from, to, file_format, compression_format, file_name)
Export Channel Events

Export delivery events log information to the specified file format. Required Access Level: Export

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name** | **String** | Name of selected channel. | [required] |
**event_types** | Option<[**Vec<models::EventType>**](models::EventType.md)> | Types of Events to return |  |
**from** | Option<**String**> | Starting date for search in YYYY-MM-DDThh:mm:ss format. |  |
**to** | Option<**String**> | Ending date for search in YYYY-MM-DDThh:mm:ss format. |  |
**file_format** | Option<[**ExportFileFormats**](.md)> | Format of the exported file |  |
**compression_format** | Option<[**CompressionFormat**](.md)> | FileResponse compression format. None or Zip. |  |
**file_name** | Option<**String**> | Name of your file including extension. |  |

### Return type

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

### Authorization

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

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


## events_channels_by_name_get

> Vec<models::RecipientEvent> events_channels_by_name_get(name, event_types, from, to, order_by, limit, offset)
Load Channel Events

Returns a log of delivery events filtered by specified parameters. Required Access Level: ViewReports

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name** | **String** | Name of selected channel. | [required] |
**event_types** | Option<[**Vec<models::EventType>**](models::EventType.md)> | Types of Events to return |  |
**from** | Option<**String**> | Starting date for search in YYYY-MM-DDThh:mm:ss format. |  |
**to** | Option<**String**> | Ending date for search in YYYY-MM-DDThh:mm:ss format. |  |
**order_by** | Option<[**EventsOrderBy**](.md)> |  |  |
**limit** | Option<**i32**> | How many items to load. Maximum for this request is 1000 items |  |
**offset** | Option<**i32**> | How many items should be returned ahead. |  |

### Return type

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

### Authorization

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

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


## events_channels_export_by_id_status_get

> models::ExportStatus events_channels_export_by_id_status_get(id)
Check Channel Export Status

Check the current status of the channel export. Required Access Level: Export

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | ID of the exported file | [required] |

### Return type

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

### Authorization

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

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


## events_export_by_id_status_get

> models::ExportStatus events_export_by_id_status_get(id)
Check Export Status

Check the current status of the export. Required Access Level: Export

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | ID of the exported file | [required] |

### Return type

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

### Authorization

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

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


## events_export_post

> models::ExportLink events_export_post(event_types, from, to, file_format, compression_format, file_name)
Export Events

Export delivery events log information to the specified file format. Required Access Level: Export

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**event_types** | Option<[**Vec<models::EventType>**](models::EventType.md)> | Types of Events to return |  |
**from** | Option<**String**> | Starting date for search in YYYY-MM-DDThh:mm:ss format. |  |
**to** | Option<**String**> | Ending date for search in YYYY-MM-DDThh:mm:ss format. |  |
**file_format** | Option<[**ExportFileFormats**](.md)> | Format of the exported file |  |
**compression_format** | Option<[**CompressionFormat**](.md)> | FileResponse compression format. None or Zip. |  |
**file_name** | Option<**String**> | Name of your file including extension. |  |

### Return type

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

### Authorization

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

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


## events_get

> Vec<models::RecipientEvent> events_get(event_types, from, to, order_by, limit, offset)
Load Events

Returns a log of delivery events filtered by specified parameters. Required Access Level: ViewReports

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**event_types** | Option<[**Vec<models::EventType>**](models::EventType.md)> | Types of Events to return |  |
**from** | Option<**String**> | Starting date for search in YYYY-MM-DDThh:mm:ss format. |  |
**to** | Option<**String**> | Ending date for search in YYYY-MM-DDThh:mm:ss format. |  |
**order_by** | Option<[**EventsOrderBy**](.md)> |  |  |
**limit** | Option<**i32**> | How many items to load. Maximum for this request is 1000 items |  |
**offset** | Option<**i32**> | How many items should be returned ahead. |  |

### Return type

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

### Authorization

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

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