Skip to content

Latest commit

 

History

History
228 lines (165 loc) · 16.4 KB

File metadata and controls

228 lines (165 loc) · 16.4 KB

Shared

Types:

Emails

Types:

Methods:

  • client.emails.retrieve(emailID, { ...params }) -> EmailRetrieveResponse
  • client.emails.list({ ...params }) -> EmailListResponsesPageNumberPagination
  • client.emails.retrieveDeliveries(emailID) -> EmailRetrieveDeliveriesResponse
  • client.emails.retry(emailID) -> EmailRetryResponse
  • client.emails.send({ ...params }) -> EmailSendResponse
  • client.emails.sendBatch({ ...params }) -> EmailSendBatchResponse
  • client.emails.sendRaw({ ...params }) -> EmailSendRawResponse

Logs

Types:

Methods:

  • client.logs.retrieve(requestID) -> LogRetrieveResponse
  • client.logs.list({ ...params }) -> LogEntriesPageNumberPagination

Usage

Types:

Methods:

  • client.usage.retrieve({ ...params }) -> OrgUsageSummary
  • client.usage.export({ ...params }) -> UsageExportResponse
  • client.usage.listTenants({ ...params }) -> TenantUsageItemsPageNumberPagination

Limits

Types:

Methods:

  • client.limits.retrieve() -> LimitRetrieveResponse

Tenants

Types:

Methods:

  • client.tenants.create({ ...params }) -> TenantCreateResponse
  • client.tenants.retrieve(tenantID) -> TenantRetrieveResponse
  • client.tenants.update(tenantID, { ...params }) -> TenantUpdateResponse
  • client.tenants.list({ ...params }) -> TenantsPageNumberPagination
  • client.tenants.delete(tenantID) -> TenantDeleteResponse

Credentials

Types:

Methods:

  • client.tenants.credentials.create(tenantID, { ...params }) -> CredentialCreateResponse
  • client.tenants.credentials.retrieve(credentialID, { ...params }) -> CredentialRetrieveResponse
  • client.tenants.credentials.update(credentialID, { ...params }) -> CredentialUpdateResponse
  • client.tenants.credentials.list(tenantID, { ...params }) -> CredentialListResponsesPageNumberPagination
  • client.tenants.credentials.delete(credentialID, { ...params }) -> CredentialDeleteResponse

Domains

Types:

Methods:

  • client.tenants.domains.create(tenantID, { ...params }) -> DomainCreateResponse
  • client.tenants.domains.retrieve(domainID, { ...params }) -> DomainRetrieveResponse
  • client.tenants.domains.list(tenantID) -> DomainListResponse
  • client.tenants.domains.delete(domainID, { ...params }) -> DomainDeleteResponse
  • client.tenants.domains.verify(domainID, { ...params }) -> DomainVerifyResponse

Suppressions

Types:

Methods:

  • client.tenants.suppressions.create(tenantID, { ...params }) -> SuppressionCreateResponse
  • client.tenants.suppressions.retrieve(email, { ...params }) -> SuppressionRetrieveResponse
  • client.tenants.suppressions.list(tenantID, { ...params }) -> SuppressionListResponsesPageNumberPagination
  • client.tenants.suppressions.delete(email, { ...params }) -> SuppressionDeleteResponse

Webhooks

Types:

Methods:

  • client.tenants.webhooks.create(tenantID, { ...params }) -> WebhookCreateResponse
  • client.tenants.webhooks.retrieve(webhookID, { ...params }) -> WebhookRetrieveResponse
  • client.tenants.webhooks.update(webhookID, { ...params }) -> WebhookUpdateResponse
  • client.tenants.webhooks.list(tenantID) -> WebhookListResponse
  • client.tenants.webhooks.delete(webhookID, { ...params }) -> WebhookDeleteResponse
  • client.tenants.webhooks.listDeliveries(webhookID, { ...params }) -> WebhookListDeliveriesResponse
  • client.tenants.webhooks.replayDelivery(deliveryID, { ...params }) -> WebhookReplayDeliveryResponse
  • client.tenants.webhooks.retrieveDelivery(deliveryID, { ...params }) -> WebhookRetrieveDeliveryResponse
  • client.tenants.webhooks.test(webhookID, { ...params }) -> WebhookTestResponse

Tracking

Types:

Methods:

  • client.tenants.tracking.create(tenantID, { ...params }) -> TrackingCreateResponse
  • client.tenants.tracking.retrieve(trackingID, { ...params }) -> TrackingRetrieveResponse
  • client.tenants.tracking.update(trackingID, { ...params }) -> TrackingUpdateResponse
  • client.tenants.tracking.list(tenantID) -> TrackingListResponse
  • client.tenants.tracking.delete(trackingID, { ...params }) -> TrackingDeleteResponse
  • client.tenants.tracking.verify(trackingID, { ...params }) -> TrackingVerifyResponse

Usage

Types:

Methods:

  • client.tenants.usage.retrieve(tenantID, { ...params }) -> UsageRetrieveResponse
  • client.tenants.usage.retrieveTimeseries(tenantID, { ...params }) -> UsageRetrieveTimeseriesResponse

Platform

Webhooks

Types:

Methods:

  • client.platform.webhooks.create({ ...params }) -> WebhookCreateResponse
  • client.platform.webhooks.retrieve(webhookID) -> WebhookRetrieveResponse
  • client.platform.webhooks.update(webhookID, { ...params }) -> WebhookUpdateResponse
  • client.platform.webhooks.list() -> WebhookListResponse
  • client.platform.webhooks.delete(webhookID) -> WebhookDeleteResponse
  • client.platform.webhooks.listDeliveries({ ...params }) -> WebhookListDeliveriesResponsesPageNumberPagination
  • client.platform.webhooks.replayDelivery(deliveryID) -> WebhookReplayDeliveryResponse
  • client.platform.webhooks.retrieveDelivery(deliveryID) -> WebhookRetrieveDeliveryResponse
  • client.platform.webhooks.test(webhookID, { ...params }) -> WebhookTestResponse