문서로 건너뛰기
SDK

모든 메서드

116개 전부를 한 줄씩, 각각이 호출하는 엔드포인트와 함께 정리했습니다.

모든 메서드

문서화된 모든 작업에 메서드가 하나씩 있으며, 패키지의 패리티 검사가 이를 증명합니다. 이 검사는 OpenAPI 문서를 읽고 기록용 fetch를 상대로 모든 메서드를 호출한 뒤, 어떤 작업에 대응하는 메서드가 없거나, 메서드가 자기 줄에 적힌 요청과 정확히 다른 것을 보내거나, 줄에 적힌 스코프가 해당 작업이 요구하는 것과 다르면 빌드를 실패시킵니다.

listAll과 iterate는 옆에 있는 list와 같은 엔드포인트를 페이지 단위로 훑으며, rules의 listAllRuns와 iterateRuns도 마찬가지입니다. 그래서 같은 요청이 둘 이상의 줄에 나타날 수 있습니다.

호출엔드포인트스코프
`me.get()`GET /keys/self없음
`me.ping()`GET /ping없음
`me.rotate()`POST /keys/self/rotatekeys:write
`addresses.list()`GET /addressesemails:send
`languages.list()`GET /languages없음
`emails.send()`POST /emailsemails:send
`emails.sendBatch()`POST /emails/batchemails:send
`emails.translate()`POST /emails/translateemails:send
`emails.list()`GET /emailsemails:read
`emails.listAll()`GET /emailsemails:read
`emails.iterate()`GET /emailsemails:read
`emails.get()`GET /emails/{id}emails:read
`emails.listEvents()`GET /emails/{id}/eventsemails:read
`emails.getTracking()`GET /emails/{id}/trackingemails:read
`emails.cancel()`POST /emails/{id}/cancelemails:send
`emails.reschedule()`PATCH /emails/{id}emails:send
`templates.list()`GET /templatestemplates:read
`templates.listAll()`GET /templatestemplates:read
`templates.iterate()`GET /templatestemplates:read
`templates.get()`GET /templates/{id}templates:read
`templates.create()`POST /templatestemplates:write
`templates.update()`PATCH /templates/{id}templates:write
`templates.delete()`DELETE /templates/{id}templates:write
`templates.listVersions()`GET /templates/{id}/versionstemplates:read
`templates.publish()`POST /templates/{id}/versionstemplates:write
`templates.preview()`POST /templates/{id}/previewtemplates:read
`templates.send()`POST /templates/{id}/sendtemplates:write + emails:send
`tracking.list()`GET /trackingemails:read
`tracking.getStats()`GET /tracking/statsemails:read
`tracking.get()`GET /tracking/{id}emails:read
`tracking.listOpens()`GET /tracking/{id}/opensemails:read
`tracking.listClicks()`GET /tracking/{id}/clicksemails:read
`threads.list()`GET /threadsthreads:read
`threads.listAll()`GET /threadsthreads:read
`threads.iterate()`GET /threadsthreads:read
`threads.get()`GET /threads/{id}threads:read
`threads.update()`PATCH /threads/{id}threads:write
`threads.trash()`POST /threads/{id}/trashthreads:write
`threads.snooze()`POST /threads/{id}/snoozethreads:write
`threads.unsnooze()`POST /threads/{id}/unsnoozethreads:write
`threads.listAttachments()`GET /threads/{id}/messages/{messageId}/attachmentsthreads:read
`drafts.list()`GET /draftsdrafts:read
`drafts.listAll()`GET /draftsdrafts:read
`drafts.iterate()`GET /draftsdrafts:read
`drafts.get()`GET /drafts/{id}drafts:read
`drafts.create()`POST /draftsdrafts:write
`drafts.update()`PATCH /drafts/{id}drafts:write
`drafts.delete()`DELETE /drafts/{id}drafts:write
`labels.list()`GET /labelslabels:read
`labels.get()`GET /labels/{id}labels:read
`labels.create()`POST /labelslabels:write
`labels.update()`PATCH /labels/{id}labels:write
`labels.delete()`DELETE /labels/{id}labels:write
`contacts.list()`GET /contactscontacts:read
`contacts.get()`GET /contacts/{email}contacts:read
`contacts.create()`POST /contactscontacts:write
`contacts.update()`PATCH /contacts/{email}contacts:write
`contacts.delete()`DELETE /contacts/{email}contacts:write
`audiences.list()`GET /audiencesaudiences:read
`audiences.get()`GET /audiences/{id}audiences:read
`audiences.create()`POST /audiencesaudiences:write
`audiences.update()`PATCH /audiences/{id}audiences:write
`audiences.delete()`DELETE /audiences/{id}audiences:write
`audiences.listContacts()`GET /audiences/{id}/contactsaudiences:read
`audiences.addContact()`POST /audiences/{id}/contactsaudiences:write
`audiences.removeContact()`DELETE /audiences/{id}/contacts/{email}audiences:write
`domains.list()`GET /domainsdomains:read
`domains.get()`GET /domains/{id}domains:read
`domains.update()`PATCH /domains/{id}domains:write
`rules.list()`GET /rulesrules:read
`rules.listAll()`GET /rulesrules:read
`rules.iterate()`GET /rulesrules:read
`rules.get()`GET /rules/{id}rules:read
`rules.create()`POST /rulesrules:write
`rules.update()`PATCH /rules/{id}rules:write
`rules.delete()`DELETE /rules/{id}rules:write
`rules.reorder()`POST /rules/reorderrules:write
`rules.test()`POST /rules/{id}/testrules:read
`rules.listRuns()`GET /rules/runsrules:read
`rules.listAllRuns()`GET /rules/runsrules:read
`rules.iterateRuns()`GET /rules/runsrules:read
`webhooks.list()`GET /webhookswebhooks:read
`webhooks.get()`GET /webhooks/{id}webhooks:read
`webhooks.create()`POST /webhookswebhooks:write
`webhooks.update()`PATCH /webhooks/{id}webhooks:write
`webhooks.delete()`DELETE /webhooks/{id}webhooks:write
`webhooks.rotateSecret()`POST /webhooks/{id}/rotate-secretwebhooks:write
`webhooks.test()`POST /webhooks/{id}/testwebhooks:write
`webhooks.listDeliveries()`GET /webhooks/{id}/deliverieswebhooks:read
`calendar.listEvents()`GET /calendar/eventscalendar:read
`calendar.getEvent()`GET /calendar/events/{id}calendar:read
`calendar.getEventIcs()`GET /calendar/events/{id}/icscalendar:read
`settings.get()`GET /settingssettings:read
`settings.update()`PATCH /settingssettings:write
`roles.list()`GET /rolesroles:read
`roles.get()`GET /roles/{id}roles:read
`roles.create()`POST /rolesroles:write
`roles.update()`PATCH /roles/{id}roles:write
`roles.delete()`DELETE /roles/{id}roles:write
`roles.listPermissions()`GET /roles/permissionsroles:read
`members.list()`GET /membersmembers:read
`members.get()`GET /members/{userId}members:read
`members.add()`POST /membersmembers:write
`members.update()`PATCH /members/{userId}members:write
`members.remove()`DELETE /members/{userId}members:write
`members.grantAddress()`POST /members/{userId}/addressesmembers:write
`members.revokeAddress()`DELETE /members/{userId}/addresses/{addressId}members:write
`tempMail.listDomains()`GET /temp-mail/domains없음
`tempMail.create()`POST /temp-mail/inboxes없음
`tempMail.get()`GET /temp-mail/inboxes/{id}수신함 토큰
`tempMail.extend()`POST /temp-mail/inboxes/{id}/extend수신함 토큰
`tempMail.delete()`DELETE /temp-mail/inboxes/{id}수신함 토큰
`tempMail.listMessages()`GET /temp-mail/inboxes/{id}/messages수신함 토큰
`tempMail.getMessage()`GET /temp-mail/inboxes/{id}/messages/{messageId}수신함 토큰
`tempMail.deleteMessage()`DELETE /temp-mail/inboxes/{id}/messages/{messageId}수신함 토큰
`tempMail.listAttachments()`GET /temp-mail/inboxes/{id}/messages/{messageId}/attachments수신함 토큰

tempMail 줄들은 다른 모든 줄이 스코프를 적는 자리에 “수신함 토큰”이라고 적혀 있는데, 이는 어떤 스코프의 줄임말이 아닙니다. 일회용 수신함은 이 API에서 유일한 익명 리소스입니다. listDomains와 create는 자격 증명을 전혀 보내지 않고, 나머지 일곱 개는 create가 한 번 돌려준 oe_inbox_ 토큰으로 인증합니다. 호출마다 inboxToken으로 전달하거나, createTempMail({ inboxToken })으로 해당 수신함 전용 클라이언트를 만드십시오. 토큰이 없으면 워크스페이스 클라이언트는 자신의 API 키로 대체하는데, API는 이를 조용히 받아들이지 않고 명시적으로 거부합니다.