# Lettermint v2.1.0 - Table of Contents

> Elixir SDK for the Lettermint sending and team APIs.

## Pages

- [Lettermint Elixir SDK](readme.md)
- [Upgrade guide](upgrade.md)
- [Changelog](changelog.md)

## Modules

- Client
  - [Lettermint](Lettermint.md): The Lettermint client.
  - [Lettermint.Adapter](Lettermint.Adapter.md): The HTTP adapter behaviour.
  - [Lettermint.Adapter.Req](Lettermint.Adapter.Req.md): The default adapter, based on `Req`.
  - [Lettermint.Client](Lettermint.Client.md): The client configuration: tokens, base URL, timeout and HTTP adapter.

- Sending
  - [Lettermint.EmailBuilder](Lettermint.EmailBuilder.md): An immutable email builder for the pipe operator. Start one with
`Lettermint.Emails.compose/2`.
  - [Lettermint.Emails](Lettermint.Emails.md): Sends email with the project sending token (`x-lettermint-token`).

- Team API
  - [Lettermint.Domains](Lettermint.Domains.md): Sending domains. Needs `:team_token`.
  - [Lettermint.Messages](Lettermint.Messages.md): Sent and received messages. Needs `:team_token`; `reschedule/4` and
`cancel/3` also accept the sending token when no team token is configured.
  - [Lettermint.Projects](Lettermint.Projects.md): Projects. Needs `:team_token`. Report forwarding is in
`Lettermint.Projects.ReportForwarding`, routes in `Lettermint.Routes`.
  - [Lettermint.Projects.ReportForwarding](Lettermint.Projects.ReportForwarding.md): DMARC and complaint report forwarding of a project. Needs `:team_token`.
  - [Lettermint.Routes](Lettermint.Routes.md): Routes of a project. Needs `:team_token`.
  - [Lettermint.Stats](Lettermint.Stats.md): Sending statistics. Needs `:team_token`.
  - [Lettermint.Suppressions](Lettermint.Suppressions.md): The suppression list. Needs `:team_token`.
  - [Lettermint.Team](Lettermint.Team.md): The team of the token. Needs `:team_token`. Members are in
`Lettermint.Team.Members`.
  - [Lettermint.Team.Members](Lettermint.Team.Members.md): Team members. Needs `:team_token`.
  - [Lettermint.Webhooks](Lettermint.Webhooks.md): Webhook endpoints. Needs `:team_token`. Delivery attempts are in
`Lettermint.Webhooks.Deliveries`. To verify incoming deliveries, use
`Lettermint.Webhook`.
  - [Lettermint.Webhooks.Deliveries](Lettermint.Webhooks.Deliveries.md): Delivery attempts of a webhook. Needs `:team_token`.

- Webhooks
  - [Lettermint.Webhook](Lettermint.Webhook.md): Verifies Lettermint webhook deliveries.
  - [Lettermint.WebhookPayload](Lettermint.WebhookPayload.md): A verified webhook delivery.

- Errors
  - [Lettermint.APIError](Lettermint.APIError.md): The API answered with an error status (4xx or 5xx) and a JSON or empty body. The per-status errors have the same fields.
  - [Lettermint.AuthenticationError](Lettermint.AuthenticationError.md): HTTP 401: the token is missing, invalid or revoked.
  - [Lettermint.ClientValidationError](Lettermint.ClientValidationError.md): The SDK rejected a request before sending it, for example invalid message
tags or a body that cannot be encoded as JSON. Unlike
`Lettermint.ValidationError`, the API never saw this request.
  - [Lettermint.ConfigError](Lettermint.ConfigError.md): The client was configured or called incorrectly: a missing or unrecognised
token, a token that the called function cannot use, an invalid option or an
invalid path parameter. Raised before any request is made.

  - [Lettermint.ConflictError](Lettermint.ConflictError.md): HTTP 409: the request conflicts with the current state, for example an Idempotency-Key reused with a different body.
  - [Lettermint.ConnectionError](Lettermint.ConnectionError.md): The request could not be sent or the connection failed (DNS, TLS, refused,
reset). `reason` is the HTTP client's error, for example a
`Req.TransportError` with `reason: :econnrefused`.

  - [Lettermint.Error](Lettermint.Error.md): The errors of the Lettermint SDK.
  - [Lettermint.NotFoundError](Lettermint.NotFoundError.md): HTTP 404: the resource does not exist or is not visible to the token.
  - [Lettermint.PermissionError](Lettermint.PermissionError.md): HTTP 403: the token may not perform this action, or the plan lacks the feature.
  - [Lettermint.RateLimitError](Lettermint.RateLimitError.md): HTTP 429: too many requests.
  - [Lettermint.RedirectError](Lettermint.RedirectError.md): The API answered with a redirect (3xx). The SDK never follows redirects, so
that tokens are not sent to another location.

  - [Lettermint.ServerError](Lettermint.ServerError.md): HTTP 5xx with a JSON or empty body.
  - [Lettermint.TimeoutError](Lettermint.TimeoutError.md): The request did not complete within the timeout. The timeout covers the
