SDK
Mọi phương thức
Tất cả 116 phương thức, mỗi phương thức một hàng, đặt cạnh endpoint mà nó gọi.
Mọi phương thức
Một phương thức cho mỗi thao tác có trong tài liệu, và bài kiểm tra tương đương của gói chứng minh điều đó. Nó đọc tài liệu OpenAPI, gọi mọi phương thức với một fetch ghi lại yêu cầu, và làm hỏng build khi một thao tác không có phương thức, khi một phương thức gửi bất cứ thứ gì khác với đúng yêu cầu mà hàng của nó nêu, hoặc khi các scope của một hàng khác với những scope mà thao tác đó đòi hỏi.
listAll và iterate duyệt trang trên cùng endpoint với list bên cạnh chúng, listAllRuns và iterateRuns trên rules cũng vậy, nên một yêu cầu có thể xuất hiện ở nhiều hàng.
| Lời gọi | Endpoint | Scope |
|---|---|---|
| `me.get()` | GET /keys/self | không có |
| `me.ping()` | GET /ping | không có |
| `me.rotate()` | POST /keys/self/rotate | keys:write |
| `addresses.list()` | GET /addresses | emails:send |
| `languages.list()` | GET /languages | không có |
| `emails.send()` | POST /emails | emails:send |
| `emails.sendBatch()` | POST /emails/batch | emails:send |
| `emails.translate()` | POST /emails/translate | emails:send |
| `emails.list()` | GET /emails | emails:read |
| `emails.listAll()` | GET /emails | emails:read |
| `emails.iterate()` | GET /emails | emails:read |
| `emails.get()` | GET /emails/{id} | emails:read |
| `emails.listEvents()` | GET /emails/{id}/events | emails:read |
| `emails.getTracking()` | GET /emails/{id}/tracking | emails:read |
| `emails.cancel()` | POST /emails/{id}/cancel | emails:send |
| `emails.reschedule()` | PATCH /emails/{id} | emails:send |
| `templates.list()` | GET /templates | templates:read |
| `templates.listAll()` | GET /templates | templates:read |
| `templates.iterate()` | GET /templates | templates:read |
| `templates.get()` | GET /templates/{id} | templates:read |
| `templates.create()` | POST /templates | templates:write |
| `templates.update()` | PATCH /templates/{id} | templates:write |
| `templates.delete()` | DELETE /templates/{id} | templates:write |
| `templates.listVersions()` | GET /templates/{id}/versions | templates:read |
| `templates.publish()` | POST /templates/{id}/versions | templates:write |
| `templates.preview()` | POST /templates/{id}/preview | templates:read |
| `templates.send()` | POST /templates/{id}/send | templates:write + emails:send |
| `tracking.list()` | GET /tracking | emails:read |
| `tracking.getStats()` | GET /tracking/stats | emails:read |
| `tracking.get()` | GET /tracking/{id} | emails:read |
| `tracking.listOpens()` | GET /tracking/{id}/opens | emails:read |
| `tracking.listClicks()` | GET /tracking/{id}/clicks | emails:read |
| `threads.list()` | GET /threads | threads:read |
| `threads.listAll()` | GET /threads | threads:read |
| `threads.iterate()` | GET /threads | threads:read |
| `threads.get()` | GET /threads/{id} | threads:read |
| `threads.update()` | PATCH /threads/{id} | threads:write |
| `threads.trash()` | POST /threads/{id}/trash | threads:write |
| `threads.snooze()` | POST /threads/{id}/snooze | threads:write |
| `threads.unsnooze()` | POST /threads/{id}/unsnooze | threads:write |
| `threads.listAttachments()` | GET /threads/{id}/messages/{messageId}/attachments | threads:read |
| `drafts.list()` | GET /drafts | drafts:read |
| `drafts.listAll()` | GET /drafts | drafts:read |
| `drafts.iterate()` | GET /drafts | drafts:read |
| `drafts.get()` | GET /drafts/{id} | drafts:read |
| `drafts.create()` | POST /drafts | drafts:write |
| `drafts.update()` | PATCH /drafts/{id} | drafts:write |
| `drafts.delete()` | DELETE /drafts/{id} | drafts:write |
| `labels.list()` | GET /labels | labels:read |
| `labels.get()` | GET /labels/{id} | labels:read |
| `labels.create()` | POST /labels | labels:write |
| `labels.update()` | PATCH /labels/{id} | labels:write |
| `labels.delete()` | DELETE /labels/{id} | labels:write |
| `contacts.list()` | GET /contacts | contacts:read |
| `contacts.get()` | GET /contacts/{email} | contacts:read |
| `contacts.create()` | POST /contacts | contacts:write |
| `contacts.update()` | PATCH /contacts/{email} | contacts:write |
| `contacts.delete()` | DELETE /contacts/{email} | contacts:write |
| `audiences.list()` | GET /audiences | audiences:read |
| `audiences.get()` | GET /audiences/{id} | audiences:read |
| `audiences.create()` | POST /audiences | audiences:write |
| `audiences.update()` | PATCH /audiences/{id} | audiences:write |
| `audiences.delete()` | DELETE /audiences/{id} | audiences:write |
| `audiences.listContacts()` | GET /audiences/{id}/contacts | audiences:read |
| `audiences.addContact()` | POST /audiences/{id}/contacts | audiences:write |
| `audiences.removeContact()` | DELETE /audiences/{id}/contacts/{email} | audiences:write |
| `domains.list()` | GET /domains | domains:read |
| `domains.get()` | GET /domains/{id} | domains:read |
| `domains.update()` | PATCH /domains/{id} | domains:write |
| `rules.list()` | GET /rules | rules:read |
| `rules.listAll()` | GET /rules | rules:read |
| `rules.iterate()` | GET /rules | rules:read |
| `rules.get()` | GET /rules/{id} | rules:read |
| `rules.create()` | POST /rules | rules:write |
| `rules.update()` | PATCH /rules/{id} | rules:write |
| `rules.delete()` | DELETE /rules/{id} | rules:write |
| `rules.reorder()` | POST /rules/reorder | rules:write |
| `rules.test()` | POST /rules/{id}/test | rules:read |
| `rules.listRuns()` | GET /rules/runs | rules:read |
| `rules.listAllRuns()` | GET /rules/runs | rules:read |
| `rules.iterateRuns()` | GET /rules/runs | rules:read |
| `webhooks.list()` | GET /webhooks | webhooks:read |
| `webhooks.get()` | GET /webhooks/{id} | webhooks:read |
| `webhooks.create()` | POST /webhooks | webhooks:write |
| `webhooks.update()` | PATCH /webhooks/{id} | webhooks:write |
| `webhooks.delete()` | DELETE /webhooks/{id} | webhooks:write |
| `webhooks.rotateSecret()` | POST /webhooks/{id}/rotate-secret | webhooks:write |
| `webhooks.test()` | POST /webhooks/{id}/test | webhooks:write |
| `webhooks.listDeliveries()` | GET /webhooks/{id}/deliveries | webhooks:read |
| `calendar.listEvents()` | GET /calendar/events | calendar:read |
| `calendar.getEvent()` | GET /calendar/events/{id} | calendar:read |
| `calendar.getEventIcs()` | GET /calendar/events/{id}/ics | calendar:read |
| `settings.get()` | GET /settings | settings:read |
| `settings.update()` | PATCH /settings | settings:write |
| `roles.list()` | GET /roles | roles:read |
| `roles.get()` | GET /roles/{id} | roles:read |
| `roles.create()` | POST /roles | roles:write |
| `roles.update()` | PATCH /roles/{id} | roles:write |
| `roles.delete()` | DELETE /roles/{id} | roles:write |
| `roles.listPermissions()` | GET /roles/permissions | roles:read |
| `members.list()` | GET /members | members:read |
| `members.get()` | GET /members/{userId} | members:read |
| `members.add()` | POST /members | members:write |
| `members.update()` | PATCH /members/{userId} | members:write |
| `members.remove()` | DELETE /members/{userId} | members:write |
| `members.grantAddress()` | POST /members/{userId}/addresses | members:write |
| `members.revokeAddress()` | DELETE /members/{userId}/addresses/{addressId} | members:write |
| `tempMail.listDomains()` | GET /temp-mail/domains | không có |
| `tempMail.create()` | POST /temp-mail/inboxes | không có |
| `tempMail.get()` | GET /temp-mail/inboxes/{id} | token hộp thư |
| `tempMail.extend()` | POST /temp-mail/inboxes/{id}/extend | token hộp thư |
| `tempMail.delete()` | DELETE /temp-mail/inboxes/{id} | token hộp thư |
| `tempMail.listMessages()` | GET /temp-mail/inboxes/{id}/messages | token hộp thư |
| `tempMail.getMessage()` | GET /temp-mail/inboxes/{id}/messages/{messageId} | token hộp thư |
| `tempMail.deleteMessage()` | DELETE /temp-mail/inboxes/{id}/messages/{messageId} | token hộp thư |
| `tempMail.listAttachments()` | GET /temp-mail/inboxes/{id}/messages/{messageId}/attachments | token hộp thư |
Các hàng tempMail ghi "token hộp thư" ở nơi mọi hàng khác nêu tên một scope, và đó không phải cách viết tắt của một scope. Hộp thư dùng một lần là tài nguyên ẩn danh duy nhất trên API: listDomains và create hoàn toàn không gửi thông tin xác thực nào, còn bảy lời gọi còn lại xác thực bằng token oe_inbox_ mà create đã trả về một lần duy nhất. Hãy truyền nó qua inboxToken ở mỗi lời gọi, hoặc dựng một client cho hộp thư đó bằng createTempMail({ inboxToken }). Không có nó, một client workspace sẽ quay về dùng API key của mình, và API từ chối thẳng thừng chứ không âm thầm chấp nhận.