@productcraft/mail 0.3.0 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +188 -150
- package/api.md +3716 -0
- package/dist/index.cjs +3835 -7
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +5014 -29
- package/dist/index.d.ts +5014 -29
- package/dist/index.js +3770 -8
- package/dist/index.js.map +1 -1
- package/dist/testing.cjs +2383 -0
- package/dist/testing.cjs.map +1 -0
- package/dist/testing.d.cts +32 -0
- package/dist/testing.d.ts +32 -0
- package/dist/testing.js +2381 -0
- package/dist/testing.js.map +1 -0
- package/manifest.json +2186 -0
- package/package.json +14 -4
package/manifest.json
ADDED
|
@@ -0,0 +1,2186 @@
|
|
|
1
|
+
{
|
|
2
|
+
"operations": {
|
|
3
|
+
"BrandController_get": {
|
|
4
|
+
"actor": null,
|
|
5
|
+
"deprecated": false,
|
|
6
|
+
"http": "GET /v1/workspaces/{workspace_id}/brand",
|
|
7
|
+
"idempotent": false,
|
|
8
|
+
"method": "retrieve",
|
|
9
|
+
"paginated": false,
|
|
10
|
+
"params": null,
|
|
11
|
+
"poll": null,
|
|
12
|
+
"public": false,
|
|
13
|
+
"resource": "brand",
|
|
14
|
+
"scope": null,
|
|
15
|
+
"signature": "mail.brand.retrieve(options?): Mail.Brand",
|
|
16
|
+
"snippet": "const brand = await mail.brand.retrieve();"
|
|
17
|
+
},
|
|
18
|
+
"BrandController_reset": {
|
|
19
|
+
"actor": null,
|
|
20
|
+
"deprecated": false,
|
|
21
|
+
"http": "DELETE /v1/workspaces/{workspace_id}/brand",
|
|
22
|
+
"idempotent": false,
|
|
23
|
+
"method": "reset",
|
|
24
|
+
"paginated": false,
|
|
25
|
+
"params": null,
|
|
26
|
+
"poll": null,
|
|
27
|
+
"public": false,
|
|
28
|
+
"resource": "brand",
|
|
29
|
+
"scope": null,
|
|
30
|
+
"signature": "mail.brand.reset(options?): void",
|
|
31
|
+
"snippet": "await mail.brand.reset();"
|
|
32
|
+
},
|
|
33
|
+
"BrandController_update": {
|
|
34
|
+
"actor": null,
|
|
35
|
+
"deprecated": false,
|
|
36
|
+
"http": "PUT /v1/workspaces/{workspace_id}/brand",
|
|
37
|
+
"idempotent": true,
|
|
38
|
+
"method": "update",
|
|
39
|
+
"paginated": false,
|
|
40
|
+
"params": "Mail.BrandUpdateParams",
|
|
41
|
+
"poll": null,
|
|
42
|
+
"public": false,
|
|
43
|
+
"resource": "brand",
|
|
44
|
+
"scope": null,
|
|
45
|
+
"signature": "mail.brand.update(params?, options?): Mail.Brand",
|
|
46
|
+
"snippet": "const brand = await mail.brand.update({ background_color: \"string\" });"
|
|
47
|
+
},
|
|
48
|
+
"BroadcastSettingsController_get": {
|
|
49
|
+
"actor": null,
|
|
50
|
+
"deprecated": false,
|
|
51
|
+
"http": "GET /v1/workspaces/{workspace_id}/broadcast-settings",
|
|
52
|
+
"idempotent": false,
|
|
53
|
+
"method": "retrieve",
|
|
54
|
+
"paginated": false,
|
|
55
|
+
"params": null,
|
|
56
|
+
"poll": null,
|
|
57
|
+
"public": false,
|
|
58
|
+
"resource": "broadcasts.settings",
|
|
59
|
+
"scope": null,
|
|
60
|
+
"signature": "mail.broadcasts.settings.retrieve(options?): Mail.BroadcastSettings",
|
|
61
|
+
"snippet": "const broadcastSettings = await mail.broadcasts.settings.retrieve();"
|
|
62
|
+
},
|
|
63
|
+
"BroadcastSettingsController_update": {
|
|
64
|
+
"actor": null,
|
|
65
|
+
"deprecated": false,
|
|
66
|
+
"http": "PUT /v1/workspaces/{workspace_id}/broadcast-settings",
|
|
67
|
+
"idempotent": true,
|
|
68
|
+
"method": "update",
|
|
69
|
+
"paginated": false,
|
|
70
|
+
"params": "Mail.BroadcastSettingsUpdateParams",
|
|
71
|
+
"poll": null,
|
|
72
|
+
"public": false,
|
|
73
|
+
"resource": "broadcasts.settings",
|
|
74
|
+
"scope": null,
|
|
75
|
+
"signature": "mail.broadcasts.settings.update(params, options?): Mail.BroadcastSettings",
|
|
76
|
+
"snippet": "const broadcastSettings = await mail.broadcasts.settings.update({ rate_per_minute: 1 });"
|
|
77
|
+
},
|
|
78
|
+
"BroadcastsController_audience": {
|
|
79
|
+
"actor": null,
|
|
80
|
+
"deprecated": false,
|
|
81
|
+
"http": "GET /v1/workspaces/{workspace_id}/broadcasts/audience",
|
|
82
|
+
"idempotent": false,
|
|
83
|
+
"method": "audience",
|
|
84
|
+
"paginated": false,
|
|
85
|
+
"params": "Mail.BroadcastAudienceParams",
|
|
86
|
+
"poll": null,
|
|
87
|
+
"public": false,
|
|
88
|
+
"resource": "broadcasts",
|
|
89
|
+
"scope": null,
|
|
90
|
+
"signature": "mail.broadcasts.audience(params?, options?): Mail.BroadcastAudience",
|
|
91
|
+
"snippet": "const broadcastAudience = await mail.broadcasts.audience();"
|
|
92
|
+
},
|
|
93
|
+
"BroadcastsController_cancel": {
|
|
94
|
+
"actor": null,
|
|
95
|
+
"deprecated": false,
|
|
96
|
+
"http": "POST /v1/workspaces/{workspace_id}/broadcasts/{broadcast_id}/cancel",
|
|
97
|
+
"idempotent": true,
|
|
98
|
+
"method": "cancel",
|
|
99
|
+
"paginated": false,
|
|
100
|
+
"params": null,
|
|
101
|
+
"poll": null,
|
|
102
|
+
"public": false,
|
|
103
|
+
"resource": "broadcasts",
|
|
104
|
+
"scope": null,
|
|
105
|
+
"signature": "mail.broadcasts.cancel(broadcastId, options?): Mail.Broadcast",
|
|
106
|
+
"snippet": "const broadcast = await mail.broadcasts.cancel(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
107
|
+
},
|
|
108
|
+
"BroadcastsController_clickedLinks": {
|
|
109
|
+
"actor": null,
|
|
110
|
+
"deprecated": false,
|
|
111
|
+
"http": "GET /v1/workspaces/{workspace_id}/broadcasts/{broadcast_id}/clicked-links",
|
|
112
|
+
"idempotent": false,
|
|
113
|
+
"method": "list",
|
|
114
|
+
"paginated": false,
|
|
115
|
+
"params": null,
|
|
116
|
+
"poll": null,
|
|
117
|
+
"public": false,
|
|
118
|
+
"resource": "broadcasts.clickedLinks",
|
|
119
|
+
"scope": null,
|
|
120
|
+
"signature": "mail.broadcasts.clickedLinks.list(broadcastId, options?): Mail.ClickedLinks",
|
|
121
|
+
"snippet": "const clickedLinks = await mail.broadcasts.clickedLinks.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
122
|
+
},
|
|
123
|
+
"BroadcastsController_create": {
|
|
124
|
+
"actor": null,
|
|
125
|
+
"deprecated": false,
|
|
126
|
+
"http": "POST /v1/workspaces/{workspace_id}/broadcasts",
|
|
127
|
+
"idempotent": true,
|
|
128
|
+
"method": "create",
|
|
129
|
+
"paginated": false,
|
|
130
|
+
"params": "Mail.BroadcastCreateParams",
|
|
131
|
+
"poll": null,
|
|
132
|
+
"public": false,
|
|
133
|
+
"resource": "broadcasts",
|
|
134
|
+
"scope": null,
|
|
135
|
+
"signature": "mail.broadcasts.create(params, options?): Mail.Broadcast",
|
|
136
|
+
"snippet": "const broadcast = await mail.broadcasts.create({ name: \"October product update\" });"
|
|
137
|
+
},
|
|
138
|
+
"BroadcastsController_duplicate": {
|
|
139
|
+
"actor": null,
|
|
140
|
+
"deprecated": false,
|
|
141
|
+
"http": "POST /v1/workspaces/{workspace_id}/broadcasts/{broadcast_id}/duplicate",
|
|
142
|
+
"idempotent": true,
|
|
143
|
+
"method": "duplicate",
|
|
144
|
+
"paginated": false,
|
|
145
|
+
"params": null,
|
|
146
|
+
"poll": null,
|
|
147
|
+
"public": false,
|
|
148
|
+
"resource": "broadcasts",
|
|
149
|
+
"scope": null,
|
|
150
|
+
"signature": "mail.broadcasts.duplicate(broadcastId, options?): Mail.Broadcast",
|
|
151
|
+
"snippet": "const broadcast = await mail.broadcasts.duplicate(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
152
|
+
},
|
|
153
|
+
"BroadcastsController_get": {
|
|
154
|
+
"actor": null,
|
|
155
|
+
"deprecated": false,
|
|
156
|
+
"http": "GET /v1/workspaces/{workspace_id}/broadcasts/{broadcast_id}",
|
|
157
|
+
"idempotent": false,
|
|
158
|
+
"method": "retrieve",
|
|
159
|
+
"paginated": false,
|
|
160
|
+
"params": null,
|
|
161
|
+
"poll": null,
|
|
162
|
+
"public": false,
|
|
163
|
+
"resource": "broadcasts",
|
|
164
|
+
"scope": null,
|
|
165
|
+
"signature": "mail.broadcasts.retrieve(broadcastId, options?): Mail.Broadcast",
|
|
166
|
+
"snippet": "const broadcast = await mail.broadcasts.retrieve(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
167
|
+
},
|
|
168
|
+
"BroadcastsController_list": {
|
|
169
|
+
"actor": null,
|
|
170
|
+
"deprecated": false,
|
|
171
|
+
"http": "GET /v1/workspaces/{workspace_id}/broadcasts",
|
|
172
|
+
"idempotent": false,
|
|
173
|
+
"method": "list",
|
|
174
|
+
"paginated": true,
|
|
175
|
+
"params": "Mail.BroadcastListParams",
|
|
176
|
+
"poll": null,
|
|
177
|
+
"public": false,
|
|
178
|
+
"resource": "broadcasts",
|
|
179
|
+
"scope": null,
|
|
180
|
+
"signature": "mail.broadcasts.list(params?, options?): PagePromise<Mail.Broadcast>",
|
|
181
|
+
"snippet": "for await (const broadcast of mail.broadcasts.list()) {\n console.log(broadcast);\n}\nconst page = await mail.broadcasts.list({}, { timeout: 5_000 });"
|
|
182
|
+
},
|
|
183
|
+
"BroadcastsController_recipients": {
|
|
184
|
+
"actor": null,
|
|
185
|
+
"deprecated": false,
|
|
186
|
+
"http": "GET /v1/workspaces/{workspace_id}/broadcasts/{broadcast_id}/recipients",
|
|
187
|
+
"idempotent": false,
|
|
188
|
+
"method": "list",
|
|
189
|
+
"paginated": true,
|
|
190
|
+
"params": "Mail.BroadcastRecipientListParams",
|
|
191
|
+
"poll": null,
|
|
192
|
+
"public": false,
|
|
193
|
+
"resource": "broadcasts.recipients",
|
|
194
|
+
"scope": null,
|
|
195
|
+
"signature": "mail.broadcasts.recipients.list(broadcastId, params?, options?): PagePromise<Mail.BroadcastRecipient>",
|
|
196
|
+
"snippet": "for await (const recipient of mail.broadcasts.recipients.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\")) {\n console.log(recipient);\n}\nconst page = await mail.broadcasts.recipients.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", {}, { timeout: 5_000 });"
|
|
197
|
+
},
|
|
198
|
+
"BroadcastsController_remove": {
|
|
199
|
+
"actor": null,
|
|
200
|
+
"deprecated": false,
|
|
201
|
+
"http": "DELETE /v1/workspaces/{workspace_id}/broadcasts/{broadcast_id}",
|
|
202
|
+
"idempotent": false,
|
|
203
|
+
"method": "delete",
|
|
204
|
+
"paginated": false,
|
|
205
|
+
"params": null,
|
|
206
|
+
"poll": null,
|
|
207
|
+
"public": false,
|
|
208
|
+
"resource": "broadcasts",
|
|
209
|
+
"scope": null,
|
|
210
|
+
"signature": "mail.broadcasts.delete(broadcastId, options?): void",
|
|
211
|
+
"snippet": "await mail.broadcasts.delete(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
212
|
+
},
|
|
213
|
+
"BroadcastsController_send": {
|
|
214
|
+
"actor": null,
|
|
215
|
+
"deprecated": false,
|
|
216
|
+
"http": "POST /v1/workspaces/{workspace_id}/broadcasts/{broadcast_id}/send",
|
|
217
|
+
"idempotent": true,
|
|
218
|
+
"method": "send",
|
|
219
|
+
"paginated": false,
|
|
220
|
+
"params": "Mail.BroadcastSendParams",
|
|
221
|
+
"poll": null,
|
|
222
|
+
"public": false,
|
|
223
|
+
"resource": "broadcasts",
|
|
224
|
+
"scope": null,
|
|
225
|
+
"signature": "mail.broadcasts.send(broadcastId, params?, options?): Mail.Broadcast",
|
|
226
|
+
"snippet": "const broadcast = await mail.broadcasts.send(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", { scheduled_at: \"2026-11-02T09:00:00Z\" });"
|
|
227
|
+
},
|
|
228
|
+
"BroadcastsController_update": {
|
|
229
|
+
"actor": null,
|
|
230
|
+
"deprecated": false,
|
|
231
|
+
"http": "PATCH /v1/workspaces/{workspace_id}/broadcasts/{broadcast_id}",
|
|
232
|
+
"idempotent": true,
|
|
233
|
+
"method": "update",
|
|
234
|
+
"paginated": false,
|
|
235
|
+
"params": "Mail.BroadcastUpdateParams",
|
|
236
|
+
"poll": null,
|
|
237
|
+
"public": false,
|
|
238
|
+
"resource": "broadcasts",
|
|
239
|
+
"scope": null,
|
|
240
|
+
"signature": "mail.broadcasts.update(broadcastId, params?, options?): Mail.Broadcast",
|
|
241
|
+
"snippet": "const broadcast = await mail.broadcasts.update(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", { from: \"string\" });"
|
|
242
|
+
},
|
|
243
|
+
"ContactImportsController_create": {
|
|
244
|
+
"actor": null,
|
|
245
|
+
"deprecated": false,
|
|
246
|
+
"http": "POST /v1/workspaces/{workspace_id}/contacts/imports",
|
|
247
|
+
"idempotent": true,
|
|
248
|
+
"method": "create",
|
|
249
|
+
"paginated": false,
|
|
250
|
+
"params": "Mail.ContactImportCreateParams",
|
|
251
|
+
"poll": null,
|
|
252
|
+
"public": false,
|
|
253
|
+
"resource": "contacts.imports",
|
|
254
|
+
"scope": null,
|
|
255
|
+
"signature": "mail.contacts.imports.create(params, options?): Mail.ContactImport",
|
|
256
|
+
"snippet": "const contactImport = await mail.contacts.imports.create({\n csv: \"email,first_name,consent,consented_at\\nada@example.com,Ada,true,2026-10-01T09:00:00Z\\n\",\n on_conflict: \"upsert\",\n});"
|
|
257
|
+
},
|
|
258
|
+
"ContactImportsController_get": {
|
|
259
|
+
"actor": null,
|
|
260
|
+
"deprecated": false,
|
|
261
|
+
"http": "GET /v1/workspaces/{workspace_id}/contacts/imports/{import_id}",
|
|
262
|
+
"idempotent": false,
|
|
263
|
+
"method": "retrieve",
|
|
264
|
+
"paginated": false,
|
|
265
|
+
"params": null,
|
|
266
|
+
"poll": null,
|
|
267
|
+
"public": false,
|
|
268
|
+
"resource": "contacts.imports",
|
|
269
|
+
"scope": null,
|
|
270
|
+
"signature": "mail.contacts.imports.retrieve(importId, options?): Mail.ContactImport",
|
|
271
|
+
"snippet": "const contactImport = await mail.contacts.imports.retrieve(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
272
|
+
},
|
|
273
|
+
"ContactImportsController_list": {
|
|
274
|
+
"actor": null,
|
|
275
|
+
"deprecated": false,
|
|
276
|
+
"http": "GET /v1/workspaces/{workspace_id}/contacts/imports",
|
|
277
|
+
"idempotent": false,
|
|
278
|
+
"method": "list",
|
|
279
|
+
"paginated": true,
|
|
280
|
+
"params": "Mail.ContactImportListParams",
|
|
281
|
+
"poll": null,
|
|
282
|
+
"public": false,
|
|
283
|
+
"resource": "contacts.imports",
|
|
284
|
+
"scope": null,
|
|
285
|
+
"signature": "mail.contacts.imports.list(params?, options?): PagePromise<Mail.ContactImport>",
|
|
286
|
+
"snippet": "for await (const importItem of mail.contacts.imports.list()) {\n console.log(importItem);\n}\nconst page = await mail.contacts.imports.list({}, { timeout: 5_000 });"
|
|
287
|
+
},
|
|
288
|
+
"ContactPropertiesController_create": {
|
|
289
|
+
"actor": null,
|
|
290
|
+
"deprecated": false,
|
|
291
|
+
"http": "POST /v1/workspaces/{workspace_id}/contact-properties",
|
|
292
|
+
"idempotent": true,
|
|
293
|
+
"method": "create",
|
|
294
|
+
"paginated": false,
|
|
295
|
+
"params": "Mail.ContactPropertyCreateParams",
|
|
296
|
+
"poll": null,
|
|
297
|
+
"public": false,
|
|
298
|
+
"resource": "contacts.properties",
|
|
299
|
+
"scope": null,
|
|
300
|
+
"signature": "mail.contacts.properties.create(params, options?): Mail.ContactProperty",
|
|
301
|
+
"snippet": "const contactProperty = await mail.contacts.properties.create({ key: \"company\", type: \"string\" });"
|
|
302
|
+
},
|
|
303
|
+
"ContactPropertiesController_get": {
|
|
304
|
+
"actor": null,
|
|
305
|
+
"deprecated": false,
|
|
306
|
+
"http": "GET /v1/workspaces/{workspace_id}/contact-properties/{property_id}",
|
|
307
|
+
"idempotent": false,
|
|
308
|
+
"method": "retrieve",
|
|
309
|
+
"paginated": false,
|
|
310
|
+
"params": null,
|
|
311
|
+
"poll": null,
|
|
312
|
+
"public": false,
|
|
313
|
+
"resource": "contacts.properties",
|
|
314
|
+
"scope": null,
|
|
315
|
+
"signature": "mail.contacts.properties.retrieve(propertyId, options?): Mail.ContactProperty",
|
|
316
|
+
"snippet": "const contactProperty = await mail.contacts.properties.retrieve(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
317
|
+
},
|
|
318
|
+
"ContactPropertiesController_list": {
|
|
319
|
+
"actor": null,
|
|
320
|
+
"deprecated": false,
|
|
321
|
+
"http": "GET /v1/workspaces/{workspace_id}/contact-properties",
|
|
322
|
+
"idempotent": false,
|
|
323
|
+
"method": "list",
|
|
324
|
+
"paginated": true,
|
|
325
|
+
"params": "Mail.ContactPropertyListParams",
|
|
326
|
+
"poll": null,
|
|
327
|
+
"public": false,
|
|
328
|
+
"resource": "contacts.properties",
|
|
329
|
+
"scope": null,
|
|
330
|
+
"signature": "mail.contacts.properties.list(params?, options?): PagePromise<Mail.ContactProperty>",
|
|
331
|
+
"snippet": "for await (const property of mail.contacts.properties.list()) {\n console.log(property);\n}\nconst page = await mail.contacts.properties.list({}, { timeout: 5_000 });"
|
|
332
|
+
},
|
|
333
|
+
"ContactPropertiesController_remove": {
|
|
334
|
+
"actor": null,
|
|
335
|
+
"deprecated": false,
|
|
336
|
+
"http": "DELETE /v1/workspaces/{workspace_id}/contact-properties/{property_id}",
|
|
337
|
+
"idempotent": false,
|
|
338
|
+
"method": "delete",
|
|
339
|
+
"paginated": false,
|
|
340
|
+
"params": null,
|
|
341
|
+
"poll": null,
|
|
342
|
+
"public": false,
|
|
343
|
+
"resource": "contacts.properties",
|
|
344
|
+
"scope": null,
|
|
345
|
+
"signature": "mail.contacts.properties.delete(propertyId, options?): void",
|
|
346
|
+
"snippet": "await mail.contacts.properties.delete(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
347
|
+
},
|
|
348
|
+
"ContactPropertiesController_update": {
|
|
349
|
+
"actor": null,
|
|
350
|
+
"deprecated": false,
|
|
351
|
+
"http": "PATCH /v1/workspaces/{workspace_id}/contact-properties/{property_id}",
|
|
352
|
+
"idempotent": true,
|
|
353
|
+
"method": "update",
|
|
354
|
+
"paginated": false,
|
|
355
|
+
"params": "Mail.ContactPropertyUpdateParams",
|
|
356
|
+
"poll": null,
|
|
357
|
+
"public": false,
|
|
358
|
+
"resource": "contacts.properties",
|
|
359
|
+
"scope": null,
|
|
360
|
+
"signature": "mail.contacts.properties.update(propertyId, params?, options?): Mail.ContactProperty",
|
|
361
|
+
"snippet": "const contactProperty = await mail.contacts.properties.update(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", { fallback_value: \"string\" });"
|
|
362
|
+
},
|
|
363
|
+
"ContactSegmentsController_add": {
|
|
364
|
+
"actor": null,
|
|
365
|
+
"deprecated": false,
|
|
366
|
+
"http": "POST /v1/workspaces/{workspace_id}/contacts/{contact}/segments/{segment_id}",
|
|
367
|
+
"idempotent": true,
|
|
368
|
+
"method": "add",
|
|
369
|
+
"paginated": false,
|
|
370
|
+
"params": null,
|
|
371
|
+
"poll": null,
|
|
372
|
+
"public": false,
|
|
373
|
+
"resource": "contacts.segments",
|
|
374
|
+
"scope": null,
|
|
375
|
+
"signature": "mail.contacts.segments.add(contact, segmentId, options?): Mail.SegmentMembership",
|
|
376
|
+
"snippet": "const segmentMembership = await mail.contacts.segments.add(\"ada@example.com\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\");"
|
|
377
|
+
},
|
|
378
|
+
"ContactSegmentsController_list": {
|
|
379
|
+
"actor": null,
|
|
380
|
+
"deprecated": false,
|
|
381
|
+
"http": "GET /v1/workspaces/{workspace_id}/contacts/{contact}/segments",
|
|
382
|
+
"idempotent": false,
|
|
383
|
+
"method": "list",
|
|
384
|
+
"paginated": false,
|
|
385
|
+
"params": null,
|
|
386
|
+
"poll": null,
|
|
387
|
+
"public": false,
|
|
388
|
+
"resource": "contacts.segments",
|
|
389
|
+
"scope": null,
|
|
390
|
+
"signature": "mail.contacts.segments.list(contact, options?): Mail.ContactSegments",
|
|
391
|
+
"snippet": "const contactSegments = await mail.contacts.segments.list(\"ada@example.com\");"
|
|
392
|
+
},
|
|
393
|
+
"ContactSegmentsController_remove": {
|
|
394
|
+
"actor": null,
|
|
395
|
+
"deprecated": false,
|
|
396
|
+
"http": "DELETE /v1/workspaces/{workspace_id}/contacts/{contact}/segments/{segment_id}",
|
|
397
|
+
"idempotent": false,
|
|
398
|
+
"method": "delete",
|
|
399
|
+
"paginated": false,
|
|
400
|
+
"params": null,
|
|
401
|
+
"poll": null,
|
|
402
|
+
"public": false,
|
|
403
|
+
"resource": "contacts.segments",
|
|
404
|
+
"scope": null,
|
|
405
|
+
"signature": "mail.contacts.segments.delete(contact, segmentId, options?): void",
|
|
406
|
+
"snippet": "await mail.contacts.segments.delete(\"ada@example.com\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\");"
|
|
407
|
+
},
|
|
408
|
+
"ContactsController_create": {
|
|
409
|
+
"actor": null,
|
|
410
|
+
"deprecated": false,
|
|
411
|
+
"http": "POST /v1/workspaces/{workspace_id}/contacts",
|
|
412
|
+
"idempotent": true,
|
|
413
|
+
"method": "create",
|
|
414
|
+
"paginated": false,
|
|
415
|
+
"params": "Mail.ContactCreateParams",
|
|
416
|
+
"poll": null,
|
|
417
|
+
"public": false,
|
|
418
|
+
"resource": "contacts",
|
|
419
|
+
"scope": null,
|
|
420
|
+
"signature": "mail.contacts.create(params, options?): Mail.Contact",
|
|
421
|
+
"snippet": "const contact = await mail.contacts.create({ email: \"ada@example.com\" });"
|
|
422
|
+
},
|
|
423
|
+
"ContactsController_get": {
|
|
424
|
+
"actor": null,
|
|
425
|
+
"deprecated": false,
|
|
426
|
+
"http": "GET /v1/workspaces/{workspace_id}/contacts/{contact}",
|
|
427
|
+
"idempotent": false,
|
|
428
|
+
"method": "retrieve",
|
|
429
|
+
"paginated": false,
|
|
430
|
+
"params": null,
|
|
431
|
+
"poll": null,
|
|
432
|
+
"public": false,
|
|
433
|
+
"resource": "contacts",
|
|
434
|
+
"scope": null,
|
|
435
|
+
"signature": "mail.contacts.retrieve(contact, options?): Mail.Contact",
|
|
436
|
+
"snippet": "const contact = await mail.contacts.retrieve(\"ada@example.com\");"
|
|
437
|
+
},
|
|
438
|
+
"ContactsController_list": {
|
|
439
|
+
"actor": null,
|
|
440
|
+
"deprecated": false,
|
|
441
|
+
"http": "GET /v1/workspaces/{workspace_id}/contacts",
|
|
442
|
+
"idempotent": false,
|
|
443
|
+
"method": "list",
|
|
444
|
+
"paginated": true,
|
|
445
|
+
"params": "Mail.ContactListParams",
|
|
446
|
+
"poll": null,
|
|
447
|
+
"public": false,
|
|
448
|
+
"resource": "contacts",
|
|
449
|
+
"scope": null,
|
|
450
|
+
"signature": "mail.contacts.list(params?, options?): PagePromise<Mail.Contact>",
|
|
451
|
+
"snippet": "for await (const contact of mail.contacts.list()) {\n console.log(contact);\n}\nconst page = await mail.contacts.list({}, { timeout: 5_000 });"
|
|
452
|
+
},
|
|
453
|
+
"ContactsController_remove": {
|
|
454
|
+
"actor": null,
|
|
455
|
+
"deprecated": false,
|
|
456
|
+
"http": "DELETE /v1/workspaces/{workspace_id}/contacts/{contact}",
|
|
457
|
+
"idempotent": false,
|
|
458
|
+
"method": "delete",
|
|
459
|
+
"paginated": false,
|
|
460
|
+
"params": null,
|
|
461
|
+
"poll": null,
|
|
462
|
+
"public": false,
|
|
463
|
+
"resource": "contacts",
|
|
464
|
+
"scope": null,
|
|
465
|
+
"signature": "mail.contacts.delete(contact, options?): void",
|
|
466
|
+
"snippet": "await mail.contacts.delete(\"ada@example.com\");"
|
|
467
|
+
},
|
|
468
|
+
"ContactsController_topics": {
|
|
469
|
+
"actor": null,
|
|
470
|
+
"deprecated": false,
|
|
471
|
+
"http": "GET /v1/workspaces/{workspace_id}/contacts/{contact}/topics",
|
|
472
|
+
"idempotent": false,
|
|
473
|
+
"method": "list",
|
|
474
|
+
"paginated": false,
|
|
475
|
+
"params": null,
|
|
476
|
+
"poll": null,
|
|
477
|
+
"public": false,
|
|
478
|
+
"resource": "contacts.topics",
|
|
479
|
+
"scope": null,
|
|
480
|
+
"signature": "mail.contacts.topics.list(contact, options?): Mail.ContactTopics",
|
|
481
|
+
"snippet": "const contactTopics = await mail.contacts.topics.list(\"ada@example.com\");"
|
|
482
|
+
},
|
|
483
|
+
"ContactsController_update": {
|
|
484
|
+
"actor": null,
|
|
485
|
+
"deprecated": false,
|
|
486
|
+
"http": "PATCH /v1/workspaces/{workspace_id}/contacts/{contact}",
|
|
487
|
+
"idempotent": true,
|
|
488
|
+
"method": "update",
|
|
489
|
+
"paginated": false,
|
|
490
|
+
"params": "Mail.ContactUpdateParams",
|
|
491
|
+
"poll": null,
|
|
492
|
+
"public": false,
|
|
493
|
+
"resource": "contacts",
|
|
494
|
+
"scope": null,
|
|
495
|
+
"signature": "mail.contacts.update(contact, params?, options?): Mail.Contact",
|
|
496
|
+
"snippet": "const contact = await mail.contacts.update(\"ada@example.com\", { consent: { consented_at: \"2026-10-24T09:00:00Z\", source: \"signup-form-2026\" } });"
|
|
497
|
+
},
|
|
498
|
+
"ContactsController_updateTopics": {
|
|
499
|
+
"actor": null,
|
|
500
|
+
"deprecated": false,
|
|
501
|
+
"http": "PATCH /v1/workspaces/{workspace_id}/contacts/{contact}/topics",
|
|
502
|
+
"idempotent": true,
|
|
503
|
+
"method": "update",
|
|
504
|
+
"paginated": false,
|
|
505
|
+
"params": "Mail.ContactTopicUpdateParams",
|
|
506
|
+
"poll": null,
|
|
507
|
+
"public": false,
|
|
508
|
+
"resource": "contacts.topics",
|
|
509
|
+
"scope": null,
|
|
510
|
+
"signature": "mail.contacts.topics.update(contact, params, options?): Mail.ContactTopics",
|
|
511
|
+
"snippet": "const contactTopics = await mail.contacts.topics.update(\"ada@example.com\", { topics: [{ id: \"9b2f6c1e-0d6a-4a63-9a43-2f1c3e4d5a6b\", subscription: \"opt_in\" }] });"
|
|
512
|
+
},
|
|
513
|
+
"DeliverabilityController_get": {
|
|
514
|
+
"actor": null,
|
|
515
|
+
"deprecated": false,
|
|
516
|
+
"http": "GET /v1/workspaces/{workspace_id}/deliverability",
|
|
517
|
+
"idempotent": false,
|
|
518
|
+
"method": "retrieve",
|
|
519
|
+
"paginated": false,
|
|
520
|
+
"params": "Mail.DeliverabilityRetrieveParams",
|
|
521
|
+
"poll": null,
|
|
522
|
+
"public": false,
|
|
523
|
+
"resource": "deliverability",
|
|
524
|
+
"scope": null,
|
|
525
|
+
"signature": "mail.deliverability.retrieve(params?, options?): Mail.Deliverability",
|
|
526
|
+
"snippet": "const deliverability = await mail.deliverability.retrieve();"
|
|
527
|
+
},
|
|
528
|
+
"DnsApplyController_apply": {
|
|
529
|
+
"actor": null,
|
|
530
|
+
"deprecated": false,
|
|
531
|
+
"http": "POST /v1/workspaces/{workspace_id}/domains/{domain_id}/dns-records/apply",
|
|
532
|
+
"idempotent": true,
|
|
533
|
+
"method": "apply",
|
|
534
|
+
"paginated": false,
|
|
535
|
+
"params": "Mail.DomainDnsRecordApplyParams",
|
|
536
|
+
"poll": null,
|
|
537
|
+
"public": false,
|
|
538
|
+
"resource": "domains.dnsRecords",
|
|
539
|
+
"scope": null,
|
|
540
|
+
"signature": "mail.domains.dnsRecords.apply(domainId, params, options?): Mail.DnsApplyResult",
|
|
541
|
+
"snippet": "const dnsApplyResult = await mail.domains.dnsRecords.apply(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", { dry_run: true, provider: \"cloudflare\", token: \"dop_v1_EXAMPLE_TOKEN_DO_NOT_USE\" });"
|
|
542
|
+
},
|
|
543
|
+
"DomainConnectController_start": {
|
|
544
|
+
"actor": null,
|
|
545
|
+
"deprecated": false,
|
|
546
|
+
"http": "POST /v1/workspaces/{workspace_id}/domains/{domain_id}/domain-connect/start",
|
|
547
|
+
"idempotent": true,
|
|
548
|
+
"method": "start",
|
|
549
|
+
"paginated": false,
|
|
550
|
+
"params": "Mail.DomainDomainConnectStartParams",
|
|
551
|
+
"poll": null,
|
|
552
|
+
"public": false,
|
|
553
|
+
"resource": "domains.domainConnect",
|
|
554
|
+
"scope": null,
|
|
555
|
+
"signature": "mail.domains.domainConnect.start(domainId, params?, options?): Mail.DomainConnectStart",
|
|
556
|
+
"snippet": "const domainConnectStart = await mail.domains.domainConnect.start(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", { include_dmarc: true });"
|
|
557
|
+
},
|
|
558
|
+
"DomainController_checkDnsRecords": {
|
|
559
|
+
"actor": null,
|
|
560
|
+
"deprecated": false,
|
|
561
|
+
"http": "POST /v1/workspaces/{workspace_id}/domains/{domain_id}/dns-records/check",
|
|
562
|
+
"idempotent": false,
|
|
563
|
+
"method": "check",
|
|
564
|
+
"paginated": false,
|
|
565
|
+
"params": "Mail.DomainDnsRecordCheckParams",
|
|
566
|
+
"poll": null,
|
|
567
|
+
"public": false,
|
|
568
|
+
"resource": "domains.dnsRecords",
|
|
569
|
+
"scope": null,
|
|
570
|
+
"signature": "mail.domains.dnsRecords.check(domainId, params?, options?): Mail.DomainDnsRecords",
|
|
571
|
+
"snippet": "const domainDnsRecords = await mail.domains.dnsRecords.check(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
572
|
+
},
|
|
573
|
+
"DomainController_createDomain": {
|
|
574
|
+
"actor": null,
|
|
575
|
+
"deprecated": false,
|
|
576
|
+
"http": "POST /v1/workspaces/{workspace_id}/domains",
|
|
577
|
+
"idempotent": true,
|
|
578
|
+
"method": "create",
|
|
579
|
+
"paginated": false,
|
|
580
|
+
"params": "Mail.DomainCreateParams",
|
|
581
|
+
"poll": null,
|
|
582
|
+
"public": false,
|
|
583
|
+
"resource": "domains",
|
|
584
|
+
"scope": null,
|
|
585
|
+
"signature": "mail.domains.create(params?, options?): Mail.Domain",
|
|
586
|
+
"snippet": "const domain = await mail.domains.create({ capabilities: { receiving: \"enabled\", sending: \"enabled\" } });"
|
|
587
|
+
},
|
|
588
|
+
"DomainController_deleteDomain": {
|
|
589
|
+
"actor": null,
|
|
590
|
+
"deprecated": false,
|
|
591
|
+
"http": "DELETE /v1/workspaces/{workspace_id}/domains/{domain_id}",
|
|
592
|
+
"idempotent": false,
|
|
593
|
+
"method": "delete",
|
|
594
|
+
"paginated": false,
|
|
595
|
+
"params": null,
|
|
596
|
+
"poll": null,
|
|
597
|
+
"public": false,
|
|
598
|
+
"resource": "domains",
|
|
599
|
+
"scope": null,
|
|
600
|
+
"signature": "mail.domains.delete(domainId, options?): void",
|
|
601
|
+
"snippet": "await mail.domains.delete(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
602
|
+
},
|
|
603
|
+
"DomainController_exportDnsRecords": {
|
|
604
|
+
"actor": null,
|
|
605
|
+
"deprecated": false,
|
|
606
|
+
"http": "GET /v1/workspaces/{workspace_id}/domains/{domain_id}/dns-records/export",
|
|
607
|
+
"idempotent": false,
|
|
608
|
+
"method": "export",
|
|
609
|
+
"paginated": false,
|
|
610
|
+
"params": "Mail.DomainDnsRecordExportParams",
|
|
611
|
+
"poll": null,
|
|
612
|
+
"public": false,
|
|
613
|
+
"resource": "domains.dnsRecords",
|
|
614
|
+
"scope": null,
|
|
615
|
+
"signature": "mail.domains.dnsRecords.export(domainId, params, options?): Response",
|
|
616
|
+
"snippet": "const response = await mail.domains.dnsRecords.export(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", { format: \"bind\" });\nconst text = await response.text();"
|
|
617
|
+
},
|
|
618
|
+
"DomainController_getDnsRecords": {
|
|
619
|
+
"actor": null,
|
|
620
|
+
"deprecated": false,
|
|
621
|
+
"http": "GET /v1/workspaces/{workspace_id}/domains/{domain_id}/dns-records",
|
|
622
|
+
"idempotent": false,
|
|
623
|
+
"method": "list",
|
|
624
|
+
"paginated": false,
|
|
625
|
+
"params": "Mail.DomainDnsRecordListParams",
|
|
626
|
+
"poll": null,
|
|
627
|
+
"public": false,
|
|
628
|
+
"resource": "domains.dnsRecords",
|
|
629
|
+
"scope": null,
|
|
630
|
+
"signature": "mail.domains.dnsRecords.list(domainId, params?, options?): Mail.DomainDnsRecords",
|
|
631
|
+
"snippet": "const domainDnsRecords = await mail.domains.dnsRecords.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
632
|
+
},
|
|
633
|
+
"DomainController_getDomain": {
|
|
634
|
+
"actor": null,
|
|
635
|
+
"deprecated": false,
|
|
636
|
+
"http": "GET /v1/workspaces/{workspace_id}/domains/{domain_id}",
|
|
637
|
+
"idempotent": false,
|
|
638
|
+
"method": "retrieve",
|
|
639
|
+
"paginated": false,
|
|
640
|
+
"params": null,
|
|
641
|
+
"poll": {
|
|
642
|
+
"field": "status",
|
|
643
|
+
"terminal": [
|
|
644
|
+
"active",
|
|
645
|
+
"disabled"
|
|
646
|
+
]
|
|
647
|
+
},
|
|
648
|
+
"public": false,
|
|
649
|
+
"resource": "domains",
|
|
650
|
+
"scope": null,
|
|
651
|
+
"signature": "mail.domains.retrieve(domainId, options?): Mail.DomainDetail",
|
|
652
|
+
"snippet": "const domainDetail = await mail.domains.retrieve(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
653
|
+
},
|
|
654
|
+
"DomainController_listDomainEvents": {
|
|
655
|
+
"actor": null,
|
|
656
|
+
"deprecated": false,
|
|
657
|
+
"http": "GET /v1/workspaces/{workspace_id}/domains/{domain_id}/events",
|
|
658
|
+
"idempotent": false,
|
|
659
|
+
"method": "list",
|
|
660
|
+
"paginated": true,
|
|
661
|
+
"params": "Mail.DomainEventListParams",
|
|
662
|
+
"poll": null,
|
|
663
|
+
"public": false,
|
|
664
|
+
"resource": "domains.events",
|
|
665
|
+
"scope": null,
|
|
666
|
+
"signature": "mail.domains.events.list(domainId, params?, options?): PagePromise<Mail.DomainEvent>",
|
|
667
|
+
"snippet": "for await (const event of mail.domains.events.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\")) {\n console.log(event);\n}\nconst page = await mail.domains.events.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", {}, { timeout: 5_000 });"
|
|
668
|
+
},
|
|
669
|
+
"DomainController_listDomains": {
|
|
670
|
+
"actor": null,
|
|
671
|
+
"deprecated": false,
|
|
672
|
+
"http": "GET /v1/workspaces/{workspace_id}/domains",
|
|
673
|
+
"idempotent": false,
|
|
674
|
+
"method": "list",
|
|
675
|
+
"paginated": true,
|
|
676
|
+
"params": "Mail.DomainListParams",
|
|
677
|
+
"poll": null,
|
|
678
|
+
"public": false,
|
|
679
|
+
"resource": "domains",
|
|
680
|
+
"scope": null,
|
|
681
|
+
"signature": "mail.domains.list(params?, options?): PagePromise<Mail.Domain>",
|
|
682
|
+
"snippet": "for await (const domain of mail.domains.list()) {\n console.log(domain);\n}\nconst page = await mail.domains.list({}, { timeout: 5_000 });"
|
|
683
|
+
},
|
|
684
|
+
"DomainController_lookupDomain": {
|
|
685
|
+
"actor": null,
|
|
686
|
+
"deprecated": false,
|
|
687
|
+
"http": "GET /v1/workspaces/{workspace_id}/domains/lookup",
|
|
688
|
+
"idempotent": false,
|
|
689
|
+
"method": "lookup",
|
|
690
|
+
"paginated": false,
|
|
691
|
+
"params": "Mail.DomainLookupParams",
|
|
692
|
+
"poll": null,
|
|
693
|
+
"public": false,
|
|
694
|
+
"resource": "domains",
|
|
695
|
+
"scope": null,
|
|
696
|
+
"signature": "mail.domains.lookup(params, options?): Mail.DomainLookup",
|
|
697
|
+
"snippet": "const domainLookup = await mail.domains.lookup({ fqdn: \"acme.com\" });"
|
|
698
|
+
},
|
|
699
|
+
"DomainController_updateDomain": {
|
|
700
|
+
"actor": null,
|
|
701
|
+
"deprecated": false,
|
|
702
|
+
"http": "PATCH /v1/workspaces/{workspace_id}/domains/{domain_id}",
|
|
703
|
+
"idempotent": true,
|
|
704
|
+
"method": "update",
|
|
705
|
+
"paginated": false,
|
|
706
|
+
"params": "Mail.DomainUpdateParams",
|
|
707
|
+
"poll": null,
|
|
708
|
+
"public": false,
|
|
709
|
+
"resource": "domains",
|
|
710
|
+
"scope": null,
|
|
711
|
+
"signature": "mail.domains.update(domainId, params?, options?): Mail.Domain",
|
|
712
|
+
"snippet": "const domain = await mail.domains.update(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", { capabilities: { receiving: \"enabled\", sending: \"enabled\" } });"
|
|
713
|
+
},
|
|
714
|
+
"DomainController_verifyDomain": {
|
|
715
|
+
"actor": null,
|
|
716
|
+
"deprecated": false,
|
|
717
|
+
"http": "POST /v1/workspaces/{workspace_id}/domains/{domain_id}/verify",
|
|
718
|
+
"idempotent": false,
|
|
719
|
+
"method": "verify",
|
|
720
|
+
"paginated": false,
|
|
721
|
+
"params": null,
|
|
722
|
+
"poll": null,
|
|
723
|
+
"public": false,
|
|
724
|
+
"resource": "domains",
|
|
725
|
+
"scope": null,
|
|
726
|
+
"signature": "mail.domains.verify(domainId, options?): Mail.Domain",
|
|
727
|
+
"snippet": "const domain = await mail.domains.verify(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
728
|
+
},
|
|
729
|
+
"DomainSmtpConfigController_delete": {
|
|
730
|
+
"actor": null,
|
|
731
|
+
"deprecated": false,
|
|
732
|
+
"http": "DELETE /v1/workspaces/{workspace_id}/domains/{domain_id}/smtp-config",
|
|
733
|
+
"idempotent": false,
|
|
734
|
+
"method": "reset",
|
|
735
|
+
"paginated": false,
|
|
736
|
+
"params": null,
|
|
737
|
+
"poll": null,
|
|
738
|
+
"public": false,
|
|
739
|
+
"resource": "domains.smtpConfig",
|
|
740
|
+
"scope": null,
|
|
741
|
+
"signature": "mail.domains.smtpConfig.reset(domainId, options?): void",
|
|
742
|
+
"snippet": "await mail.domains.smtpConfig.reset(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
743
|
+
},
|
|
744
|
+
"DomainSmtpConfigController_get": {
|
|
745
|
+
"actor": null,
|
|
746
|
+
"deprecated": false,
|
|
747
|
+
"http": "GET /v1/workspaces/{workspace_id}/domains/{domain_id}/smtp-config",
|
|
748
|
+
"idempotent": false,
|
|
749
|
+
"method": "retrieve",
|
|
750
|
+
"paginated": false,
|
|
751
|
+
"params": null,
|
|
752
|
+
"poll": null,
|
|
753
|
+
"public": false,
|
|
754
|
+
"resource": "domains.smtpConfig",
|
|
755
|
+
"scope": null,
|
|
756
|
+
"signature": "mail.domains.smtpConfig.retrieve(domainId, options?): Mail.GetSmtpConfig",
|
|
757
|
+
"snippet": "const getSmtpConfig = await mail.domains.smtpConfig.retrieve(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
758
|
+
},
|
|
759
|
+
"DomainSmtpConfigController_upsert": {
|
|
760
|
+
"actor": null,
|
|
761
|
+
"deprecated": false,
|
|
762
|
+
"http": "PUT /v1/workspaces/{workspace_id}/domains/{domain_id}/smtp-config",
|
|
763
|
+
"idempotent": true,
|
|
764
|
+
"method": "update",
|
|
765
|
+
"paginated": false,
|
|
766
|
+
"params": "Mail.DomainSmtpConfigUpdateParams",
|
|
767
|
+
"poll": null,
|
|
768
|
+
"public": false,
|
|
769
|
+
"resource": "domains.smtpConfig",
|
|
770
|
+
"scope": null,
|
|
771
|
+
"signature": "mail.domains.smtpConfig.update(domainId, params, options?): Mail.SmtpConfig",
|
|
772
|
+
"snippet": "const smtpConfig = await mail.domains.smtpConfig.update(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", {\n from_email: \"noreply@acme.com\",\n from_name: \"Acme Notifications\",\n host: \"smtp.sendgrid.net\",\n port: 587,\n secure: false,\n});"
|
|
773
|
+
},
|
|
774
|
+
"DomainSmtpConfigController_verifySaved": {
|
|
775
|
+
"actor": null,
|
|
776
|
+
"deprecated": false,
|
|
777
|
+
"http": "POST /v1/workspaces/{workspace_id}/domains/{domain_id}/smtp-config/verify-saved",
|
|
778
|
+
"idempotent": false,
|
|
779
|
+
"method": "verifySaved",
|
|
780
|
+
"paginated": false,
|
|
781
|
+
"params": null,
|
|
782
|
+
"poll": null,
|
|
783
|
+
"public": false,
|
|
784
|
+
"resource": "domains.smtpConfig",
|
|
785
|
+
"scope": null,
|
|
786
|
+
"signature": "mail.domains.smtpConfig.verifySaved(domainId, options?): Mail.SmtpVerifyResult",
|
|
787
|
+
"snippet": "const smtpVerifyResult = await mail.domains.smtpConfig.verifySaved(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
788
|
+
},
|
|
789
|
+
"DomainTestSendController_testSend": {
|
|
790
|
+
"actor": null,
|
|
791
|
+
"deprecated": false,
|
|
792
|
+
"http": "POST /v1/workspaces/{workspace_id}/domains/{domain_id}/test-send",
|
|
793
|
+
"idempotent": true,
|
|
794
|
+
"method": "testSend",
|
|
795
|
+
"paginated": false,
|
|
796
|
+
"params": "Mail.DomainTestSendParams",
|
|
797
|
+
"poll": null,
|
|
798
|
+
"public": false,
|
|
799
|
+
"resource": "domains",
|
|
800
|
+
"scope": null,
|
|
801
|
+
"signature": "mail.domains.testSend(domainId, params, options?): Mail.SendAccepted",
|
|
802
|
+
"snippet": "const sendAccepted = await mail.domains.testSend(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", { to: \"you@acme.com\" });"
|
|
803
|
+
},
|
|
804
|
+
"EmailMetricsController_get": {
|
|
805
|
+
"actor": null,
|
|
806
|
+
"deprecated": false,
|
|
807
|
+
"http": "GET /v1/workspaces/{workspace_id}/emails/metrics",
|
|
808
|
+
"idempotent": false,
|
|
809
|
+
"method": "metrics",
|
|
810
|
+
"paginated": false,
|
|
811
|
+
"params": "Mail.EmailMetricsParams",
|
|
812
|
+
"poll": null,
|
|
813
|
+
"public": false,
|
|
814
|
+
"resource": "emails",
|
|
815
|
+
"scope": null,
|
|
816
|
+
"signature": "mail.emails.metrics(params?, options?): Mail.EmailMetrics",
|
|
817
|
+
"snippet": "const emailMetrics = await mail.emails.metrics();"
|
|
818
|
+
},
|
|
819
|
+
"EmailsController_list": {
|
|
820
|
+
"actor": null,
|
|
821
|
+
"deprecated": false,
|
|
822
|
+
"http": "GET /v1/workspaces/{workspace_id}/emails",
|
|
823
|
+
"idempotent": false,
|
|
824
|
+
"method": "list",
|
|
825
|
+
"paginated": true,
|
|
826
|
+
"params": "Mail.EmailListParams",
|
|
827
|
+
"poll": null,
|
|
828
|
+
"public": false,
|
|
829
|
+
"resource": "emails",
|
|
830
|
+
"scope": null,
|
|
831
|
+
"signature": "mail.emails.list(params?, options?): PagePromise<Mail.Email>",
|
|
832
|
+
"snippet": "for await (const email of mail.emails.list()) {\n console.log(email);\n}\nconst page = await mail.emails.list({}, { timeout: 5_000 });"
|
|
833
|
+
},
|
|
834
|
+
"EmailsController_retrieve": {
|
|
835
|
+
"actor": null,
|
|
836
|
+
"deprecated": false,
|
|
837
|
+
"http": "GET /v1/workspaces/{workspace_id}/emails/{id}",
|
|
838
|
+
"idempotent": false,
|
|
839
|
+
"method": "retrieve",
|
|
840
|
+
"paginated": false,
|
|
841
|
+
"params": null,
|
|
842
|
+
"poll": null,
|
|
843
|
+
"public": false,
|
|
844
|
+
"resource": "emails",
|
|
845
|
+
"scope": null,
|
|
846
|
+
"signature": "mail.emails.retrieve(id, options?): Mail.EmailDetail",
|
|
847
|
+
"snippet": "const emailDetail = await mail.emails.retrieve(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
848
|
+
},
|
|
849
|
+
"EmailsController_send": {
|
|
850
|
+
"actor": null,
|
|
851
|
+
"deprecated": false,
|
|
852
|
+
"http": "POST /v1/workspaces/{workspace_id}/emails",
|
|
853
|
+
"idempotent": true,
|
|
854
|
+
"method": "send",
|
|
855
|
+
"paginated": false,
|
|
856
|
+
"params": "Mail.EmailSendParams",
|
|
857
|
+
"poll": null,
|
|
858
|
+
"public": false,
|
|
859
|
+
"resource": "emails",
|
|
860
|
+
"scope": null,
|
|
861
|
+
"signature": "mail.emails.send(params, options?): Mail.SendEmail",
|
|
862
|
+
"snippet": "const sendEmail = await mail.emails.send({ from: \"Acme <hello@mail.acme.com>\", to: [\"success@simulator.amazonses.com\"] });"
|
|
863
|
+
},
|
|
864
|
+
"EmailsController_sendBatch": {
|
|
865
|
+
"actor": null,
|
|
866
|
+
"deprecated": false,
|
|
867
|
+
"http": "POST /v1/workspaces/{workspace_id}/emails/batch",
|
|
868
|
+
"idempotent": true,
|
|
869
|
+
"method": "batch",
|
|
870
|
+
"paginated": false,
|
|
871
|
+
"params": "Mail.EmailBatchParams",
|
|
872
|
+
"poll": null,
|
|
873
|
+
"public": false,
|
|
874
|
+
"resource": "emails",
|
|
875
|
+
"scope": null,
|
|
876
|
+
"signature": "mail.emails.batch(params, options?): Mail.SendBatchOpenApi",
|
|
877
|
+
"snippet": "const sendBatchOpenApi = await mail.emails.batch({\n emails: [{ from: \"Acme <hello@mail.acme.com>\", to: [\"success@simulator.amazonses.com\"] }],\n});"
|
|
878
|
+
},
|
|
879
|
+
"GitHubController_getSyncStatus": {
|
|
880
|
+
"actor": null,
|
|
881
|
+
"deprecated": false,
|
|
882
|
+
"http": "GET /v1/workspaces/{workspace_id}/integrations/github/sync/{sync_id}",
|
|
883
|
+
"idempotent": false,
|
|
884
|
+
"method": "retrieve",
|
|
885
|
+
"paginated": false,
|
|
886
|
+
"params": null,
|
|
887
|
+
"poll": null,
|
|
888
|
+
"public": false,
|
|
889
|
+
"resource": "integrations.github.sync",
|
|
890
|
+
"scope": null,
|
|
891
|
+
"signature": "mail.integrations.github.sync.retrieve(syncId, options?): Mail.SyncStatus",
|
|
892
|
+
"snippet": "const syncStatus = await mail.integrations.github.sync.retrieve(\"sync\");"
|
|
893
|
+
},
|
|
894
|
+
"GitHubController_listBranches": {
|
|
895
|
+
"actor": null,
|
|
896
|
+
"deprecated": false,
|
|
897
|
+
"http": "GET /v1/workspaces/{workspace_id}/integrations/github/repos/{owner}/{repo}/branches",
|
|
898
|
+
"idempotent": false,
|
|
899
|
+
"method": "list",
|
|
900
|
+
"paginated": false,
|
|
901
|
+
"params": null,
|
|
902
|
+
"poll": null,
|
|
903
|
+
"public": false,
|
|
904
|
+
"resource": "integrations.github.repos.branches",
|
|
905
|
+
"scope": null,
|
|
906
|
+
"signature": "mail.integrations.github.repos.branches.list(owner, repo, options?): Mail.IntegrationGithubRepoBranchListResponse",
|
|
907
|
+
"snippet": "const result = await mail.integrations.github.repos.branches.list(\"owner\", \"repo\");"
|
|
908
|
+
},
|
|
909
|
+
"GitHubController_listRepos": {
|
|
910
|
+
"actor": null,
|
|
911
|
+
"deprecated": false,
|
|
912
|
+
"http": "GET /v1/workspaces/{workspace_id}/integrations/github/repos",
|
|
913
|
+
"idempotent": false,
|
|
914
|
+
"method": "list",
|
|
915
|
+
"paginated": false,
|
|
916
|
+
"params": null,
|
|
917
|
+
"poll": null,
|
|
918
|
+
"public": false,
|
|
919
|
+
"resource": "integrations.github.repos",
|
|
920
|
+
"scope": null,
|
|
921
|
+
"signature": "mail.integrations.github.repos.list(options?): Mail.IntegrationGithubRepoListResponse",
|
|
922
|
+
"snippet": "const result = await mail.integrations.github.repos.list();"
|
|
923
|
+
},
|
|
924
|
+
"GitHubController_startSync": {
|
|
925
|
+
"actor": null,
|
|
926
|
+
"deprecated": false,
|
|
927
|
+
"http": "POST /v1/workspaces/{workspace_id}/integrations/github/sync",
|
|
928
|
+
"idempotent": true,
|
|
929
|
+
"method": "create",
|
|
930
|
+
"paginated": false,
|
|
931
|
+
"params": null,
|
|
932
|
+
"poll": null,
|
|
933
|
+
"public": false,
|
|
934
|
+
"resource": "integrations.github.sync",
|
|
935
|
+
"scope": null,
|
|
936
|
+
"signature": "mail.integrations.github.sync.create(options?): Mail.StartSync",
|
|
937
|
+
"snippet": "const startSync = await mail.integrations.github.sync.create();"
|
|
938
|
+
},
|
|
939
|
+
"GitHubController_updateSettings": {
|
|
940
|
+
"actor": null,
|
|
941
|
+
"deprecated": false,
|
|
942
|
+
"http": "PUT /v1/workspaces/{workspace_id}/integrations/github/settings",
|
|
943
|
+
"idempotent": true,
|
|
944
|
+
"method": "update",
|
|
945
|
+
"paginated": false,
|
|
946
|
+
"params": "Mail.IntegrationGithubSettingsUpdateParams",
|
|
947
|
+
"poll": null,
|
|
948
|
+
"public": false,
|
|
949
|
+
"resource": "integrations.github.settings",
|
|
950
|
+
"scope": null,
|
|
951
|
+
"signature": "mail.integrations.github.settings.update(params, options?): void",
|
|
952
|
+
"snippet": "await mail.integrations.github.settings.update({ branch: \"main\", repo_full_name: \"octocat/templates\", templates_path: \"/\" });"
|
|
953
|
+
},
|
|
954
|
+
"GitHubOAuthController_connect": {
|
|
955
|
+
"actor": null,
|
|
956
|
+
"deprecated": false,
|
|
957
|
+
"http": "POST /v1/workspaces/{workspace_id}/integrations/github/connect",
|
|
958
|
+
"idempotent": true,
|
|
959
|
+
"method": "connect",
|
|
960
|
+
"paginated": false,
|
|
961
|
+
"params": "Mail.IntegrationGithubConnectParams",
|
|
962
|
+
"poll": null,
|
|
963
|
+
"public": false,
|
|
964
|
+
"resource": "integrations.github",
|
|
965
|
+
"scope": null,
|
|
966
|
+
"signature": "mail.integrations.github.connect(params, options?): Mail.ConnectGitHub",
|
|
967
|
+
"snippet": "const connectGitHub = await mail.integrations.github.connect({ return_to: \"https://console.productcraft.co/mail/workspaces/acme/integrations\" });"
|
|
968
|
+
},
|
|
969
|
+
"IntegrationsController_disconnect": {
|
|
970
|
+
"actor": null,
|
|
971
|
+
"deprecated": false,
|
|
972
|
+
"http": "DELETE /v1/workspaces/{workspace_id}/integrations/{provider}",
|
|
973
|
+
"idempotent": true,
|
|
974
|
+
"method": "delete",
|
|
975
|
+
"paginated": false,
|
|
976
|
+
"params": null,
|
|
977
|
+
"poll": null,
|
|
978
|
+
"public": false,
|
|
979
|
+
"resource": "integrations",
|
|
980
|
+
"scope": null,
|
|
981
|
+
"signature": "mail.integrations.delete(provider, options?): void",
|
|
982
|
+
"snippet": "await mail.integrations.delete(\"provider\");"
|
|
983
|
+
},
|
|
984
|
+
"IntegrationsController_get": {
|
|
985
|
+
"actor": null,
|
|
986
|
+
"deprecated": false,
|
|
987
|
+
"http": "GET /v1/workspaces/{workspace_id}/integrations/{provider}",
|
|
988
|
+
"idempotent": false,
|
|
989
|
+
"method": "retrieve",
|
|
990
|
+
"paginated": false,
|
|
991
|
+
"params": null,
|
|
992
|
+
"poll": null,
|
|
993
|
+
"public": false,
|
|
994
|
+
"resource": "integrations",
|
|
995
|
+
"scope": null,
|
|
996
|
+
"signature": "mail.integrations.retrieve(provider, options?): Mail.IntegrationDetail",
|
|
997
|
+
"snippet": "const integrationDetail = await mail.integrations.retrieve(\"provider\");"
|
|
998
|
+
},
|
|
999
|
+
"IntegrationsController_list": {
|
|
1000
|
+
"actor": null,
|
|
1001
|
+
"deprecated": false,
|
|
1002
|
+
"http": "GET /v1/workspaces/{workspace_id}/integrations",
|
|
1003
|
+
"idempotent": false,
|
|
1004
|
+
"method": "list",
|
|
1005
|
+
"paginated": false,
|
|
1006
|
+
"params": null,
|
|
1007
|
+
"poll": null,
|
|
1008
|
+
"public": false,
|
|
1009
|
+
"resource": "integrations",
|
|
1010
|
+
"scope": null,
|
|
1011
|
+
"signature": "mail.integrations.list(options?): Mail.ListIntegrations",
|
|
1012
|
+
"snippet": "const listIntegrations = await mail.integrations.list();"
|
|
1013
|
+
},
|
|
1014
|
+
"MailboxController_createMailbox": {
|
|
1015
|
+
"actor": null,
|
|
1016
|
+
"deprecated": false,
|
|
1017
|
+
"http": "POST /v1/workspaces/{workspace_id}/mailboxes",
|
|
1018
|
+
"idempotent": true,
|
|
1019
|
+
"method": "create",
|
|
1020
|
+
"paginated": false,
|
|
1021
|
+
"params": "Mail.MailboxCreateParams",
|
|
1022
|
+
"poll": null,
|
|
1023
|
+
"public": false,
|
|
1024
|
+
"resource": "mailboxes",
|
|
1025
|
+
"scope": null,
|
|
1026
|
+
"signature": "mail.mailboxes.create(params, options?): Mail.Mailbox",
|
|
1027
|
+
"snippet": "const mailbox = await mail.mailboxes.create({ domain_id: \"9b2f6c1e-0d6a-4a63-9a43-2f1c3e4d5a6b\", local_part: \"claude-qa-alpha\" });"
|
|
1028
|
+
},
|
|
1029
|
+
"MailboxController_deleteMailbox": {
|
|
1030
|
+
"actor": null,
|
|
1031
|
+
"deprecated": false,
|
|
1032
|
+
"http": "DELETE /v1/workspaces/{workspace_id}/mailboxes/{id}",
|
|
1033
|
+
"idempotent": false,
|
|
1034
|
+
"method": "delete",
|
|
1035
|
+
"paginated": false,
|
|
1036
|
+
"params": null,
|
|
1037
|
+
"poll": null,
|
|
1038
|
+
"public": false,
|
|
1039
|
+
"resource": "mailboxes",
|
|
1040
|
+
"scope": null,
|
|
1041
|
+
"signature": "mail.mailboxes.delete(id, options?): void",
|
|
1042
|
+
"snippet": "await mail.mailboxes.delete(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
1043
|
+
},
|
|
1044
|
+
"MailboxController_getMailbox": {
|
|
1045
|
+
"actor": null,
|
|
1046
|
+
"deprecated": false,
|
|
1047
|
+
"http": "GET /v1/workspaces/{workspace_id}/mailboxes/{id}",
|
|
1048
|
+
"idempotent": false,
|
|
1049
|
+
"method": "retrieve",
|
|
1050
|
+
"paginated": false,
|
|
1051
|
+
"params": null,
|
|
1052
|
+
"poll": null,
|
|
1053
|
+
"public": false,
|
|
1054
|
+
"resource": "mailboxes",
|
|
1055
|
+
"scope": null,
|
|
1056
|
+
"signature": "mail.mailboxes.retrieve(id, options?): Mail.Mailbox",
|
|
1057
|
+
"snippet": "const mailbox = await mail.mailboxes.retrieve(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
1058
|
+
},
|
|
1059
|
+
"MailboxController_listMailboxes": {
|
|
1060
|
+
"actor": null,
|
|
1061
|
+
"deprecated": false,
|
|
1062
|
+
"http": "GET /v1/workspaces/{workspace_id}/mailboxes",
|
|
1063
|
+
"idempotent": false,
|
|
1064
|
+
"method": "list",
|
|
1065
|
+
"paginated": true,
|
|
1066
|
+
"params": "Mail.MailboxListParams",
|
|
1067
|
+
"poll": null,
|
|
1068
|
+
"public": false,
|
|
1069
|
+
"resource": "mailboxes",
|
|
1070
|
+
"scope": null,
|
|
1071
|
+
"signature": "mail.mailboxes.list(params?, options?): PagePromise<Mail.Mailbox>",
|
|
1072
|
+
"snippet": "for await (const mailbox of mail.mailboxes.list()) {\n console.log(mailbox);\n}\nconst page = await mail.mailboxes.list({}, { timeout: 5_000 });"
|
|
1073
|
+
},
|
|
1074
|
+
"MailboxController_updateMailbox": {
|
|
1075
|
+
"actor": null,
|
|
1076
|
+
"deprecated": false,
|
|
1077
|
+
"http": "PATCH /v1/workspaces/{workspace_id}/mailboxes/{id}",
|
|
1078
|
+
"idempotent": true,
|
|
1079
|
+
"method": "update",
|
|
1080
|
+
"paginated": false,
|
|
1081
|
+
"params": "Mail.MailboxUpdateParams",
|
|
1082
|
+
"poll": null,
|
|
1083
|
+
"public": false,
|
|
1084
|
+
"resource": "mailboxes",
|
|
1085
|
+
"scope": null,
|
|
1086
|
+
"signature": "mail.mailboxes.update(id, params?, options?): Mail.Mailbox",
|
|
1087
|
+
"snippet": "const mailbox = await mail.mailboxes.update(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", { display_name: \"string\" });"
|
|
1088
|
+
},
|
|
1089
|
+
"MessageController_deleteMessage": {
|
|
1090
|
+
"actor": null,
|
|
1091
|
+
"deprecated": false,
|
|
1092
|
+
"http": "DELETE /v1/workspaces/{workspace_id}/mailboxes/{id}/messages/{mid}",
|
|
1093
|
+
"idempotent": false,
|
|
1094
|
+
"method": "delete",
|
|
1095
|
+
"paginated": false,
|
|
1096
|
+
"params": null,
|
|
1097
|
+
"poll": null,
|
|
1098
|
+
"public": false,
|
|
1099
|
+
"resource": "mailboxes.messages",
|
|
1100
|
+
"scope": null,
|
|
1101
|
+
"signature": "mail.mailboxes.messages.delete(id, mid, options?): void",
|
|
1102
|
+
"snippet": "await mail.mailboxes.messages.delete(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\");"
|
|
1103
|
+
},
|
|
1104
|
+
"MessageController_getAttachment": {
|
|
1105
|
+
"actor": null,
|
|
1106
|
+
"deprecated": false,
|
|
1107
|
+
"http": "GET /v1/workspaces/{workspace_id}/mailboxes/{id}/messages/{mid}/attachments/{position}",
|
|
1108
|
+
"idempotent": false,
|
|
1109
|
+
"method": "retrieve",
|
|
1110
|
+
"paginated": false,
|
|
1111
|
+
"params": null,
|
|
1112
|
+
"poll": null,
|
|
1113
|
+
"public": false,
|
|
1114
|
+
"resource": "mailboxes.messages.attachments",
|
|
1115
|
+
"scope": null,
|
|
1116
|
+
"signature": "mail.mailboxes.messages.attachments.retrieve(id, mid, position, options?): Response",
|
|
1117
|
+
"snippet": "const response = await mail.mailboxes.messages.attachments.retrieve(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\", \"position\");\nconst text = await response.text();"
|
|
1118
|
+
},
|
|
1119
|
+
"MessageController_getMessage": {
|
|
1120
|
+
"actor": null,
|
|
1121
|
+
"deprecated": false,
|
|
1122
|
+
"http": "GET /v1/workspaces/{workspace_id}/mailboxes/{id}/messages/{mid}",
|
|
1123
|
+
"idempotent": false,
|
|
1124
|
+
"method": "retrieve",
|
|
1125
|
+
"paginated": false,
|
|
1126
|
+
"params": null,
|
|
1127
|
+
"poll": null,
|
|
1128
|
+
"public": false,
|
|
1129
|
+
"resource": "mailboxes.messages",
|
|
1130
|
+
"scope": null,
|
|
1131
|
+
"signature": "mail.mailboxes.messages.retrieve(id, mid, options?): Mail.MessageDetail",
|
|
1132
|
+
"snippet": "const messageDetail = await mail.mailboxes.messages.retrieve(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\");"
|
|
1133
|
+
},
|
|
1134
|
+
"MessageController_getRaw": {
|
|
1135
|
+
"actor": null,
|
|
1136
|
+
"deprecated": false,
|
|
1137
|
+
"http": "GET /v1/workspaces/{workspace_id}/mailboxes/{id}/messages/{mid}/raw",
|
|
1138
|
+
"idempotent": false,
|
|
1139
|
+
"method": "raw",
|
|
1140
|
+
"paginated": false,
|
|
1141
|
+
"params": null,
|
|
1142
|
+
"poll": null,
|
|
1143
|
+
"public": false,
|
|
1144
|
+
"resource": "mailboxes.messages",
|
|
1145
|
+
"scope": null,
|
|
1146
|
+
"signature": "mail.mailboxes.messages.raw(id, mid, options?): Response",
|
|
1147
|
+
"snippet": "const response = await mail.mailboxes.messages.raw(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\");\nconst text = await response.text();"
|
|
1148
|
+
},
|
|
1149
|
+
"MessageController_listMessages": {
|
|
1150
|
+
"actor": null,
|
|
1151
|
+
"deprecated": false,
|
|
1152
|
+
"http": "GET /v1/workspaces/{workspace_id}/mailboxes/{id}/messages",
|
|
1153
|
+
"idempotent": false,
|
|
1154
|
+
"method": "list",
|
|
1155
|
+
"paginated": true,
|
|
1156
|
+
"params": "Mail.MailboxMessageListParams",
|
|
1157
|
+
"poll": null,
|
|
1158
|
+
"public": false,
|
|
1159
|
+
"resource": "mailboxes.messages",
|
|
1160
|
+
"scope": null,
|
|
1161
|
+
"signature": "mail.mailboxes.messages.list(id, params?, options?): PagePromise<Mail.Message>",
|
|
1162
|
+
"snippet": "for await (const message of mail.mailboxes.messages.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\")) {\n console.log(message);\n}\nconst page = await mail.mailboxes.messages.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", {}, { timeout: 5_000 });"
|
|
1163
|
+
},
|
|
1164
|
+
"MessageController_markRead": {
|
|
1165
|
+
"actor": null,
|
|
1166
|
+
"deprecated": false,
|
|
1167
|
+
"http": "POST /v1/workspaces/{workspace_id}/mailboxes/{id}/messages/{mid}/read",
|
|
1168
|
+
"idempotent": false,
|
|
1169
|
+
"method": "read",
|
|
1170
|
+
"paginated": false,
|
|
1171
|
+
"params": null,
|
|
1172
|
+
"poll": null,
|
|
1173
|
+
"public": false,
|
|
1174
|
+
"resource": "mailboxes.messages",
|
|
1175
|
+
"scope": null,
|
|
1176
|
+
"signature": "mail.mailboxes.messages.read(id, mid, options?): void",
|
|
1177
|
+
"snippet": "await mail.mailboxes.messages.read(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\");"
|
|
1178
|
+
},
|
|
1179
|
+
"MessageTimelineController_getTimeline": {
|
|
1180
|
+
"actor": null,
|
|
1181
|
+
"deprecated": false,
|
|
1182
|
+
"http": "GET /v1/workspaces/{workspace_id}/messages/timeline",
|
|
1183
|
+
"idempotent": false,
|
|
1184
|
+
"method": "timeline",
|
|
1185
|
+
"paginated": false,
|
|
1186
|
+
"params": "Mail.MessageTimelineParams",
|
|
1187
|
+
"poll": null,
|
|
1188
|
+
"public": false,
|
|
1189
|
+
"resource": "messages",
|
|
1190
|
+
"scope": null,
|
|
1191
|
+
"signature": "mail.messages.timeline(params, options?): Mail.MessageTimeline",
|
|
1192
|
+
"snippet": "const messageTimeline = await mail.messages.timeline({ granularity: \"day\", since: \"2026-04-01T00:00:00Z\", until: \"2026-05-01T00:00:00Z\" });"
|
|
1193
|
+
},
|
|
1194
|
+
"OutboundMessageController_deleteByRecipient": {
|
|
1195
|
+
"actor": null,
|
|
1196
|
+
"deprecated": false,
|
|
1197
|
+
"http": "DELETE /v1/workspaces/{workspace_id}/messages",
|
|
1198
|
+
"idempotent": false,
|
|
1199
|
+
"method": "erase",
|
|
1200
|
+
"paginated": false,
|
|
1201
|
+
"params": "Mail.MessageEraseParams",
|
|
1202
|
+
"poll": null,
|
|
1203
|
+
"public": false,
|
|
1204
|
+
"resource": "messages",
|
|
1205
|
+
"scope": null,
|
|
1206
|
+
"signature": "mail.messages.erase(params, options?): Mail.DeleteByRecipient",
|
|
1207
|
+
"snippet": "const deleteByRecipient = await mail.messages.erase({ recipient: \"ada@example.com\" });"
|
|
1208
|
+
},
|
|
1209
|
+
"OutboundMessageController_exportCsv": {
|
|
1210
|
+
"actor": null,
|
|
1211
|
+
"deprecated": false,
|
|
1212
|
+
"http": "GET /v1/workspaces/{workspace_id}/messages/export",
|
|
1213
|
+
"idempotent": false,
|
|
1214
|
+
"method": "export",
|
|
1215
|
+
"paginated": false,
|
|
1216
|
+
"params": "Mail.MessageExportParams",
|
|
1217
|
+
"poll": null,
|
|
1218
|
+
"public": false,
|
|
1219
|
+
"resource": "messages",
|
|
1220
|
+
"scope": null,
|
|
1221
|
+
"signature": "mail.messages.export(params?, options?): Response",
|
|
1222
|
+
"snippet": "const response = await mail.messages.export();\nconst text = await response.text();"
|
|
1223
|
+
},
|
|
1224
|
+
"OutboundMessageController_get": {
|
|
1225
|
+
"actor": null,
|
|
1226
|
+
"deprecated": false,
|
|
1227
|
+
"http": "GET /v1/workspaces/{workspace_id}/messages/{id}",
|
|
1228
|
+
"idempotent": false,
|
|
1229
|
+
"method": "retrieve",
|
|
1230
|
+
"paginated": false,
|
|
1231
|
+
"params": null,
|
|
1232
|
+
"poll": null,
|
|
1233
|
+
"public": false,
|
|
1234
|
+
"resource": "messages",
|
|
1235
|
+
"scope": null,
|
|
1236
|
+
"signature": "mail.messages.retrieve(id, options?): Mail.OutboundMessageDetail",
|
|
1237
|
+
"snippet": "const outboundMessageDetail = await mail.messages.retrieve(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
1238
|
+
},
|
|
1239
|
+
"OutboundMessageController_getBody": {
|
|
1240
|
+
"actor": null,
|
|
1241
|
+
"deprecated": false,
|
|
1242
|
+
"http": "GET /v1/workspaces/{workspace_id}/messages/{id}/body",
|
|
1243
|
+
"idempotent": false,
|
|
1244
|
+
"method": "body",
|
|
1245
|
+
"paginated": false,
|
|
1246
|
+
"params": null,
|
|
1247
|
+
"poll": null,
|
|
1248
|
+
"public": false,
|
|
1249
|
+
"resource": "messages",
|
|
1250
|
+
"scope": null,
|
|
1251
|
+
"signature": "mail.messages.body(id, options?): Mail.OutboundMessageWithBody",
|
|
1252
|
+
"snippet": "const outboundMessageWithBody = await mail.messages.body(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
1253
|
+
},
|
|
1254
|
+
"OutboundMessageController_getSettings": {
|
|
1255
|
+
"actor": null,
|
|
1256
|
+
"deprecated": false,
|
|
1257
|
+
"http": "GET /v1/workspaces/{workspace_id}/messages/settings",
|
|
1258
|
+
"idempotent": false,
|
|
1259
|
+
"method": "retrieve",
|
|
1260
|
+
"paginated": false,
|
|
1261
|
+
"params": null,
|
|
1262
|
+
"poll": null,
|
|
1263
|
+
"public": false,
|
|
1264
|
+
"resource": "messages.settings",
|
|
1265
|
+
"scope": null,
|
|
1266
|
+
"signature": "mail.messages.settings.retrieve(options?): Mail.OutboundMessageSettings",
|
|
1267
|
+
"snippet": "const outboundMessageSettings = await mail.messages.settings.retrieve();"
|
|
1268
|
+
},
|
|
1269
|
+
"OutboundMessageController_list": {
|
|
1270
|
+
"actor": null,
|
|
1271
|
+
"deprecated": false,
|
|
1272
|
+
"http": "GET /v1/workspaces/{workspace_id}/messages",
|
|
1273
|
+
"idempotent": false,
|
|
1274
|
+
"method": "list",
|
|
1275
|
+
"paginated": true,
|
|
1276
|
+
"params": "Mail.MessageListParams",
|
|
1277
|
+
"poll": null,
|
|
1278
|
+
"public": false,
|
|
1279
|
+
"resource": "messages",
|
|
1280
|
+
"scope": null,
|
|
1281
|
+
"signature": "mail.messages.list(params?, options?): PagePromise<Mail.OutboundMessage>",
|
|
1282
|
+
"snippet": "for await (const message of mail.messages.list()) {\n console.log(message);\n}\nconst page = await mail.messages.list({}, { timeout: 5_000 });"
|
|
1283
|
+
},
|
|
1284
|
+
"OutboundMessageController_updateSettings": {
|
|
1285
|
+
"actor": null,
|
|
1286
|
+
"deprecated": false,
|
|
1287
|
+
"http": "PATCH /v1/workspaces/{workspace_id}/messages/settings",
|
|
1288
|
+
"idempotent": true,
|
|
1289
|
+
"method": "update",
|
|
1290
|
+
"paginated": false,
|
|
1291
|
+
"params": "Mail.MessageSettingsUpdateParams",
|
|
1292
|
+
"poll": null,
|
|
1293
|
+
"public": false,
|
|
1294
|
+
"resource": "messages.settings",
|
|
1295
|
+
"scope": null,
|
|
1296
|
+
"signature": "mail.messages.settings.update(params, options?): Mail.OutboundMessageSettings",
|
|
1297
|
+
"snippet": "const outboundMessageSettings = await mail.messages.settings.update({ redact_bodies: true });"
|
|
1298
|
+
},
|
|
1299
|
+
"OutboundWebhookController_listAttempts": {
|
|
1300
|
+
"actor": null,
|
|
1301
|
+
"deprecated": false,
|
|
1302
|
+
"http": "GET /v1/workspaces/{workspace_id}/webhooks/attempts",
|
|
1303
|
+
"idempotent": false,
|
|
1304
|
+
"method": "list",
|
|
1305
|
+
"paginated": true,
|
|
1306
|
+
"params": "Mail.WebhookAttemptListParams",
|
|
1307
|
+
"poll": null,
|
|
1308
|
+
"public": false,
|
|
1309
|
+
"resource": "webhooks.attempts",
|
|
1310
|
+
"scope": null,
|
|
1311
|
+
"signature": "mail.webhooks.attempts.list(params?, options?): PagePromise<Mail.OutboundWebhookAttempt>",
|
|
1312
|
+
"snippet": "for await (const attempt of mail.webhooks.attempts.list()) {\n console.log(attempt);\n}\nconst page = await mail.webhooks.attempts.list({}, { timeout: 5_000 });"
|
|
1313
|
+
},
|
|
1314
|
+
"ReceivedController_exportCsv": {
|
|
1315
|
+
"actor": null,
|
|
1316
|
+
"deprecated": false,
|
|
1317
|
+
"http": "GET /v1/workspaces/{workspace_id}/received/export",
|
|
1318
|
+
"idempotent": false,
|
|
1319
|
+
"method": "export",
|
|
1320
|
+
"paginated": false,
|
|
1321
|
+
"params": "Mail.ReceivedExportParams",
|
|
1322
|
+
"poll": null,
|
|
1323
|
+
"public": false,
|
|
1324
|
+
"resource": "received",
|
|
1325
|
+
"scope": null,
|
|
1326
|
+
"signature": "mail.received.export(params?, options?): Response",
|
|
1327
|
+
"snippet": "const response = await mail.received.export();\nconst text = await response.text();"
|
|
1328
|
+
},
|
|
1329
|
+
"ReceivedController_get": {
|
|
1330
|
+
"actor": null,
|
|
1331
|
+
"deprecated": false,
|
|
1332
|
+
"http": "GET /v1/workspaces/{workspace_id}/received/{id}",
|
|
1333
|
+
"idempotent": false,
|
|
1334
|
+
"method": "retrieve",
|
|
1335
|
+
"paginated": false,
|
|
1336
|
+
"params": null,
|
|
1337
|
+
"poll": null,
|
|
1338
|
+
"public": false,
|
|
1339
|
+
"resource": "received",
|
|
1340
|
+
"scope": null,
|
|
1341
|
+
"signature": "mail.received.retrieve(id, options?): Mail.ReceivedEmailDetail",
|
|
1342
|
+
"snippet": "const receivedEmailDetail = await mail.received.retrieve(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
1343
|
+
},
|
|
1344
|
+
"ReceivedController_getAttachment": {
|
|
1345
|
+
"actor": null,
|
|
1346
|
+
"deprecated": false,
|
|
1347
|
+
"http": "GET /v1/workspaces/{workspace_id}/received/{id}/attachments/{position}",
|
|
1348
|
+
"idempotent": false,
|
|
1349
|
+
"method": "retrieve",
|
|
1350
|
+
"paginated": false,
|
|
1351
|
+
"params": null,
|
|
1352
|
+
"poll": null,
|
|
1353
|
+
"public": false,
|
|
1354
|
+
"resource": "received.attachments",
|
|
1355
|
+
"scope": null,
|
|
1356
|
+
"signature": "mail.received.attachments.retrieve(id, position, options?): Response",
|
|
1357
|
+
"snippet": "const response = await mail.received.attachments.retrieve(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"position\");\nconst text = await response.text();"
|
|
1358
|
+
},
|
|
1359
|
+
"ReceivedController_getRaw": {
|
|
1360
|
+
"actor": null,
|
|
1361
|
+
"deprecated": false,
|
|
1362
|
+
"http": "GET /v1/workspaces/{workspace_id}/received/{id}/raw",
|
|
1363
|
+
"idempotent": false,
|
|
1364
|
+
"method": "raw",
|
|
1365
|
+
"paginated": false,
|
|
1366
|
+
"params": null,
|
|
1367
|
+
"poll": null,
|
|
1368
|
+
"public": false,
|
|
1369
|
+
"resource": "received",
|
|
1370
|
+
"scope": null,
|
|
1371
|
+
"signature": "mail.received.raw(id, options?): Response",
|
|
1372
|
+
"snippet": "const response = await mail.received.raw(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");\nconst text = await response.text();"
|
|
1373
|
+
},
|
|
1374
|
+
"ReceivedController_list": {
|
|
1375
|
+
"actor": null,
|
|
1376
|
+
"deprecated": false,
|
|
1377
|
+
"http": "GET /v1/workspaces/{workspace_id}/received",
|
|
1378
|
+
"idempotent": false,
|
|
1379
|
+
"method": "list",
|
|
1380
|
+
"paginated": true,
|
|
1381
|
+
"params": "Mail.ReceivedListParams",
|
|
1382
|
+
"poll": null,
|
|
1383
|
+
"public": false,
|
|
1384
|
+
"resource": "received",
|
|
1385
|
+
"scope": null,
|
|
1386
|
+
"signature": "mail.received.list(params?, options?): PagePromise<Mail.ReceivedEmail>",
|
|
1387
|
+
"snippet": "for await (const received of mail.received.list()) {\n console.log(received);\n}\nconst page = await mail.received.list({}, { timeout: 5_000 });"
|
|
1388
|
+
},
|
|
1389
|
+
"ReceivedController_markRead": {
|
|
1390
|
+
"actor": null,
|
|
1391
|
+
"deprecated": false,
|
|
1392
|
+
"http": "POST /v1/workspaces/{workspace_id}/received/{id}/read",
|
|
1393
|
+
"idempotent": false,
|
|
1394
|
+
"method": "read",
|
|
1395
|
+
"paginated": false,
|
|
1396
|
+
"params": null,
|
|
1397
|
+
"poll": null,
|
|
1398
|
+
"public": false,
|
|
1399
|
+
"resource": "received",
|
|
1400
|
+
"scope": null,
|
|
1401
|
+
"signature": "mail.received.read(id, options?): void",
|
|
1402
|
+
"snippet": "await mail.received.read(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
1403
|
+
},
|
|
1404
|
+
"ReceivedController_remove": {
|
|
1405
|
+
"actor": null,
|
|
1406
|
+
"deprecated": false,
|
|
1407
|
+
"http": "DELETE /v1/workspaces/{workspace_id}/received/{id}",
|
|
1408
|
+
"idempotent": false,
|
|
1409
|
+
"method": "delete",
|
|
1410
|
+
"paginated": false,
|
|
1411
|
+
"params": null,
|
|
1412
|
+
"poll": null,
|
|
1413
|
+
"public": false,
|
|
1414
|
+
"resource": "received",
|
|
1415
|
+
"scope": null,
|
|
1416
|
+
"signature": "mail.received.delete(id, options?): void",
|
|
1417
|
+
"snippet": "await mail.received.delete(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
1418
|
+
},
|
|
1419
|
+
"SegmentsController_contacts": {
|
|
1420
|
+
"actor": null,
|
|
1421
|
+
"deprecated": false,
|
|
1422
|
+
"http": "GET /v1/workspaces/{workspace_id}/segments/{segment_id}/contacts",
|
|
1423
|
+
"idempotent": false,
|
|
1424
|
+
"method": "list",
|
|
1425
|
+
"paginated": true,
|
|
1426
|
+
"params": "Mail.SegmentContactListParams",
|
|
1427
|
+
"poll": null,
|
|
1428
|
+
"public": false,
|
|
1429
|
+
"resource": "segments.contacts",
|
|
1430
|
+
"scope": null,
|
|
1431
|
+
"signature": "mail.segments.contacts.list(segmentId, params?, options?): PagePromise<Mail.Contact>",
|
|
1432
|
+
"snippet": "for await (const contact of mail.segments.contacts.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\")) {\n console.log(contact);\n}\nconst page = await mail.segments.contacts.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", {}, { timeout: 5_000 });"
|
|
1433
|
+
},
|
|
1434
|
+
"SegmentsController_create": {
|
|
1435
|
+
"actor": null,
|
|
1436
|
+
"deprecated": false,
|
|
1437
|
+
"http": "POST /v1/workspaces/{workspace_id}/segments",
|
|
1438
|
+
"idempotent": true,
|
|
1439
|
+
"method": "create",
|
|
1440
|
+
"paginated": false,
|
|
1441
|
+
"params": "Mail.SegmentCreateParams",
|
|
1442
|
+
"poll": null,
|
|
1443
|
+
"public": false,
|
|
1444
|
+
"resource": "segments",
|
|
1445
|
+
"scope": null,
|
|
1446
|
+
"signature": "mail.segments.create(params, options?): Mail.Segment",
|
|
1447
|
+
"snippet": "const segment = await mail.segments.create({ name: \"Pro customers\" });"
|
|
1448
|
+
},
|
|
1449
|
+
"SegmentsController_get": {
|
|
1450
|
+
"actor": null,
|
|
1451
|
+
"deprecated": false,
|
|
1452
|
+
"http": "GET /v1/workspaces/{workspace_id}/segments/{segment_id}",
|
|
1453
|
+
"idempotent": false,
|
|
1454
|
+
"method": "retrieve",
|
|
1455
|
+
"paginated": false,
|
|
1456
|
+
"params": null,
|
|
1457
|
+
"poll": null,
|
|
1458
|
+
"public": false,
|
|
1459
|
+
"resource": "segments",
|
|
1460
|
+
"scope": null,
|
|
1461
|
+
"signature": "mail.segments.retrieve(segmentId, options?): Mail.Segment",
|
|
1462
|
+
"snippet": "const segment = await mail.segments.retrieve(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
1463
|
+
},
|
|
1464
|
+
"SegmentsController_list": {
|
|
1465
|
+
"actor": null,
|
|
1466
|
+
"deprecated": false,
|
|
1467
|
+
"http": "GET /v1/workspaces/{workspace_id}/segments",
|
|
1468
|
+
"idempotent": false,
|
|
1469
|
+
"method": "list",
|
|
1470
|
+
"paginated": true,
|
|
1471
|
+
"params": "Mail.SegmentListParams",
|
|
1472
|
+
"poll": null,
|
|
1473
|
+
"public": false,
|
|
1474
|
+
"resource": "segments",
|
|
1475
|
+
"scope": null,
|
|
1476
|
+
"signature": "mail.segments.list(params?, options?): PagePromise<Mail.Segment>",
|
|
1477
|
+
"snippet": "for await (const segment of mail.segments.list()) {\n console.log(segment);\n}\nconst page = await mail.segments.list({}, { timeout: 5_000 });"
|
|
1478
|
+
},
|
|
1479
|
+
"SegmentsController_metrics": {
|
|
1480
|
+
"actor": null,
|
|
1481
|
+
"deprecated": false,
|
|
1482
|
+
"http": "GET /v1/workspaces/{workspace_id}/segments/{segment_id}/metrics",
|
|
1483
|
+
"idempotent": false,
|
|
1484
|
+
"method": "metrics",
|
|
1485
|
+
"paginated": false,
|
|
1486
|
+
"params": null,
|
|
1487
|
+
"poll": null,
|
|
1488
|
+
"public": false,
|
|
1489
|
+
"resource": "segments",
|
|
1490
|
+
"scope": null,
|
|
1491
|
+
"signature": "mail.segments.metrics(segmentId, options?): Mail.SegmentMetrics",
|
|
1492
|
+
"snippet": "const segmentMetrics = await mail.segments.metrics(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
1493
|
+
},
|
|
1494
|
+
"SegmentsController_preview": {
|
|
1495
|
+
"actor": null,
|
|
1496
|
+
"deprecated": false,
|
|
1497
|
+
"http": "POST /v1/workspaces/{workspace_id}/segments/preview",
|
|
1498
|
+
"idempotent": false,
|
|
1499
|
+
"method": "preview",
|
|
1500
|
+
"paginated": false,
|
|
1501
|
+
"params": "Mail.SegmentPreviewParams",
|
|
1502
|
+
"poll": null,
|
|
1503
|
+
"public": false,
|
|
1504
|
+
"resource": "segments",
|
|
1505
|
+
"scope": null,
|
|
1506
|
+
"signature": "mail.segments.preview(params, options?): Mail.SegmentPreview",
|
|
1507
|
+
"snippet": "const segmentPreview = await mail.segments.preview({ rule: { conditions: [{ field: \"plan\", operator: \"equals\" }], match: \"all\" } });"
|
|
1508
|
+
},
|
|
1509
|
+
"SegmentsController_remove": {
|
|
1510
|
+
"actor": null,
|
|
1511
|
+
"deprecated": false,
|
|
1512
|
+
"http": "DELETE /v1/workspaces/{workspace_id}/segments/{segment_id}",
|
|
1513
|
+
"idempotent": false,
|
|
1514
|
+
"method": "delete",
|
|
1515
|
+
"paginated": false,
|
|
1516
|
+
"params": null,
|
|
1517
|
+
"poll": null,
|
|
1518
|
+
"public": false,
|
|
1519
|
+
"resource": "segments",
|
|
1520
|
+
"scope": null,
|
|
1521
|
+
"signature": "mail.segments.delete(segmentId, options?): void",
|
|
1522
|
+
"snippet": "await mail.segments.delete(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
1523
|
+
},
|
|
1524
|
+
"SegmentsController_update": {
|
|
1525
|
+
"actor": null,
|
|
1526
|
+
"deprecated": false,
|
|
1527
|
+
"http": "PATCH /v1/workspaces/{workspace_id}/segments/{segment_id}",
|
|
1528
|
+
"idempotent": true,
|
|
1529
|
+
"method": "update",
|
|
1530
|
+
"paginated": false,
|
|
1531
|
+
"params": "Mail.SegmentUpdateParams",
|
|
1532
|
+
"poll": null,
|
|
1533
|
+
"public": false,
|
|
1534
|
+
"resource": "segments",
|
|
1535
|
+
"scope": null,
|
|
1536
|
+
"signature": "mail.segments.update(segmentId, params?, options?): Mail.Segment",
|
|
1537
|
+
"snippet": "const segment = await mail.segments.update(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", { description: \"string\" });"
|
|
1538
|
+
},
|
|
1539
|
+
"SendingDefaultsController_get": {
|
|
1540
|
+
"actor": null,
|
|
1541
|
+
"deprecated": false,
|
|
1542
|
+
"http": "GET /v1/workspaces/{workspace_id}/sending-defaults",
|
|
1543
|
+
"idempotent": false,
|
|
1544
|
+
"method": "retrieve",
|
|
1545
|
+
"paginated": false,
|
|
1546
|
+
"params": null,
|
|
1547
|
+
"poll": null,
|
|
1548
|
+
"public": false,
|
|
1549
|
+
"resource": "sendingDefaults",
|
|
1550
|
+
"scope": null,
|
|
1551
|
+
"signature": "mail.sendingDefaults.retrieve(options?): Mail.SendingDefaults",
|
|
1552
|
+
"snippet": "const sendingDefaults = await mail.sendingDefaults.retrieve();"
|
|
1553
|
+
},
|
|
1554
|
+
"SendingDefaultsController_put": {
|
|
1555
|
+
"actor": null,
|
|
1556
|
+
"deprecated": false,
|
|
1557
|
+
"http": "PUT /v1/workspaces/{workspace_id}/sending-defaults",
|
|
1558
|
+
"idempotent": false,
|
|
1559
|
+
"method": "update",
|
|
1560
|
+
"paginated": false,
|
|
1561
|
+
"params": "Mail.SendingDefaultUpdateParams",
|
|
1562
|
+
"poll": null,
|
|
1563
|
+
"public": false,
|
|
1564
|
+
"resource": "sendingDefaults",
|
|
1565
|
+
"scope": null,
|
|
1566
|
+
"signature": "mail.sendingDefaults.update(params, options?): Mail.SendingDefaults",
|
|
1567
|
+
"snippet": "const sendingDefaults = await mail.sendingDefaults.update({ address: \"Acme <hello@acme.com>\" });"
|
|
1568
|
+
},
|
|
1569
|
+
"ShareLinkController_create": {
|
|
1570
|
+
"actor": null,
|
|
1571
|
+
"deprecated": false,
|
|
1572
|
+
"http": "POST /v1/workspaces/{workspace_id}/domains/{domain_id}/share-links",
|
|
1573
|
+
"idempotent": true,
|
|
1574
|
+
"method": "create",
|
|
1575
|
+
"paginated": false,
|
|
1576
|
+
"params": "Mail.DomainShareLinkCreateParams",
|
|
1577
|
+
"poll": null,
|
|
1578
|
+
"public": false,
|
|
1579
|
+
"resource": "domains.shareLinks",
|
|
1580
|
+
"scope": null,
|
|
1581
|
+
"signature": "mail.domains.shareLinks.create(domainId, params?, options?): Mail.CreatedShareLink",
|
|
1582
|
+
"snippet": "const createdShareLink = await mail.domains.shareLinks.create(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", { email_to: [\"it@example.com\"] });"
|
|
1583
|
+
},
|
|
1584
|
+
"ShareLinkController_list": {
|
|
1585
|
+
"actor": null,
|
|
1586
|
+
"deprecated": false,
|
|
1587
|
+
"http": "GET /v1/workspaces/{workspace_id}/domains/{domain_id}/share-links",
|
|
1588
|
+
"idempotent": false,
|
|
1589
|
+
"method": "list",
|
|
1590
|
+
"paginated": true,
|
|
1591
|
+
"params": "Mail.DomainShareLinkListParams",
|
|
1592
|
+
"poll": null,
|
|
1593
|
+
"public": false,
|
|
1594
|
+
"resource": "domains.shareLinks",
|
|
1595
|
+
"scope": null,
|
|
1596
|
+
"signature": "mail.domains.shareLinks.list(domainId, params?, options?): PagePromise<Mail.ShareLink>",
|
|
1597
|
+
"snippet": "for await (const shareLink of mail.domains.shareLinks.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\")) {\n console.log(shareLink);\n}\nconst page = await mail.domains.shareLinks.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", {}, { timeout: 5_000 });"
|
|
1598
|
+
},
|
|
1599
|
+
"ShareLinkController_revoke": {
|
|
1600
|
+
"actor": null,
|
|
1601
|
+
"deprecated": false,
|
|
1602
|
+
"http": "DELETE /v1/workspaces/{workspace_id}/domains/{domain_id}/share-links/{link_id}",
|
|
1603
|
+
"idempotent": false,
|
|
1604
|
+
"method": "delete",
|
|
1605
|
+
"paginated": false,
|
|
1606
|
+
"params": null,
|
|
1607
|
+
"poll": null,
|
|
1608
|
+
"public": false,
|
|
1609
|
+
"resource": "domains.shareLinks",
|
|
1610
|
+
"scope": null,
|
|
1611
|
+
"signature": "mail.domains.shareLinks.delete(domainId, linkId, options?): void",
|
|
1612
|
+
"snippet": "await mail.domains.shareLinks.delete(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\");"
|
|
1613
|
+
},
|
|
1614
|
+
"SmtpConfigController_delete": {
|
|
1615
|
+
"actor": null,
|
|
1616
|
+
"deprecated": false,
|
|
1617
|
+
"http": "DELETE /v1/workspaces/{workspace_id}/smtp-config",
|
|
1618
|
+
"idempotent": false,
|
|
1619
|
+
"method": "reset",
|
|
1620
|
+
"paginated": false,
|
|
1621
|
+
"params": null,
|
|
1622
|
+
"poll": null,
|
|
1623
|
+
"public": false,
|
|
1624
|
+
"resource": "smtpConfig",
|
|
1625
|
+
"scope": null,
|
|
1626
|
+
"signature": "mail.smtpConfig.reset(options?): void",
|
|
1627
|
+
"snippet": "await mail.smtpConfig.reset();"
|
|
1628
|
+
},
|
|
1629
|
+
"SmtpConfigController_get": {
|
|
1630
|
+
"actor": null,
|
|
1631
|
+
"deprecated": false,
|
|
1632
|
+
"http": "GET /v1/workspaces/{workspace_id}/smtp-config",
|
|
1633
|
+
"idempotent": false,
|
|
1634
|
+
"method": "retrieve",
|
|
1635
|
+
"paginated": false,
|
|
1636
|
+
"params": null,
|
|
1637
|
+
"poll": null,
|
|
1638
|
+
"public": false,
|
|
1639
|
+
"resource": "smtpConfig",
|
|
1640
|
+
"scope": null,
|
|
1641
|
+
"signature": "mail.smtpConfig.retrieve(options?): Mail.GetSmtpConfig",
|
|
1642
|
+
"snippet": "const getSmtpConfig = await mail.smtpConfig.retrieve();"
|
|
1643
|
+
},
|
|
1644
|
+
"SmtpConfigController_upsert": {
|
|
1645
|
+
"actor": null,
|
|
1646
|
+
"deprecated": false,
|
|
1647
|
+
"http": "PUT /v1/workspaces/{workspace_id}/smtp-config",
|
|
1648
|
+
"idempotent": true,
|
|
1649
|
+
"method": "update",
|
|
1650
|
+
"paginated": false,
|
|
1651
|
+
"params": "Mail.SmtpConfigUpdateParams",
|
|
1652
|
+
"poll": null,
|
|
1653
|
+
"public": false,
|
|
1654
|
+
"resource": "smtpConfig",
|
|
1655
|
+
"scope": null,
|
|
1656
|
+
"signature": "mail.smtpConfig.update(params, options?): Mail.SmtpConfig",
|
|
1657
|
+
"snippet": "const smtpConfig = await mail.smtpConfig.update({\n from_email: \"noreply@acme.com\",\n from_name: \"Acme Notifications\",\n host: \"smtp.sendgrid.net\",\n port: 587,\n secure: false,\n});"
|
|
1658
|
+
},
|
|
1659
|
+
"SmtpConfigController_verifySaved": {
|
|
1660
|
+
"actor": null,
|
|
1661
|
+
"deprecated": false,
|
|
1662
|
+
"http": "POST /v1/workspaces/{workspace_id}/smtp-config/verify-saved",
|
|
1663
|
+
"idempotent": false,
|
|
1664
|
+
"method": "verifySaved",
|
|
1665
|
+
"paginated": false,
|
|
1666
|
+
"params": null,
|
|
1667
|
+
"poll": null,
|
|
1668
|
+
"public": false,
|
|
1669
|
+
"resource": "smtpConfig",
|
|
1670
|
+
"scope": null,
|
|
1671
|
+
"signature": "mail.smtpConfig.verifySaved(options?): Mail.SmtpVerifyResult",
|
|
1672
|
+
"snippet": "const smtpVerifyResult = await mail.smtpConfig.verifySaved();"
|
|
1673
|
+
},
|
|
1674
|
+
"SmtpConfigController_verifyTransient": {
|
|
1675
|
+
"actor": null,
|
|
1676
|
+
"deprecated": false,
|
|
1677
|
+
"http": "POST /v1/workspaces/{workspace_id}/smtp-config/verify",
|
|
1678
|
+
"idempotent": false,
|
|
1679
|
+
"method": "verify",
|
|
1680
|
+
"paginated": false,
|
|
1681
|
+
"params": "Mail.SmtpConfigVerifyParams",
|
|
1682
|
+
"poll": null,
|
|
1683
|
+
"public": false,
|
|
1684
|
+
"resource": "smtpConfig",
|
|
1685
|
+
"scope": null,
|
|
1686
|
+
"signature": "mail.smtpConfig.verify(params, options?): Mail.SmtpVerifyResult",
|
|
1687
|
+
"snippet": "const smtpVerifyResult = await mail.smtpConfig.verify({\n from_email: \"noreply@acme.com\",\n from_name: \"Acme Notifications\",\n host: \"smtp.sendgrid.net\",\n port: 587,\n secure: false,\n});"
|
|
1688
|
+
},
|
|
1689
|
+
"SmtpConfigListController_list": {
|
|
1690
|
+
"actor": null,
|
|
1691
|
+
"deprecated": false,
|
|
1692
|
+
"http": "GET /v1/workspaces/{workspace_id}/smtp-configs",
|
|
1693
|
+
"idempotent": false,
|
|
1694
|
+
"method": "list",
|
|
1695
|
+
"paginated": false,
|
|
1696
|
+
"params": null,
|
|
1697
|
+
"poll": null,
|
|
1698
|
+
"public": false,
|
|
1699
|
+
"resource": "smtpConfig",
|
|
1700
|
+
"scope": null,
|
|
1701
|
+
"signature": "mail.smtpConfig.list(options?): Mail.ListSmtpConfigs",
|
|
1702
|
+
"snippet": "const listSmtpConfigs = await mail.smtpConfig.list();"
|
|
1703
|
+
},
|
|
1704
|
+
"SuppressionController_add": {
|
|
1705
|
+
"actor": null,
|
|
1706
|
+
"deprecated": false,
|
|
1707
|
+
"http": "POST /v1/workspaces/{workspace_id}/suppression",
|
|
1708
|
+
"idempotent": true,
|
|
1709
|
+
"method": "create",
|
|
1710
|
+
"paginated": false,
|
|
1711
|
+
"params": "Mail.SuppressionCreateParams",
|
|
1712
|
+
"poll": null,
|
|
1713
|
+
"public": false,
|
|
1714
|
+
"resource": "suppression",
|
|
1715
|
+
"scope": null,
|
|
1716
|
+
"signature": "mail.suppression.create(params, options?): Mail.SuppressionEntry",
|
|
1717
|
+
"snippet": "const suppressionEntry = await mail.suppression.create({ email: \"bounced@example.com\" });"
|
|
1718
|
+
},
|
|
1719
|
+
"SuppressionController_list": {
|
|
1720
|
+
"actor": null,
|
|
1721
|
+
"deprecated": false,
|
|
1722
|
+
"http": "GET /v1/workspaces/{workspace_id}/suppression",
|
|
1723
|
+
"idempotent": false,
|
|
1724
|
+
"method": "list",
|
|
1725
|
+
"paginated": true,
|
|
1726
|
+
"params": "Mail.SuppressionListParams",
|
|
1727
|
+
"poll": null,
|
|
1728
|
+
"public": false,
|
|
1729
|
+
"resource": "suppression",
|
|
1730
|
+
"scope": null,
|
|
1731
|
+
"signature": "mail.suppression.list(params?, options?): PagePromise<Mail.SuppressionEntry>",
|
|
1732
|
+
"snippet": "for await (const suppression of mail.suppression.list()) {\n console.log(suppression);\n}\nconst page = await mail.suppression.list({}, { timeout: 5_000 });"
|
|
1733
|
+
},
|
|
1734
|
+
"SuppressionController_remove": {
|
|
1735
|
+
"actor": null,
|
|
1736
|
+
"deprecated": false,
|
|
1737
|
+
"http": "DELETE /v1/workspaces/{workspace_id}/suppression/{email}",
|
|
1738
|
+
"idempotent": false,
|
|
1739
|
+
"method": "delete",
|
|
1740
|
+
"paginated": false,
|
|
1741
|
+
"params": null,
|
|
1742
|
+
"poll": null,
|
|
1743
|
+
"public": false,
|
|
1744
|
+
"resource": "suppression",
|
|
1745
|
+
"scope": null,
|
|
1746
|
+
"signature": "mail.suppression.delete(email, options?): void",
|
|
1747
|
+
"snippet": "await mail.suppression.delete(\"email\");"
|
|
1748
|
+
},
|
|
1749
|
+
"TemplateController_delete": {
|
|
1750
|
+
"actor": null,
|
|
1751
|
+
"deprecated": false,
|
|
1752
|
+
"http": "DELETE /v1/workspaces/{workspace_id}/templates/{name}",
|
|
1753
|
+
"idempotent": false,
|
|
1754
|
+
"method": "delete",
|
|
1755
|
+
"paginated": false,
|
|
1756
|
+
"params": null,
|
|
1757
|
+
"poll": null,
|
|
1758
|
+
"public": false,
|
|
1759
|
+
"resource": "templates",
|
|
1760
|
+
"scope": null,
|
|
1761
|
+
"signature": "mail.templates.delete(name, options?): void",
|
|
1762
|
+
"snippet": "await mail.templates.delete(\"name\");"
|
|
1763
|
+
},
|
|
1764
|
+
"TemplateController_get": {
|
|
1765
|
+
"actor": null,
|
|
1766
|
+
"deprecated": false,
|
|
1767
|
+
"http": "GET /v1/workspaces/{workspace_id}/templates/{name}",
|
|
1768
|
+
"idempotent": false,
|
|
1769
|
+
"method": "retrieve",
|
|
1770
|
+
"paginated": false,
|
|
1771
|
+
"params": null,
|
|
1772
|
+
"poll": null,
|
|
1773
|
+
"public": false,
|
|
1774
|
+
"resource": "templates",
|
|
1775
|
+
"scope": null,
|
|
1776
|
+
"signature": "mail.templates.retrieve(name, options?): Mail.Template",
|
|
1777
|
+
"snippet": "const template = await mail.templates.retrieve(\"name\");"
|
|
1778
|
+
},
|
|
1779
|
+
"TemplateController_lint": {
|
|
1780
|
+
"actor": null,
|
|
1781
|
+
"deprecated": false,
|
|
1782
|
+
"http": "POST /v1/workspaces/{workspace_id}/templates/lint",
|
|
1783
|
+
"idempotent": false,
|
|
1784
|
+
"method": "lint",
|
|
1785
|
+
"paginated": false,
|
|
1786
|
+
"params": "Mail.TemplateLintParams",
|
|
1787
|
+
"poll": null,
|
|
1788
|
+
"public": false,
|
|
1789
|
+
"resource": "templates",
|
|
1790
|
+
"scope": null,
|
|
1791
|
+
"signature": "mail.templates.lint(params, options?): Mail.LintResult",
|
|
1792
|
+
"snippet": "const lintResult = await mail.templates.lint({ body_html: \"string\" });"
|
|
1793
|
+
},
|
|
1794
|
+
"TemplateController_list": {
|
|
1795
|
+
"actor": null,
|
|
1796
|
+
"deprecated": false,
|
|
1797
|
+
"http": "GET /v1/workspaces/{workspace_id}/templates",
|
|
1798
|
+
"idempotent": false,
|
|
1799
|
+
"method": "list",
|
|
1800
|
+
"paginated": true,
|
|
1801
|
+
"params": "Mail.TemplateListParams",
|
|
1802
|
+
"poll": null,
|
|
1803
|
+
"public": false,
|
|
1804
|
+
"resource": "templates",
|
|
1805
|
+
"scope": null,
|
|
1806
|
+
"signature": "mail.templates.list(params?, options?): PagePromise<Mail.Template>",
|
|
1807
|
+
"snippet": "for await (const template of mail.templates.list()) {\n console.log(template);\n}\nconst page = await mail.templates.list({}, { timeout: 5_000 });"
|
|
1808
|
+
},
|
|
1809
|
+
"TemplateController_listTags": {
|
|
1810
|
+
"actor": null,
|
|
1811
|
+
"deprecated": false,
|
|
1812
|
+
"http": "GET /v1/workspaces/{workspace_id}/templates/tags",
|
|
1813
|
+
"idempotent": false,
|
|
1814
|
+
"method": "list",
|
|
1815
|
+
"paginated": false,
|
|
1816
|
+
"params": null,
|
|
1817
|
+
"poll": null,
|
|
1818
|
+
"public": false,
|
|
1819
|
+
"resource": "templates.tags",
|
|
1820
|
+
"scope": null,
|
|
1821
|
+
"signature": "mail.templates.tags.list(options?): Mail.ListTemplateTags",
|
|
1822
|
+
"snippet": "const listTemplateTags = await mail.templates.tags.list();"
|
|
1823
|
+
},
|
|
1824
|
+
"TemplateController_preview": {
|
|
1825
|
+
"actor": null,
|
|
1826
|
+
"deprecated": false,
|
|
1827
|
+
"http": "POST /v1/workspaces/{workspace_id}/templates/preview",
|
|
1828
|
+
"idempotent": false,
|
|
1829
|
+
"method": "preview",
|
|
1830
|
+
"paginated": false,
|
|
1831
|
+
"params": "Mail.TemplatePreviewParams",
|
|
1832
|
+
"poll": null,
|
|
1833
|
+
"public": false,
|
|
1834
|
+
"resource": "templates",
|
|
1835
|
+
"scope": null,
|
|
1836
|
+
"signature": "mail.templates.preview(params, options?): Mail.RenderedMessage",
|
|
1837
|
+
"snippet": "const renderedMessage = await mail.templates.preview({ body_html: \"string\" });"
|
|
1838
|
+
},
|
|
1839
|
+
"TemplateController_render": {
|
|
1840
|
+
"actor": null,
|
|
1841
|
+
"deprecated": false,
|
|
1842
|
+
"http": "POST /v1/workspaces/{workspace_id}/templates/{name}/render",
|
|
1843
|
+
"idempotent": false,
|
|
1844
|
+
"method": "render",
|
|
1845
|
+
"paginated": false,
|
|
1846
|
+
"params": "Mail.TemplateRenderParams",
|
|
1847
|
+
"poll": null,
|
|
1848
|
+
"public": false,
|
|
1849
|
+
"resource": "templates",
|
|
1850
|
+
"scope": null,
|
|
1851
|
+
"signature": "mail.templates.render(name, params, options?): Mail.RenderedMessage",
|
|
1852
|
+
"snippet": "const renderedMessage = await mail.templates.render(\"name\", { data: { name: \"Alice\", order_id: \"ord_123\" } });"
|
|
1853
|
+
},
|
|
1854
|
+
"TemplateController_send": {
|
|
1855
|
+
"actor": null,
|
|
1856
|
+
"deprecated": false,
|
|
1857
|
+
"http": "POST /v1/workspaces/{workspace_id}/templates/{name}/send",
|
|
1858
|
+
"idempotent": true,
|
|
1859
|
+
"method": "send",
|
|
1860
|
+
"paginated": false,
|
|
1861
|
+
"params": "Mail.TemplateSendParams",
|
|
1862
|
+
"poll": null,
|
|
1863
|
+
"public": false,
|
|
1864
|
+
"resource": "templates",
|
|
1865
|
+
"scope": null,
|
|
1866
|
+
"signature": "mail.templates.send(name, params, options?): Mail.SendAccepted",
|
|
1867
|
+
"snippet": "const sendAccepted = await mail.templates.send(\"name\", { data: { name: \"Alice\", order_id: \"ord_123\" }, to: \"user@example.com\" });"
|
|
1868
|
+
},
|
|
1869
|
+
"TemplateController_sendBatch": {
|
|
1870
|
+
"actor": null,
|
|
1871
|
+
"deprecated": false,
|
|
1872
|
+
"http": "POST /v1/workspaces/{workspace_id}/templates/{name}/send-batch",
|
|
1873
|
+
"idempotent": true,
|
|
1874
|
+
"method": "sendBatch",
|
|
1875
|
+
"paginated": false,
|
|
1876
|
+
"params": "Mail.TemplateSendBatchParams",
|
|
1877
|
+
"poll": null,
|
|
1878
|
+
"public": false,
|
|
1879
|
+
"resource": "templates",
|
|
1880
|
+
"scope": null,
|
|
1881
|
+
"signature": "mail.templates.sendBatch(name, params, options?): Mail.SendBatchOpenApi",
|
|
1882
|
+
"snippet": "const sendBatchOpenApi = await mail.templates.sendBatch(\"name\", {\n messages: [\n {\n data: { code: \"A1B2C3\", name: \"Alice\" },\n from: \"Acme <noreply@acme.com>\",\n to: \"alice@example.com\",\n },\n ],\n});"
|
|
1883
|
+
},
|
|
1884
|
+
"TemplateController_testSend": {
|
|
1885
|
+
"actor": null,
|
|
1886
|
+
"deprecated": false,
|
|
1887
|
+
"http": "POST /v1/workspaces/{workspace_id}/templates/{name}/test-send",
|
|
1888
|
+
"idempotent": true,
|
|
1889
|
+
"method": "testSend",
|
|
1890
|
+
"paginated": false,
|
|
1891
|
+
"params": "Mail.TemplateTestSendParams",
|
|
1892
|
+
"poll": null,
|
|
1893
|
+
"public": false,
|
|
1894
|
+
"resource": "templates",
|
|
1895
|
+
"scope": null,
|
|
1896
|
+
"signature": "mail.templates.testSend(name, params, options?): Mail.SendAccepted",
|
|
1897
|
+
"snippet": "const sendAccepted = await mail.templates.testSend(\"name\", { from: \"Acme <hello@acme.com>\", to: \"ada@example.com\" });"
|
|
1898
|
+
},
|
|
1899
|
+
"TemplateController_upsert": {
|
|
1900
|
+
"actor": null,
|
|
1901
|
+
"deprecated": false,
|
|
1902
|
+
"http": "POST /v1/workspaces/{workspace_id}/templates",
|
|
1903
|
+
"idempotent": true,
|
|
1904
|
+
"method": "create",
|
|
1905
|
+
"paginated": false,
|
|
1906
|
+
"params": "Mail.TemplateCreateParams",
|
|
1907
|
+
"poll": null,
|
|
1908
|
+
"public": false,
|
|
1909
|
+
"resource": "templates",
|
|
1910
|
+
"scope": null,
|
|
1911
|
+
"signature": "mail.templates.create(params, options?): Mail.Template",
|
|
1912
|
+
"snippet": "const template = await mail.templates.create({ body_html: \"string\", name: \"order-confirmation\", subject: \"string\" });"
|
|
1913
|
+
},
|
|
1914
|
+
"TemplateController_variables": {
|
|
1915
|
+
"actor": null,
|
|
1916
|
+
"deprecated": false,
|
|
1917
|
+
"http": "GET /v1/workspaces/{workspace_id}/templates/{name}/variables",
|
|
1918
|
+
"idempotent": false,
|
|
1919
|
+
"method": "list",
|
|
1920
|
+
"paginated": false,
|
|
1921
|
+
"params": null,
|
|
1922
|
+
"poll": null,
|
|
1923
|
+
"public": false,
|
|
1924
|
+
"resource": "templates.variables",
|
|
1925
|
+
"scope": null,
|
|
1926
|
+
"signature": "mail.templates.variables.list(name, options?): Mail.TemplateVariables",
|
|
1927
|
+
"snippet": "const templateVariables = await mail.templates.variables.list(\"name\");"
|
|
1928
|
+
},
|
|
1929
|
+
"TopicsController_create": {
|
|
1930
|
+
"actor": null,
|
|
1931
|
+
"deprecated": false,
|
|
1932
|
+
"http": "POST /v1/workspaces/{workspace_id}/topics",
|
|
1933
|
+
"idempotent": true,
|
|
1934
|
+
"method": "create",
|
|
1935
|
+
"paginated": false,
|
|
1936
|
+
"params": "Mail.TopicCreateParams",
|
|
1937
|
+
"poll": null,
|
|
1938
|
+
"public": false,
|
|
1939
|
+
"resource": "topics",
|
|
1940
|
+
"scope": null,
|
|
1941
|
+
"signature": "mail.topics.create(params, options?): Mail.Topic",
|
|
1942
|
+
"snippet": "const topic = await mail.topics.create({ default_subscription: \"opt_in\", name: \"Product updates\" });"
|
|
1943
|
+
},
|
|
1944
|
+
"TopicsController_get": {
|
|
1945
|
+
"actor": null,
|
|
1946
|
+
"deprecated": false,
|
|
1947
|
+
"http": "GET /v1/workspaces/{workspace_id}/topics/{topic_id}",
|
|
1948
|
+
"idempotent": false,
|
|
1949
|
+
"method": "retrieve",
|
|
1950
|
+
"paginated": false,
|
|
1951
|
+
"params": null,
|
|
1952
|
+
"poll": null,
|
|
1953
|
+
"public": false,
|
|
1954
|
+
"resource": "topics",
|
|
1955
|
+
"scope": null,
|
|
1956
|
+
"signature": "mail.topics.retrieve(topicId, options?): Mail.Topic",
|
|
1957
|
+
"snippet": "const topic = await mail.topics.retrieve(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
1958
|
+
},
|
|
1959
|
+
"TopicsController_list": {
|
|
1960
|
+
"actor": null,
|
|
1961
|
+
"deprecated": false,
|
|
1962
|
+
"http": "GET /v1/workspaces/{workspace_id}/topics",
|
|
1963
|
+
"idempotent": false,
|
|
1964
|
+
"method": "list",
|
|
1965
|
+
"paginated": true,
|
|
1966
|
+
"params": "Mail.TopicListParams",
|
|
1967
|
+
"poll": null,
|
|
1968
|
+
"public": false,
|
|
1969
|
+
"resource": "topics",
|
|
1970
|
+
"scope": null,
|
|
1971
|
+
"signature": "mail.topics.list(params?, options?): PagePromise<Mail.Topic>",
|
|
1972
|
+
"snippet": "for await (const topic of mail.topics.list()) {\n console.log(topic);\n}\nconst page = await mail.topics.list({}, { timeout: 5_000 });"
|
|
1973
|
+
},
|
|
1974
|
+
"TopicsController_remove": {
|
|
1975
|
+
"actor": null,
|
|
1976
|
+
"deprecated": false,
|
|
1977
|
+
"http": "DELETE /v1/workspaces/{workspace_id}/topics/{topic_id}",
|
|
1978
|
+
"idempotent": false,
|
|
1979
|
+
"method": "delete",
|
|
1980
|
+
"paginated": false,
|
|
1981
|
+
"params": null,
|
|
1982
|
+
"poll": null,
|
|
1983
|
+
"public": false,
|
|
1984
|
+
"resource": "topics",
|
|
1985
|
+
"scope": null,
|
|
1986
|
+
"signature": "mail.topics.delete(topicId, options?): void",
|
|
1987
|
+
"snippet": "await mail.topics.delete(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
1988
|
+
},
|
|
1989
|
+
"TopicsController_update": {
|
|
1990
|
+
"actor": null,
|
|
1991
|
+
"deprecated": false,
|
|
1992
|
+
"http": "PATCH /v1/workspaces/{workspace_id}/topics/{topic_id}",
|
|
1993
|
+
"idempotent": true,
|
|
1994
|
+
"method": "update",
|
|
1995
|
+
"paginated": false,
|
|
1996
|
+
"params": "Mail.TopicUpdateParams",
|
|
1997
|
+
"poll": null,
|
|
1998
|
+
"public": false,
|
|
1999
|
+
"resource": "topics",
|
|
2000
|
+
"scope": null,
|
|
2001
|
+
"signature": "mail.topics.update(topicId, params?, options?): Mail.Topic",
|
|
2002
|
+
"snippet": "const topic = await mail.topics.update(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", { description: \"string\" });"
|
|
2003
|
+
},
|
|
2004
|
+
"WebhooksController_mail_workspace_createEndpoint": {
|
|
2005
|
+
"actor": null,
|
|
2006
|
+
"deprecated": false,
|
|
2007
|
+
"http": "POST /v1/workspaces/{workspace_id}/webhooks/endpoints",
|
|
2008
|
+
"idempotent": true,
|
|
2009
|
+
"method": "create",
|
|
2010
|
+
"paginated": false,
|
|
2011
|
+
"params": "Mail.WebhookEndpointCreateParams",
|
|
2012
|
+
"poll": null,
|
|
2013
|
+
"public": false,
|
|
2014
|
+
"resource": "webhooks.endpoints",
|
|
2015
|
+
"scope": null,
|
|
2016
|
+
"signature": "mail.webhooks.endpoints.create(params, options?): Mail.WebhookEndpointWithSecret",
|
|
2017
|
+
"snippet": "const webhookEndpointWithSecret = await mail.webhooks.endpoints.create({ url: \"https://api.acme.com/webhooks\" });"
|
|
2018
|
+
},
|
|
2019
|
+
"WebhooksController_mail_workspace_deleteEndpoint": {
|
|
2020
|
+
"actor": null,
|
|
2021
|
+
"deprecated": false,
|
|
2022
|
+
"http": "DELETE /v1/workspaces/{workspace_id}/webhooks/endpoints/{endpoint_id}",
|
|
2023
|
+
"idempotent": false,
|
|
2024
|
+
"method": "delete",
|
|
2025
|
+
"paginated": false,
|
|
2026
|
+
"params": null,
|
|
2027
|
+
"poll": null,
|
|
2028
|
+
"public": false,
|
|
2029
|
+
"resource": "webhooks.endpoints",
|
|
2030
|
+
"scope": null,
|
|
2031
|
+
"signature": "mail.webhooks.endpoints.delete(endpointId, options?): void",
|
|
2032
|
+
"snippet": "await mail.webhooks.endpoints.delete(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
2033
|
+
},
|
|
2034
|
+
"WebhooksController_mail_workspace_getEndpoint": {
|
|
2035
|
+
"actor": null,
|
|
2036
|
+
"deprecated": false,
|
|
2037
|
+
"http": "GET /v1/workspaces/{workspace_id}/webhooks/endpoints/{endpoint_id}",
|
|
2038
|
+
"idempotent": false,
|
|
2039
|
+
"method": "retrieve",
|
|
2040
|
+
"paginated": false,
|
|
2041
|
+
"params": null,
|
|
2042
|
+
"poll": null,
|
|
2043
|
+
"public": false,
|
|
2044
|
+
"resource": "webhooks.endpoints",
|
|
2045
|
+
"scope": null,
|
|
2046
|
+
"signature": "mail.webhooks.endpoints.retrieve(endpointId, options?): Mail.WebhookEndpoint",
|
|
2047
|
+
"snippet": "const webhookEndpoint = await mail.webhooks.endpoints.retrieve(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
2048
|
+
},
|
|
2049
|
+
"WebhooksController_mail_workspace_getEvent": {
|
|
2050
|
+
"actor": null,
|
|
2051
|
+
"deprecated": false,
|
|
2052
|
+
"http": "GET /v1/workspaces/{workspace_id}/webhooks/events/{event_id}",
|
|
2053
|
+
"idempotent": false,
|
|
2054
|
+
"method": "retrieve",
|
|
2055
|
+
"paginated": false,
|
|
2056
|
+
"params": null,
|
|
2057
|
+
"poll": null,
|
|
2058
|
+
"public": false,
|
|
2059
|
+
"resource": "webhooks.events",
|
|
2060
|
+
"scope": null,
|
|
2061
|
+
"signature": "mail.webhooks.events.retrieve(eventId, options?): Mail.WebhookEventDetail",
|
|
2062
|
+
"snippet": "const webhookEventDetail = await mail.webhooks.events.retrieve(\"event\");"
|
|
2063
|
+
},
|
|
2064
|
+
"WebhooksController_mail_workspace_listEndpoints": {
|
|
2065
|
+
"actor": null,
|
|
2066
|
+
"deprecated": false,
|
|
2067
|
+
"http": "GET /v1/workspaces/{workspace_id}/webhooks/endpoints",
|
|
2068
|
+
"idempotent": false,
|
|
2069
|
+
"method": "list",
|
|
2070
|
+
"paginated": true,
|
|
2071
|
+
"params": null,
|
|
2072
|
+
"poll": null,
|
|
2073
|
+
"public": false,
|
|
2074
|
+
"resource": "webhooks.endpoints",
|
|
2075
|
+
"scope": null,
|
|
2076
|
+
"signature": "mail.webhooks.endpoints.list(options?): PagePromise<Mail.WebhookEndpoint>",
|
|
2077
|
+
"snippet": "for await (const endpoint of mail.webhooks.endpoints.list()) {\n console.log(endpoint);\n}"
|
|
2078
|
+
},
|
|
2079
|
+
"WebhooksController_mail_workspace_listEventTypes": {
|
|
2080
|
+
"actor": null,
|
|
2081
|
+
"deprecated": false,
|
|
2082
|
+
"http": "GET /v1/workspaces/{workspace_id}/webhooks/event-types",
|
|
2083
|
+
"idempotent": false,
|
|
2084
|
+
"method": "list",
|
|
2085
|
+
"paginated": false,
|
|
2086
|
+
"params": null,
|
|
2087
|
+
"poll": null,
|
|
2088
|
+
"public": false,
|
|
2089
|
+
"resource": "webhooks.eventTypes",
|
|
2090
|
+
"scope": null,
|
|
2091
|
+
"signature": "mail.webhooks.eventTypes.list(options?): Mail.ListWebhookEventTypes",
|
|
2092
|
+
"snippet": "const listWebhookEventTypes = await mail.webhooks.eventTypes.list();"
|
|
2093
|
+
},
|
|
2094
|
+
"WebhooksController_mail_workspace_listEvents": {
|
|
2095
|
+
"actor": null,
|
|
2096
|
+
"deprecated": false,
|
|
2097
|
+
"http": "GET /v1/workspaces/{workspace_id}/webhooks/events",
|
|
2098
|
+
"idempotent": false,
|
|
2099
|
+
"method": "list",
|
|
2100
|
+
"paginated": true,
|
|
2101
|
+
"params": "Mail.WebhookEventListParams",
|
|
2102
|
+
"poll": null,
|
|
2103
|
+
"public": false,
|
|
2104
|
+
"resource": "webhooks.events",
|
|
2105
|
+
"scope": null,
|
|
2106
|
+
"signature": "mail.webhooks.events.list(params?, options?): PagePromise<Mail.WebhookEvent>",
|
|
2107
|
+
"snippet": "for await (const event of mail.webhooks.events.list()) {\n console.log(event);\n}\nconst page = await mail.webhooks.events.list({}, { timeout: 5_000 });"
|
|
2108
|
+
},
|
|
2109
|
+
"WebhooksController_mail_workspace_replay": {
|
|
2110
|
+
"actor": null,
|
|
2111
|
+
"deprecated": false,
|
|
2112
|
+
"http": "POST /v1/workspaces/{workspace_id}/webhooks/events/{event_id}/replay",
|
|
2113
|
+
"idempotent": true,
|
|
2114
|
+
"method": "replay",
|
|
2115
|
+
"paginated": false,
|
|
2116
|
+
"params": "Mail.WebhookEventReplayParams",
|
|
2117
|
+
"poll": null,
|
|
2118
|
+
"public": false,
|
|
2119
|
+
"resource": "webhooks.events",
|
|
2120
|
+
"scope": null,
|
|
2121
|
+
"signature": "mail.webhooks.events.replay(eventId, params?, options?): Mail.ReplayWebhookEvent",
|
|
2122
|
+
"snippet": "const replayWebhookEvent = await mail.webhooks.events.replay(\"event\");"
|
|
2123
|
+
},
|
|
2124
|
+
"WebhooksController_mail_workspace_rotateSecret": {
|
|
2125
|
+
"actor": null,
|
|
2126
|
+
"deprecated": false,
|
|
2127
|
+
"http": "POST /v1/workspaces/{workspace_id}/webhooks/endpoints/{endpoint_id}/rotate-secret",
|
|
2128
|
+
"idempotent": true,
|
|
2129
|
+
"method": "rotateSecret",
|
|
2130
|
+
"paginated": false,
|
|
2131
|
+
"params": "Mail.WebhookEndpointRotateSecretParams",
|
|
2132
|
+
"poll": null,
|
|
2133
|
+
"public": false,
|
|
2134
|
+
"resource": "webhooks.endpoints",
|
|
2135
|
+
"scope": null,
|
|
2136
|
+
"signature": "mail.webhooks.endpoints.rotateSecret(endpointId, params?, options?): Mail.WebhookEndpointWithSecret",
|
|
2137
|
+
"snippet": "const webhookEndpointWithSecret = await mail.webhooks.endpoints.rotateSecret(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", { grace_hours: 24 });"
|
|
2138
|
+
},
|
|
2139
|
+
"WebhooksController_mail_workspace_sendTest": {
|
|
2140
|
+
"actor": null,
|
|
2141
|
+
"deprecated": false,
|
|
2142
|
+
"http": "POST /v1/workspaces/{workspace_id}/webhooks/endpoints/{endpoint_id}/test",
|
|
2143
|
+
"idempotent": true,
|
|
2144
|
+
"method": "test",
|
|
2145
|
+
"paginated": false,
|
|
2146
|
+
"params": "Mail.WebhookEndpointTestParams",
|
|
2147
|
+
"poll": null,
|
|
2148
|
+
"public": false,
|
|
2149
|
+
"resource": "webhooks.endpoints",
|
|
2150
|
+
"scope": null,
|
|
2151
|
+
"signature": "mail.webhooks.endpoints.test(endpointId, params, options?): Mail.WebhookDeliveryAttempt",
|
|
2152
|
+
"snippet": "const webhookDeliveryAttempt = await mail.webhooks.endpoints.test(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", { event_type: \"email.sent\" });"
|
|
2153
|
+
},
|
|
2154
|
+
"WebhooksController_mail_workspace_updateEndpoint": {
|
|
2155
|
+
"actor": null,
|
|
2156
|
+
"deprecated": false,
|
|
2157
|
+
"http": "PATCH /v1/workspaces/{workspace_id}/webhooks/endpoints/{endpoint_id}",
|
|
2158
|
+
"idempotent": true,
|
|
2159
|
+
"method": "update",
|
|
2160
|
+
"paginated": false,
|
|
2161
|
+
"params": "Mail.WebhookEndpointUpdateParams",
|
|
2162
|
+
"poll": null,
|
|
2163
|
+
"public": false,
|
|
2164
|
+
"resource": "webhooks.endpoints",
|
|
2165
|
+
"scope": null,
|
|
2166
|
+
"signature": "mail.webhooks.endpoints.update(endpointId, params?, options?): Mail.WebhookEndpoint",
|
|
2167
|
+
"snippet": "const webhookEndpoint = await mail.webhooks.endpoints.update(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", { description: \"Production receiver\" });"
|
|
2168
|
+
},
|
|
2169
|
+
"WorkspaceStatsController_get": {
|
|
2170
|
+
"actor": null,
|
|
2171
|
+
"deprecated": false,
|
|
2172
|
+
"http": "GET /v1/workspaces/{workspace_id}/stats",
|
|
2173
|
+
"idempotent": false,
|
|
2174
|
+
"method": "retrieve",
|
|
2175
|
+
"paginated": false,
|
|
2176
|
+
"params": "Mail.StatsRetrieveParams",
|
|
2177
|
+
"poll": null,
|
|
2178
|
+
"public": false,
|
|
2179
|
+
"resource": "stats",
|
|
2180
|
+
"scope": null,
|
|
2181
|
+
"signature": "mail.stats.retrieve(params?, options?): Mail.MailWorkspaceStats",
|
|
2182
|
+
"snippet": "const mailWorkspaceStats = await mail.stats.retrieve();"
|
|
2183
|
+
}
|
|
2184
|
+
},
|
|
2185
|
+
"package": "@productcraft/mail"
|
|
2186
|
+
}
|