whole request: connecting, sending, the response headers and the body. The
API may still have processed the request.

  - [Lettermint.UnexpectedResponseError](Lettermint.UnexpectedResponseError.md): The response could not be decoded: an empty or non-JSON body where JSON was
expected, or an error status with a non-JSON body such as a proxy's HTML
page. `body_excerpt` holds the first 200 characters of the body.

  - [Lettermint.ValidationError](Lettermint.ValidationError.md): HTTP 422: the API rejected the request data.
  - [Lettermint.WebhookVerificationError](Lettermint.WebhookVerificationError.md): A webhook delivery could not be verified. Reject the request and do not
process its payload.

- Requests and queries
  - [Lettermint.Operations](Lettermint.Operations.md): Every operation of the Sending and Team APIs, keyed by `"<METHOD> <path>"`.
  - [Lettermint.Query](Lettermint.Query.md): Serializes query maps to the API's bracket syntax, exactly as the Node SDK.

- Types
  - [Lettermint.Types](Lettermint.Types.md): The API types, and helpers to convert them.
  - [Lettermint.Types.AnalyticsBreakdownRow](Lettermint.Types.AnalyticsBreakdownRow.md): Metric values for one group of dimension values.
  - [Lettermint.Types.AnalyticsCatalogueDimension](Lettermint.Types.AnalyticsCatalogueDimension.md): `schema:AnalyticsDimension |0`.
  - [Lettermint.Types.AnalyticsCatalogueGroupDimension](Lettermint.Types.AnalyticsCatalogueGroupDimension.md): `schema:AnalyticsGroupDimension |0`.
  - [Lettermint.Types.AnalyticsComparison](Lettermint.Types.AnalyticsComparison.md): A comparison period.
  - [Lettermint.Types.AnalyticsComparisonValues](Lettermint.Types.AnalyticsComparisonValues.md): Metric values for the comparison period.
  - [Lettermint.Types.AnalyticsDimension](Lettermint.Types.AnalyticsDimension.md): A catalogue dimension or tag:<case-sensitive name> to filter by. is_human, is_privacy, is_bot and is_scanner select an engagement class: filter them with the value 1 to restrict engagement metrics to that class.

  - [Lettermint.Types.AnalyticsFilter](Lettermint.Types.AnalyticsFilter.md): A dimension filter.
  - [Lettermint.Types.AnalyticsFilterOperator](Lettermint.Types.AnalyticsFilterOperator.md): A filter operator.
  - [Lettermint.Types.AnalyticsGroupDimension](Lettermint.Types.AnalyticsGroupDimension.md): A catalogue dimension or tag:<case-sensitive name> to group breakdown rows by. Engagement class dimensions (is_human, is_privacy, is_bot and is_scanner) can only filter. smtp_response_group can only group: each row reads the SMTP reply of the group as its reply code, enhanced status code and response text, with addresses and other identifiers replaced by placeholders.

  - [Lettermint.Types.AnalyticsInterval](Lettermint.Types.AnalyticsInterval.md): A time-series bucket size.
  - [Lettermint.Types.AnalyticsMeta](Lettermint.Types.AnalyticsMeta.md): The time window and data availability of the results.
  - [Lettermint.Types.AnalyticsMetaAlignment](Lettermint.Types.AnalyticsMetaAlignment.md): Grain the requested boundaries were widened to: whole UTC hours, or whole UTC days for personal-data dimensions. Counts cover exactly from to effective_to.
  - [Lettermint.Types.AnalyticsMetaCollectionCompleteness](Lettermint.Types.AnalyticsMetaCollectionCompleteness.md): `schema:AnalyticsMeta .collection_completeness`.
  - [Lettermint.Types.AnalyticsMetaComparison](Lettermint.Types.AnalyticsMetaComparison.md): `schema:AnalyticsMeta .comparison`.
  - [Lettermint.Types.AnalyticsMetaTimeBasis](Lettermint.Types.AnalyticsMetaTimeBasis.md): `schema:AnalyticsMeta .time_basis`.
  - [Lettermint.Types.AnalyticsMetric](Lettermint.Types.AnalyticsMetric.md): A metric from the analytics catalogue.
  - [Lettermint.Types.AnalyticsMetricChange](Lettermint.Types.AnalyticsMetricChange.md): Change of a metric against the comparison period.
  - [Lettermint.Types.AnalyticsMetricValues](Lettermint.Types.AnalyticsMetricValues.md): Values of the selected metrics. Rates are fractions; null when not available.
  - [Lettermint.Types.AnalyticsPagination](Lettermint.Types.AnalyticsPagination.md): Breakdown pagination.
  - [Lettermint.Types.AnalyticsQuery](Lettermint.Types.AnalyticsQuery.md): An analytics query.
  - [Lettermint.Types.AnalyticsRateBase](Lettermint.Types.AnalyticsRateBase.md): Numerator and denominator of a rate metric.
  - [Lettermint.Types.AnalyticsRateBases](Lettermint.Types.AnalyticsRateBases.md): Numerators and denominators of the selected rate metrics.
  - [Lettermint.Types.AnalyticsResponse](Lettermint.Types.AnalyticsResponse.md): Analytics results with their window metadata and pagination.
  - [Lettermint.Types.AnalyticsResults](Lettermint.Types.AnalyticsResults.md): The selected result sections.
  - [Lettermint.Types.AnalyticsSection](Lettermint.Types.AnalyticsSection.md): A result section.
  - [Lettermint.Types.AnalyticsSort](Lettermint.Types.AnalyticsSort.md): A breakdown sort order.
  - [Lettermint.Types.AnalyticsSortDirection](Lettermint.Types.AnalyticsSortDirection.md): Ascending or descending order for the selected sort metric.
  - [Lettermint.Types.AnalyticsSummary](Lettermint.Types.AnalyticsSummary.md): Metric values for the whole window.
  - [Lettermint.Types.AnalyticsTimeSeriesPoint](Lettermint.Types.AnalyticsTimeSeriesPoint.md): Metric values for one time-series bucket.
  - [Lettermint.Types.ApiError](Lettermint.Types.ApiError.md): Structured API error.
  - [Lettermint.Types.ApiErrorDetail](Lettermint.Types.ApiErrorDetail.md): `schema:ApiError .error`.
  - [Lettermint.Types.AttachmentDelivery](Lettermint.Types.AttachmentDelivery.md): `schema:AttachmentDelivery`.
  - [Lettermint.Types.BlockedFileTypes](Lettermint.Types.BlockedFileTypes.md): File types that cannot be sent as email attachments.
  - [Lettermint.Types.BuiltInTeamRole](Lettermint.Types.BuiltInTeamRole.md): `schema:BuiltInTeamRole`.
  - [Lettermint.Types.CursorPage](Lettermint.Types.CursorPage.md): A page of a cursor-paginated list. Pass `next_cursor` back as the cursor query parameter to read the next page; it is `nil` on the last page.
  - [Lettermint.Types.DeleteSuppressionResponse](Lettermint.Types.DeleteSuppressionResponse.md): `DELETE /suppressions/{suppressionId} response 2xx`.
  - [Lettermint.Types.DeleteSuppressionResponseStatus](Lettermint.Types.DeleteSuppressionResponseStatus.md): `DELETE /suppressions/{suppressionId} response 2xx .status`.

  - [Lettermint.Types.DeliveryMode](Lettermint.Types.DeliveryMode.md): `schema:DeliveryMode`.
  - [Lettermint.Types.DkimMode](Lettermint.Types.DkimMode.md): `schema:DkimMode`.
  - [Lettermint.Types.DmarcPolicy](Lettermint.Types.DmarcPolicy.md): `schema:DmarcPolicy`.
  - [Lettermint.Types.DnsRecordPurpose](Lettermint.Types.DnsRecordPurpose.md): `schema:DnsRecordPurpose`.
  - [Lettermint.Types.DnsRecordStatus](Lettermint.Types.DnsRecordStatus.md): | |
