api.md

Shared Types

from ark.types import APIMeta

Emails

Types:

from ark.types import (
    EmailRetrieveResponse,
    EmailListResponse,
    EmailRetrieveDeliveriesResponse,
    EmailRetryResponse,
    EmailSendResponse,
    EmailSendBatchResponse,
    EmailSendRawResponse,
)

Methods:

• client.emails.retrieve(email_id, **params) -> EmailRetrieveResponse
• client.emails.list(**params) -> SyncPageNumberPagination[EmailListResponse]
• client.emails.retrieve_deliveries(email_id) -> EmailRetrieveDeliveriesResponse
• client.emails.retry(email_id) -> EmailRetryResponse
• client.emails.send(**params) -> EmailSendResponse
• client.emails.send_batch(**params) -> EmailSendBatchResponse
• client.emails.send_raw(**params) -> EmailSendRawResponse

Logs

Types:

from ark.types import LogEntry, LogEntryDetail, LogRetrieveResponse

Methods:

• client.logs.retrieve(request_id) -> LogRetrieveResponse
• client.logs.list(**params) -> SyncPageNumberPagination[LogEntry]

Usage

Types:

from ark.types import (
    EmailCounts,
    EmailRates,
    OrgUsageSummary,
    TenantUsageItem,
    UsagePeriod,
    UsageExportResponse,
)

Methods:

• client.usage.retrieve(**params) -> OrgUsageSummary
• client.usage.export(**params) -> UsageExportResponse
• client.usage.list_tenants(**params) -> SyncPageNumberPagination[TenantUsageItem]

Limits

Types:

from ark.types import LimitsData, LimitRetrieveResponse

Methods:

• client.limits.retrieve() -> LimitRetrieveResponse

Tenants

Types:

from ark.types import (
    Tenant,
    TenantCreateResponse,
    TenantRetrieveResponse,
    TenantUpdateResponse,
    TenantDeleteResponse,
)

Methods:

• client.tenants.create(**params) -> TenantCreateResponse
• client.tenants.retrieve(tenant_id) -> TenantRetrieveResponse
• client.tenants.update(tenant_id, **params) -> TenantUpdateResponse
• client.tenants.list(**params) -> SyncPageNumberPagination[Tenant]
• client.tenants.delete(tenant_id) -> TenantDeleteResponse

Credentials

Types:

from ark.types.tenants import (
    CredentialCreateResponse,
    CredentialRetrieveResponse,
    CredentialUpdateResponse,
    CredentialListResponse,
    CredentialDeleteResponse,
)

Methods:

• client.tenants.credentials.create(tenant_id, **params) -> CredentialCreateResponse
• client.tenants.credentials.retrieve(credential_id, *, tenant_id, **params) -> CredentialRetrieveResponse
• client.tenants.credentials.update(credential_id, *, tenant_id, **params) -> CredentialUpdateResponse
• client.tenants.credentials.list(tenant_id, **params) -> SyncPageNumberPagination[CredentialListResponse]
• client.tenants.credentials.delete(credential_id, *, tenant_id) -> CredentialDeleteResponse

Domains

Types:

from ark.types.tenants import (
    DNSRecord,
    DomainCreateResponse,
    DomainRetrieveResponse,
    DomainListResponse,
    DomainDeleteResponse,
    DomainVerifyResponse,
)

Methods:

• client.tenants.domains.create(tenant_id, **params) -> DomainCreateResponse
• client.tenants.domains.retrieve(domain_id, *, tenant_id) -> DomainRetrieveResponse
• client.tenants.domains.list(tenant_id) -> DomainListResponse
• client.tenants.domains.delete(domain_id, *, tenant_id) -> DomainDeleteResponse
• client.tenants.domains.verify(domain_id, *, tenant_id) -> DomainVerifyResponse

Suppressions

Types:

from ark.types.tenants import (
    SuppressionCreateResponse,
    SuppressionRetrieveResponse,
    SuppressionListResponse,
    SuppressionDeleteResponse,
)

Methods:

• client.tenants.suppressions.create(tenant_id, **params) -> SuppressionCreateResponse
• client.tenants.suppressions.retrieve(email, *, tenant_id) -> SuppressionRetrieveResponse
• client.tenants.suppressions.list(tenant_id, **params) -> SyncPageNumberPagination[SuppressionListResponse]
• client.tenants.suppressions.delete(email, *, tenant_id) -> SuppressionDeleteResponse