|---|
| `active` <br/> The record is active and verified. |
| `failed` <br/> The record could not be verified. |
| `pending` <br/> The record is pending verification. |
  - [Lettermint.Types.DnsRecordVerificationFailureResponse](Lettermint.Types.DnsRecordVerificationFailureResponse.md): A DNS record that did not pass verification, with the verification details.
  - [Lettermint.Types.DnsVerificationError](Lettermint.Types.DnsVerificationError.md): Why a DNS record did not pass verification.
  - [Lettermint.Types.DnsVerificationFailedRecord](Lettermint.Types.DnsVerificationFailedRecord.md): A DNS record that did not pass verification.
  - [Lettermint.Types.DnsVerificationFailureResponse](Lettermint.Types.DnsVerificationFailureResponse.md): One or more required DNS records of the domain did not pass verification.
  - [Lettermint.Types.DnsVerificationResultData](Lettermint.Types.DnsVerificationResultData.md): `schema:DnsVerificationResultData`.
  - [Lettermint.Types.DnsVerificationResultDataDmarcSpfAlignmentIssue](Lettermint.Types.DnsVerificationResultDataDmarcSpfAlignmentIssue.md): `schema:DnsVerificationResultData .dmarc_spf_alignment_issue`.
  - [Lettermint.Types.DnsVerificationScope](Lettermint.Types.DnsVerificationScope.md): `schema:DnsVerificationScope`.
  - [Lettermint.Types.DnsVerificationSuccessResponse](Lettermint.Types.DnsVerificationSuccessResponse.md): All required DNS records of the domain passed verification.
  - [Lettermint.Types.DomainData](Lettermint.Types.DomainData.md): `schema:DomainData`.
  - [Lettermint.Types.DomainDataProjectsItem](Lettermint.Types.DomainDataProjectsItem.md): `schema:DomainData .projects[]`.
  - [Lettermint.Types.DomainDnsRecordData](Lettermint.Types.DomainDnsRecordData.md): `schema:DomainDnsRecordData`.
  - [Lettermint.Types.DomainListData](Lettermint.Types.DomainListData.md): `schema:DomainListData`.
  - [Lettermint.Types.DomainMutationResponse](Lettermint.Types.DomainMutationResponse.md): The domain after a change, with a confirmation message.
  - [Lettermint.Types.DomainStatus](Lettermint.Types.DomainStatus.md): | |