Webhooks

Types:

from ark.types.tenants import (
    WebhookCreateResponse,
    WebhookRetrieveResponse,
    WebhookUpdateResponse,
    WebhookListResponse,
    WebhookDeleteResponse,
    WebhookListDeliveriesResponse,
    WebhookReplayDeliveryResponse,
    WebhookRetrieveDeliveryResponse,
    WebhookTestResponse,
)

Methods:

• client.tenants.webhooks.create(tenant_id, **params) -> WebhookCreateResponse
• client.tenants.webhooks.retrieve(webhook_id, *, tenant_id) -> WebhookRetrieveResponse
• client.tenants.webhooks.update(webhook_id, *, tenant_id, **params) -> WebhookUpdateResponse
• client.tenants.webhooks.list(tenant_id) -> WebhookListResponse
• client.tenants.webhooks.delete(webhook_id, *, tenant_id) -> WebhookDeleteResponse
• client.tenants.webhooks.list_deliveries(webhook_id, *, tenant_id, **params) -> WebhookListDeliveriesResponse
• client.tenants.webhooks.replay_delivery(delivery_id, *, tenant_id, webhook_id) -> WebhookReplayDeliveryResponse
• client.tenants.webhooks.retrieve_delivery(delivery_id, *, tenant_id, webhook_id) -> WebhookRetrieveDeliveryResponse
• client.tenants.webhooks.test(webhook_id, *, tenant_id, **params) -> WebhookTestResponse

Tracking

Types:

from ark.types.tenants import (
    TrackDomain,
    TrackingCreateResponse,
    TrackingRetrieveResponse,
    TrackingUpdateResponse,
    TrackingListResponse,
    TrackingDeleteResponse,
    TrackingVerifyResponse,
)

Methods:

• client.tenants.tracking.create(tenant_id, **params) -> TrackingCreateResponse
• client.tenants.tracking.retrieve(tracking_id, *, tenant_id) -> TrackingRetrieveResponse
• client.tenants.tracking.update(tracking_id, *, tenant_id, **params) -> TrackingUpdateResponse
• client.tenants.tracking.list(tenant_id) -> TrackingListResponse
• client.tenants.tracking.delete(tracking_id, *, tenant_id) -> TrackingDeleteResponse
• client.tenants.tracking.verify(tracking_id, *, tenant_id) -> TrackingVerifyResponse

Usage

Types:

from ark.types.tenants import (
    TenantUsage,
    TenantUsageTimeseries,
    UsageRetrieveResponse,
    UsageRetrieveTimeseriesResponse,
)

Methods:

• client.tenants.usage.retrieve(tenant_id, **params) -> UsageRetrieveResponse
• client.tenants.usage.retrieve_timeseries(tenant_id, **params) -> UsageRetrieveTimeseriesResponse

Platform

Webhooks

Types:

from ark.types.platform import (
    WebhookCreateResponse,
    WebhookRetrieveResponse,
    WebhookUpdateResponse,
    WebhookListResponse,
    WebhookDeleteResponse,
    WebhookListDeliveriesResponse,
    WebhookReplayDeliveryResponse,
    WebhookRetrieveDeliveryResponse,
    WebhookTestResponse,
)

Methods:

• client.platform.webhooks.create(**params) -> WebhookCreateResponse
• client.platform.webhooks.retrieve(webhook_id) -> WebhookRetrieveResponse
• client.platform.webhooks.update(webhook_id, **params) -> WebhookUpdateResponse
• client.platform.webhooks.list() -> WebhookListResponse
• client.platform.webhooks.delete(webhook_id) -> WebhookDeleteResponse
• client.platform.webhooks.list_deliveries(**params) -> SyncPageNumberPagination[WebhookListDeliveriesResponse]
• client.platform.webhooks.replay_delivery(delivery_id) -> WebhookReplayDeliveryResponse
• client.platform.webhooks.retrieve_delivery(delivery_id) -> WebhookRetrieveDeliveryResponse
• client.platform.webhooks.test(webhook_id, **params) -> WebhookTestResponse