|---|
| `verified` <br/> The domain is active and verified. |
| `partially_verified` <br/> Some DNS records of the domain could not be verified. |
| `pending_verification` <br/> The domain is new and verification is pending. |
| `failed_verification` <br/> The domain verification failed. |
  - [Lettermint.Types.ErrorMessage](Lettermint.Types.ErrorMessage.md): Error with only a message.
  - [Lettermint.Types.GetDomainQuery](Lettermint.Types.GetDomainQuery.md): Query parameters of `GET /domains/{domainId}` (getDomain).
  - [Lettermint.Types.GetDomainQueryIncludeItem](Lettermint.Types.GetDomainQueryIncludeItem.md): `GET /domains/{domainId} param query include []`.
  - [Lettermint.Types.GetProjectQuery](Lettermint.Types.GetProjectQuery.md): Query parameters of `GET /projects/{projectId}` (getProject).
  - [Lettermint.Types.GetProjectQueryIncludeItem](Lettermint.Types.GetProjectQueryIncludeItem.md): `GET /projects/{projectId} param query include []`.
  - [Lettermint.Types.GetReportForwardingResponse](Lettermint.Types.GetReportForwardingResponse.md): `GET /projects/{projectId}/report-forwarding response 200`.
  - [Lettermint.Types.GetRouteQuery](Lettermint.Types.GetRouteQuery.md): Query parameters of `GET /routes/{routeId}` (getRoute).
  - [Lettermint.Types.GetRouteQueryIncludeItem](Lettermint.Types.GetRouteQueryIncludeItem.md): `GET /routes/{routeId} param query include []`.
  - [Lettermint.Types.GetStatsQuery](Lettermint.Types.GetStatsQuery.md): Query parameters of `GET /stats` (getStats).
  - [Lettermint.Types.GetTeamQuery](Lettermint.Types.GetTeamQuery.md): Query parameters of `GET /team` (getTeam).
  - [Lettermint.Types.GetTeamQueryIncludeItem](Lettermint.Types.GetTeamQueryIncludeItem.md): `GET /team param query include []`.
  - [Lettermint.Types.InboundDomainVerification](Lettermint.Types.InboundDomainVerification.md): Whether the inbound domain MX records point to Lettermint. The MX record lists are only returned when verification fails.
  - [Lettermint.Types.InboundDomainVerificationResponse](Lettermint.Types.InboundDomainVerificationResponse.md): The result of an inbound domain MX verification.
  - [Lettermint.Types.InitialRoutes](Lettermint.Types.InitialRoutes.md): `schema:InitialRoutes`.
  - [Lettermint.Types.ListDomainsQuery](Lettermint.Types.ListDomainsQuery.md): Query parameters of `GET /domains` (listDomains).
  - [Lettermint.Types.ListDomainsQuerySortItem](Lettermint.Types.ListDomainsQuerySortItem.md): `GET /domains param query sort []`.
  - [Lettermint.Types.ListDomainsResponse](Lettermint.Types.ListDomainsResponse.md): `GET /domains response 200`: a page of `Lettermint.Types.DomainListData.t()`.

  - [Lettermint.Types.ListMessageEventsQuery](Lettermint.Types.ListMessageEventsQuery.md): Query parameters of `GET /messages/{messageId}/events` (listMessageEvents).
  - [Lettermint.Types.ListMessageEventsQuerySortItem](Lettermint.Types.ListMessageEventsQuerySortItem.md): `GET /messages/{messageId}/events param query sort []`.
  - [Lettermint.Types.ListMessageEventsResponse](Lettermint.Types.ListMessageEventsResponse.md): `GET /messages/{messageId}/events response 200`: a page of `Lettermint.Types.MessageEventData.t()`.

  - [Lettermint.Types.ListMessagesQuery](Lettermint.Types.ListMessagesQuery.md): Query parameters of `GET /messages` (listMessages).
  - [Lettermint.Types.ListMessagesQueryFilter](Lettermint.Types.ListMessagesQueryFilter.md): `GET /messages param query filter`.
  - [Lettermint.Types.ListMessagesQueryFilterTagsItem](Lettermint.Types.ListMessagesQueryFilterTagsItem.md): `GET /messages param query filter .tags[]`.
  - [Lettermint.Types.ListMessagesQuerySortItem](Lettermint.Types.ListMessagesQuerySortItem.md): `GET /messages param query sort []`.
  - [Lettermint.Types.ListMessagesResponse](Lettermint.Types.ListMessagesResponse.md): `GET /messages response 200`: a page of `Lettermint.Types.MessageListData.t()`.

  - [Lettermint.Types.ListProjectsQuery](Lettermint.Types.ListProjectsQuery.md): Query parameters of `GET /projects` (listProjects).
  - [Lettermint.Types.ListProjectsQuerySortItem](Lettermint.Types.ListProjectsQuerySortItem.md): `GET /projects param query sort []`.
  - [Lettermint.Types.ListProjectsResponse](Lettermint.Types.ListProjectsResponse.md): `GET /projects response 200`: a page of `Lettermint.Types.ProjectListData.t()`.

  - [Lettermint.Types.ListRoutesQuery](Lettermint.Types.ListRoutesQuery.md): Query parameters of `GET /projects/{projectId}/routes` (listRoutes).
  - [Lettermint.Types.ListRoutesQuerySortItem](Lettermint.Types.ListRoutesQuerySortItem.md): `GET /projects/{projectId}/routes param query sort []`.
  - [Lettermint.Types.ListRoutesResponse](Lettermint.Types.ListRoutesResponse.md): `GET /projects/{projectId}/routes response 200`: a page of `Lettermint.Types.RouteListData.t()`.

  - [Lettermint.Types.ListSuppressionsQuery](Lettermint.Types.ListSuppressionsQuery.md): Query parameters of `GET /suppressions` (listSuppressions).
  - [Lettermint.Types.ListSuppressionsQuerySortItem](Lettermint.Types.ListSuppressionsQuerySortItem.md): `GET /suppressions param query sort []`.
  - [Lettermint.Types.ListSuppressionsResponse](Lettermint.Types.ListSuppressionsResponse.md): `GET /suppressions response 200`: a page of `Lettermint.Types.SuppressedRecipientData.t()`.

  - [Lettermint.Types.ListTeamMembersQuery](Lettermint.Types.ListTeamMembersQuery.md): Query parameters of `GET /team/members` (listTeamMembers).
  - [Lettermint.Types.ListTeamMembersResponse](Lettermint.Types.ListTeamMembersResponse.md): `GET /team/members response 200`: a page of `Lettermint.Types.TeamMemberData.t()`.

  - [Lettermint.Types.ListWebhookDeliveriesQuery](Lettermint.Types.ListWebhookDeliveriesQuery.md): Query parameters of `GET /webhooks/{webhookId}/deliveries` (listWebhookDeliveries).
  - [Lettermint.Types.ListWebhookDeliveriesQuerySortItem](Lettermint.Types.ListWebhookDeliveriesQuerySortItem.md): `GET /webhooks/{webhookId}/deliveries param query sort []`.
  - [Lettermint.Types.ListWebhookDeliveriesResponse](Lettermint.Types.ListWebhookDeliveriesResponse.md): `GET /webhooks/{webhookId}/deliveries response 200`: a page of `Lettermint.Types.WebhookDeliveryListData.t()`.

  - [Lettermint.Types.ListWebhooksQuery](Lettermint.Types.ListWebhooksQuery.md): Query parameters of `GET /webhooks` (listWebhooks).
  - [Lettermint.Types.ListWebhooksQuerySortItem](Lettermint.Types.ListWebhooksQuerySortItem.md): `GET /webhooks param query sort []`.
  - [Lettermint.Types.ListWebhooksResponse](Lettermint.Types.ListWebhooksResponse.md): `GET /webhooks response 200`: a page of `Lettermint.Types.WebhookListData.t()`.

  - [Lettermint.Types.MessageAttachmentData](Lettermint.Types.MessageAttachmentData.md): `schema:MessageAttachmentData`.
  - [Lettermint.Types.MessageAttachmentInput](Lettermint.Types.MessageAttachmentInput.md): A file attached to the message.
  - [Lettermint.Types.MessageData](Lettermint.Types.MessageData.md): `schema:MessageData`.
  - [Lettermint.Types.MessageEventData](Lettermint.Types.MessageEventData.md): `schema:MessageEventData`.
  - [Lettermint.Types.MessageEventType](Lettermint.Types.MessageEventType.md): `schema:MessageEventType`.
  - [Lettermint.Types.MessageListData](Lettermint.Types.MessageListData.md): `schema:MessageListData`.
  - [Lettermint.Types.MessageRecipientData](Lettermint.Types.MessageRecipientData.md): `schema:MessageRecipientData`.
  - [Lettermint.Types.MessageResponse](Lettermint.Types.MessageResponse.md): Confirmation that a request succeeded.
  - [Lettermint.Types.MessageStatsData](Lettermint.Types.MessageStatsData.md): `schema:MessageStatsData`.
  - [Lettermint.Types.MessageStatus](Lettermint.Types.MessageStatus.md): `schema:MessageStatus`.
  - [Lettermint.Types.MessageTag](Lettermint.Types.MessageTag.md): `schema:MessageData .tags[]`.
  - [Lettermint.Types.MessageTagInput](Lettermint.Types.MessageTagInput.md): A reusable exact-match tag with a name and a value.
  - [Lettermint.Types.MessageType](Lettermint.Types.MessageType.md): `schema:MessageType`.
  - [Lettermint.Types.ModelNotFoundException](Lettermint.Types.ModelNotFoundException.md): Not found

  - [Lettermint.Types.PendingSendMailResponse](Lettermint.Types.PendingSendMailResponse.md): An accepted message that is queued for delivery.
  - [Lettermint.Types.Plan](Lettermint.Types.Plan.md): `schema:Plan`.
  - [Lettermint.Types.ProcessInboundMessageConflict](Lettermint.Types.ProcessInboundMessageConflict.md): `POST /messages/{messageId}/process response 409 |0`.
  - [Lettermint.Types.ProcessInboundMessageConflictError](Lettermint.Types.ProcessInboundMessageConflictError.md): `POST /messages/{messageId}/process response 409 |0.error`.
  - [Lettermint.Types.ProcessInboundMessageConflictErrorCode](Lettermint.Types.ProcessInboundMessageConflictErrorCode.md): `POST /messages/{messageId}/process response 409 |0.error.code`.
  - [Lettermint.Types.ProcessInboundMessageResponse](Lettermint.Types.ProcessInboundMessageResponse.md): The queued release of a quarantined inbound message.
  - [Lettermint.Types.ProcessInboundMessageResult](Lettermint.Types.ProcessInboundMessageResult.md): A quarantined inbound message that was queued for webhook delivery.
  - [Lettermint.Types.ProjectAccessScope](Lettermint.Types.ProjectAccessScope.md): `schema:ProjectAccessScope`.
  - [Lettermint.Types.ProjectCreatedData](Lettermint.Types.ProjectCreatedData.md): `schema:ProjectCreatedData`.
  - [Lettermint.Types.ProjectData](Lettermint.Types.ProjectData.md): `schema:ProjectData`.
  - [Lettermint.Types.ProjectListData](Lettermint.Types.ProjectListData.md): `schema:ProjectListData`.
  - [Lettermint.Types.ProjectMutationResponse](Lettermint.Types.ProjectMutationResponse.md): The project after a change, with a confirmation message.
  - [Lettermint.Types.RbacConflictCode](Lettermint.Types.RbacConflictCode.md): `schema:RbacConflictCode`.
  - [Lettermint.Types.RbacConflictException](Lettermint.Types.RbacConflictException.md): Role or project-access state conflict
  - [Lettermint.Types.RbacConflictExceptionError](Lettermint.Types.RbacConflictExceptionError.md): `response:RbacConflictException .error`.
  - [Lettermint.Types.RbacPermission](Lettermint.Types.RbacPermission.md): `schema:RbacPermission`.
  - [Lettermint.Types.RecordType](Lettermint.Types.RecordType.md): `schema:RecordType`.
  - [Lettermint.Types.ReportForwardingRequest](Lettermint.Types.ReportForwardingRequest.md): `schema:ReportForwardingRequest`.
  - [Lettermint.Types.ReportForwardingResource](Lettermint.Types.ReportForwardingResource.md): `schema:ReportForwardingResource`.
  - [Lettermint.Types.RescheduleMessageRequest](Lettermint.Types.RescheduleMessageRequest.md): `schema:RescheduleMessageRequest`.
  - [Lettermint.Types.ResendReportForwardingCodeResponse](Lettermint.Types.ResendReportForwardingCodeResponse.md): `POST /projects/{projectId}/report-forwarding/resend-code response 200`.
  - [Lettermint.Types.RotateProjectTokenResponse](Lettermint.Types.RotateProjectTokenResponse.md): The project and its new legacy Project API token.
  - [Lettermint.Types.RouteData](Lettermint.Types.RouteData.md): `schema:RouteData`.
  - [Lettermint.Types.RouteDataSettings](Lettermint.Types.RouteDataSettings.md): Route settings available for this route type and team feature access
  - [Lettermint.Types.RouteListData](Lettermint.Types.RouteListData.md): `schema:RouteListData`.
  - [Lettermint.Types.RouteMutationResponse](Lettermint.Types.RouteMutationResponse.md): The route after it was created or changed, with a confirmation message.
  - [Lettermint.Types.RouteStatisticData](Lettermint.Types.RouteStatisticData.md): `schema:RouteStatisticData`.
  - [Lettermint.Types.RouteType](Lettermint.Types.RouteType.md): `schema:RouteType`.
  - [Lettermint.Types.SandboxResult](Lettermint.Types.SandboxResult.md): `schema:SandboxResult`.
  - [Lettermint.Types.ScheduledMessage](Lettermint.Types.ScheduledMessage.md): The schedule state of a message after it was rescheduled or canceled.
  - [Lettermint.Types.ScheduledSendMailResponse](Lettermint.Types.ScheduledSendMailResponse.md): An accepted message that is scheduled for later delivery.
  - [Lettermint.Types.SendBatchMailRequest](Lettermint.Types.SendBatchMailRequest.md): `schema:SendBatchMailRequest`.

  - [Lettermint.Types.SendBatchMailResponse](Lettermint.Types.SendBatchMailResponse.md): `POST /send/batch response 202`.

  - [Lettermint.Types.SendMailRequest](Lettermint.Types.SendMailRequest.md): `schema:SendMailRequest`.
  - [Lettermint.Types.SendMailRequestSettings](Lettermint.Types.SendMailRequestSettings.md): Per-email settings that override the selected route settings for this email only.
  - [Lettermint.Types.SendMailResponse](Lettermint.Types.SendMailResponse.md): `POST /send response 202`.
  - [Lettermint.Types.SpamSymbol](Lettermint.Types.SpamSymbol.md): `schema:SpamSymbol`.
  - [Lettermint.Types.StatsDailyData](Lettermint.Types.StatsDailyData.md): `schema:StatsDailyData`.
  - [Lettermint.Types.StatsData](Lettermint.Types.StatsData.md): `schema:StatsData`.
  - [Lettermint.Types.StatsInboundData](Lettermint.Types.StatsInboundData.md): `schema:StatsInboundData`.
  - [Lettermint.Types.StatsTotalsData](Lettermint.Types.StatsTotalsData.md): `schema:StatsTotalsData`.
  - [Lettermint.Types.StatsTypeData](Lettermint.Types.StatsTypeData.md): `schema:StatsTypeData`.
  - [Lettermint.Types.StoreDomainData](Lettermint.Types.StoreDomainData.md): `schema:StoreDomainData`.
  - [Lettermint.Types.StoreProjectData](Lettermint.Types.StoreProjectData.md): `schema:StoreProjectData`.
  - [Lettermint.Types.StoreRouteData](Lettermint.Types.StoreRouteData.md): `schema:StoreRouteData`.
  - [Lettermint.Types.StoreSuppressionData](Lettermint.Types.StoreSuppressionData.md): `schema:StoreSuppressionData`.
  - [Lettermint.Types.StoreWebhookData](Lettermint.Types.StoreWebhookData.md): `schema:StoreWebhookData`.
  - [Lettermint.Types.SuppressedRecipientData](Lettermint.Types.SuppressedRecipientData.md): `schema:SuppressedRecipientData`.
  - [Lettermint.Types.SuppressionAppliesTo](Lettermint.Types.SuppressionAppliesTo.md): Mail category blocked by the suppression. `all` blocks transactional and broadcast mail. `broadcast` blocks broadcast mail only.
  - [Lettermint.Types.SuppressionCreateReason](Lettermint.Types.SuppressionCreateReason.md): Reason that the recipient is suppressed. The `disposable_email` reason is reserved for route policies.
  - [Lettermint.Types.SuppressionCreateScope](Lettermint.Types.SuppressionCreateScope.md): Where the suppression applies. The `global` and `subscription_group` scopes cannot be created through the API.
  - [Lettermint.Types.SuppressionDeletedResponse](Lettermint.Types.SuppressionDeletedResponse.md): Confirmation that a suppression was removed.
  - [Lettermint.Types.SuppressionReason](Lettermint.Types.SuppressionReason.md): Reason that the recipient is suppressed.
  - [Lettermint.Types.SuppressionReviewResponse](Lettermint.Types.SuppressionReviewResponse.md): A suppression that stays active while a support ticket reviews its removal.
  - [Lettermint.Types.SuppressionReviewResponseStatus](Lettermint.Types.SuppressionReviewResponseStatus.md): `schema:SuppressionReviewResponse .status`.
  - [Lettermint.Types.SuppressionScope](Lettermint.Types.SuppressionScope.md): Where the suppression applies.
  - [Lettermint.Types.SuppressionSourceMessageData](Lettermint.Types.SuppressionSourceMessageData.md): `schema:SuppressionSourceMessageData`.
  - [Lettermint.Types.SuppressionStoreResponse](Lettermint.Types.SuppressionStoreResponse.md): The outcome of adding addresses to the suppression list.
  - [Lettermint.Types.SuppressionStoreResult](Lettermint.Types.SuppressionStoreResult.md): The addresses that were added and the addresses that were already suppressed.
  - [Lettermint.Types.SuppressionType](Lettermint.Types.SuppressionType.md): `schema:SuppressionType`.
  - [Lettermint.Types.TeamAddonData](Lettermint.Types.TeamAddonData.md): `schema:TeamAddonData`.
  - [Lettermint.Types.TeamData](Lettermint.Types.TeamData.md): `schema:TeamData`.
  - [Lettermint.Types.TeamMemberData](Lettermint.Types.TeamMemberData.md): `schema:TeamMemberData`.
  - [Lettermint.Types.TeamMemberDataRole](Lettermint.Types.TeamMemberDataRole.md): `schema:TeamMemberData .role`.
  - [Lettermint.Types.TeamMemberProjectAccessData](Lettermint.Types.TeamMemberProjectAccessData.md): `schema:TeamMemberProjectAccessData`.
  - [Lettermint.Types.TeamMemberProjectAccessDataProjectsItem](Lettermint.Types.TeamMemberProjectAccessDataProjectsItem.md): `schema:TeamMemberProjectAccessData .projects[]`.
  - [Lettermint.Types.TeamMutationResponse](Lettermint.Types.TeamMutationResponse.md): The team after a settings change, with a confirmation message.
  - [Lettermint.Types.TeamRoleData](Lettermint.Types.TeamRoleData.md): `schema:TeamRoleData`.
  - [Lettermint.Types.TeamRoleListResponse](Lettermint.Types.TeamRoleListResponse.md): The reusable roles of the team.
  - [Lettermint.Types.TeamType](Lettermint.Types.TeamType.md): `schema:TeamType`.
  - [Lettermint.Types.TeamUsageDetailData](Lettermint.Types.TeamUsageDetailData.md): `schema:TeamUsageDetailData`.
  - [Lettermint.Types.TeamUsagePeriodData](Lettermint.Types.TeamUsagePeriodData.md): `schema:TeamUsagePeriodData`.
  - [Lettermint.Types.TestWebhookResponse](Lettermint.Types.TestWebhookResponse.md): Confirmation that a test delivery was queued.
  - [Lettermint.Types.TlsPolicy](Lettermint.Types.TlsPolicy.md): `schema:TlsPolicy`.
  - [Lettermint.Types.TooManyRequests](Lettermint.Types.TooManyRequests.md): Too many requests.

  - [Lettermint.Types.UpdateDomainProjectsData](Lettermint.Types.UpdateDomainProjectsData.md): `schema:UpdateDomainProjectsData`.
  - [Lettermint.Types.UpdateProjectData](Lettermint.Types.UpdateProjectData.md): `schema:UpdateProjectData`.
  - [Lettermint.Types.UpdateReportForwardingResponse](Lettermint.Types.UpdateReportForwardingResponse.md): `PUT /projects/{projectId}/report-forwarding response 200`.
  - [Lettermint.Types.UpdateRouteData](Lettermint.Types.UpdateRouteData.md): `schema:UpdateRouteData`.
  - [Lettermint.Types.UpdateRouteInboundSettingsData](Lettermint.Types.UpdateRouteInboundSettingsData.md): `schema:UpdateRouteInboundSettingsData`.
  - [Lettermint.Types.UpdateRouteSettingsData](Lettermint.Types.UpdateRouteSettingsData.md): `schema:UpdateRouteSettingsData`.
  - [Lettermint.Types.UpdateTeamData](Lettermint.Types.UpdateTeamData.md): `schema:UpdateTeamData`.
  - [Lettermint.Types.UpdateTeamMemberAssignmentData](Lettermint.Types.UpdateTeamMemberAssignmentData.md): `schema:UpdateTeamMemberAssignmentData`.
  - [Lettermint.Types.UpdateTeamMemberAssignmentDataProjectAccess](Lettermint.Types.UpdateTeamMemberAssignmentDataProjectAccess.md): `schema:UpdateTeamMemberAssignmentData .project_access`.
  - [Lettermint.Types.UpdateWebhookData](Lettermint.Types.UpdateWebhookData.md): `schema:UpdateWebhookData`.
  - [Lettermint.Types.ValidationError](Lettermint.Types.ValidationError.md): `schema:ValidationError`.
  - [Lettermint.Types.ValidationException](Lettermint.Types.ValidationException.md): Validation error

  - [Lettermint.Types.VerifyReportForwardingRequest](Lettermint.Types.VerifyReportForwardingRequest.md): `schema:VerifyReportForwardingRequest`.
  - [Lettermint.Types.VerifyReportForwardingResponse](Lettermint.Types.VerifyReportForwardingResponse.md): `POST /projects/{projectId}/report-forwarding/verify response 200`.
  - [Lettermint.Types.WebhookBasicAuthData](Lettermint.Types.WebhookBasicAuthData.md): `schema:WebhookBasicAuthData`.
  - [Lettermint.Types.WebhookData](Lettermint.Types.WebhookData.md): `schema:WebhookData`.
  - [Lettermint.Types.WebhookDeliveryData](Lettermint.Types.WebhookDeliveryData.md): `schema:WebhookDeliveryData`.
  - [Lettermint.Types.WebhookDeliveryListData](Lettermint.Types.WebhookDeliveryListData.md): `schema:WebhookDeliveryListData`.
  - [Lettermint.Types.WebhookDeliveryModeFilter](Lettermint.Types.WebhookDeliveryModeFilter.md): `schema:WebhookDeliveryModeFilter`.
  - [Lettermint.Types.WebhookDeliveryStatus](Lettermint.Types.WebhookDeliveryStatus.md): `schema:WebhookDeliveryStatus`.
  - [Lettermint.Types.WebhookEvent](Lettermint.Types.WebhookEvent.md): `schema:WebhookEvent`.
  - [Lettermint.Types.WebhookListData](Lettermint.Types.WebhookListData.md): `schema:WebhookListData`.
  - [Lettermint.Types.WebhookMutationResponse](Lettermint.Types.WebhookMutationResponse.md): The webhook after a change, with a confirmation message.
  - [Lettermint.Types.WebhookScope](Lettermint.Types.WebhookScope.md): `schema:WebhookScope`.
  - [Lettermint.Types.WebhookSecretData](Lettermint.Types.WebhookSecretData.md): `schema:WebhookSecretData`.
  - [Lettermint.Types.WebhookSecretResponse](Lettermint.Types.WebhookSecretResponse.md): The webhook with its signing secret, which is only returned when the secret is created or regenerated.

