# apollo_signal v4.0.1 - Table of Contents

> Elixir SDK for the Apollo Signal API

## Modules

- [ApolloSignal](ApolloSignal.md): Apollo Signal API API client.
- [ApolloSignal.Client](ApolloSignal.Client.md): Main client for Apollo Signal API.
- [ApolloSignal.Domains.ApiKeys](ApolloSignal.Domains.ApiKeys.md): apiKeys API operations.
- [ApolloSignal.Domains.ContactProperties](ApolloSignal.Domains.ContactProperties.md): contactProperties API operations.
- [ApolloSignal.Domains.Contacts](ApolloSignal.Domains.Contacts.md): contacts API operations.
- [ApolloSignal.Domains.Emails](ApolloSignal.Domains.Emails.md): emails API operations.
- [ApolloSignal.Domains.Metrics](ApolloSignal.Domains.Metrics.md): metrics API operations.
- [ApolloSignal.Domains.Projects](ApolloSignal.Domains.Projects.md): projects API operations.
- [ApolloSignal.Domains.Segments](ApolloSignal.Domains.Segments.md): segments API operations.
- [ApolloSignal.Domains.SendingDomains](ApolloSignal.Domains.SendingDomains.md): sendingDomains API operations.
- [ApolloSignal.Domains.Suppressions](ApolloSignal.Domains.Suppressions.md): suppressions API operations.
- [ApolloSignal.Domains.Topics](ApolloSignal.Domains.Topics.md): topics API operations.
- [ApolloSignal.Domains.Webhooks](ApolloSignal.Domains.Webhooks.md): webhooks API operations.
- [ApolloSignal.Transport](ApolloSignal.Transport.md): Req-based transport with bounded, idempotency-aware retries and SSE support.

- [ApolloSignal.Transport.Response](ApolloSignal.Transport.Response.md): Response data retained for successful operations.
- [ApolloSignal.Transport.SSEEvent](ApolloSignal.Transport.SSEEvent.md): One decoded Server-Sent Event.
- [ApolloSignal.Transport.SSEStream](ApolloSignal.Transport.SSEStream.md): Lazy enumerable of SSE events and the opening response metadata.
- [ApolloSignal.Types](ApolloSignal.Types.md): Typed models and JSON conversion helpers for Apollo Signal API.
- [ApolloSignal.Types.ActivityMetadataResponse](ApolloSignal.Types.ActivityMetadataResponse.md): Typed ActivityMetadataResponse model.
- [ApolloSignal.Types.ActivityResponse](ApolloSignal.Types.ActivityResponse.md): Typed ActivityResponse model.
- [ApolloSignal.Types.AddSuppressionBody](ApolloSignal.Types.AddSuppressionBody.md): Typed AddSuppressionBody model.
- [ApolloSignal.Types.AddToSegmentBody](ApolloSignal.Types.AddToSegmentBody.md): Typed AddToSegmentBody model.
- [ApolloSignal.Types.AdvisorRecommendationDataResponse](ApolloSignal.Types.AdvisorRecommendationDataResponse.md): Typed AdvisorRecommendationDataResponse model.
- [ApolloSignal.Types.AdvisorRecommendationResponse](ApolloSignal.Types.AdvisorRecommendationResponse.md): Typed AdvisorRecommendationResponse model.
- [ApolloSignal.Types.AdvisorReportResponse](ApolloSignal.Types.AdvisorReportResponse.md): Typed AdvisorReportResponse model.
- [ApolloSignal.Types.ApiKey](ApolloSignal.Types.ApiKey.md): Typed ApiKey model.
- [ApolloSignal.Types.ApiKeyUsageRecord](ApolloSignal.Types.ApiKeyUsageRecord.md): Typed ApiKeyUsageRecord model.
- [ApolloSignal.Types.ApiKeyUsageResponse](ApolloSignal.Types.ApiKeyUsageResponse.md): Typed ApiKeyUsageResponse model.
- [ApolloSignal.Types.AttachmentRequest](ApolloSignal.Types.AttachmentRequest.md): Typed AttachmentRequest model.
- [ApolloSignal.Types.BatchSendItemResponse](ApolloSignal.Types.BatchSendItemResponse.md): Typed BatchSendItemResponse model.
- [ApolloSignal.Types.BatchSendRequest](ApolloSignal.Types.BatchSendRequest.md): Typed BatchSendRequest model.
- [ApolloSignal.Types.BatchSendResponse](ApolloSignal.Types.BatchSendResponse.md): Typed BatchSendResponse model.
- [ApolloSignal.Types.BulkCancelResponse](ApolloSignal.Types.BulkCancelResponse.md): Typed BulkCancelResponse model.
- [ApolloSignal.Types.CancelResponse](ApolloSignal.Types.CancelResponse.md): Typed CancelResponse model.
- [ApolloSignal.Types.ContactPageResponse](ApolloSignal.Types.ContactPageResponse.md): Typed ContactPageResponse model.
- [ApolloSignal.Types.ContactPropertyPageResponse](ApolloSignal.Types.ContactPropertyPageResponse.md): Typed ContactPropertyPageResponse model.
- [ApolloSignal.Types.ContactPropertyResponse](ApolloSignal.Types.ContactPropertyResponse.md): Typed ContactPropertyResponse model.
- [ApolloSignal.Types.ContactResponse](ApolloSignal.Types.ContactResponse.md): Typed ContactResponse model.
- [ApolloSignal.Types.CreateContactBody](ApolloSignal.Types.CreateContactBody.md): Typed CreateContactBody model.
- [ApolloSignal.Types.CreateContactPropertyBody](ApolloSignal.Types.CreateContactPropertyBody.md): Typed CreateContactPropertyBody model.
- [ApolloSignal.Types.CreateSegmentBody](ApolloSignal.Types.CreateSegmentBody.md): Typed CreateSegmentBody model.
- [ApolloSignal.Types.CreateTopicBody](ApolloSignal.Types.CreateTopicBody.md): Typed CreateTopicBody model.
- [ApolloSignal.Types.CreateWebhookBody](ApolloSignal.Types.CreateWebhookBody.md): Typed CreateWebhookBody model.
- [ApolloSignal.Types.CursorInfo](ApolloSignal.Types.CursorInfo.md): Typed CursorInfo model.
- [ApolloSignal.Types.CursorPage](ApolloSignal.Types.CursorPage.md): Typed CursorPage model.
- [ApolloSignal.Types.DeliveryWindowRequest](ApolloSignal.Types.DeliveryWindowRequest.md): Typed DeliveryWindowRequest model.
- [ApolloSignal.Types.DkimRecordResponse](ApolloSignal.Types.DkimRecordResponse.md): Typed DkimRecordResponse model.
- [ApolloSignal.Types.DnsRecordResponse](ApolloSignal.Types.DnsRecordResponse.md): Typed DnsRecordResponse model.
- [ApolloSignal.Types.DomainListItemResponse](ApolloSignal.Types.DomainListItemResponse.md): Typed DomainListItemResponse model.
- [ApolloSignal.Types.DomainListPageResponse](ApolloSignal.Types.DomainListPageResponse.md): Typed DomainListPageResponse model.
- [ApolloSignal.Types.DomainResponse](ApolloSignal.Types.DomainResponse.md): Typed DomainResponse model.
- [ApolloSignal.Types.EmailDetailResponse](ApolloSignal.Types.EmailDetailResponse.md): Typed EmailDetailResponse model.
- [ApolloSignal.Types.EmailPageResponse](ApolloSignal.Types.EmailPageResponse.md): Typed EmailPageResponse model.
- [ApolloSignal.Types.EmailPerformanceResponse](ApolloSignal.Types.EmailPerformanceResponse.md): Typed EmailPerformanceResponse model.
- [ApolloSignal.Types.EmailReadScrollAnalyticsResponse](ApolloSignal.Types.EmailReadScrollAnalyticsResponse.md): Typed EmailReadScrollAnalyticsResponse model.
- [ApolloSignal.Types.EmailTimelineItem](ApolloSignal.Types.EmailTimelineItem.md): Typed EmailTimelineItem model.
- [ApolloSignal.Types.EmailTimelineResponse](ApolloSignal.Types.EmailTimelineResponse.md): Typed EmailTimelineResponse model.
- [ApolloSignal.Types.EmailValidationStatusInput](ApolloSignal.Types.EmailValidationStatusInput.md): Typed EmailValidationStatusInput enum.
- [ApolloSignal.Types.EmailValidationStatusResponse](ApolloSignal.Types.EmailValidationStatusResponse.md): Typed EmailValidationStatusResponse model.
- [ApolloSignal.Types.EngagementScoreResponse](ApolloSignal.Types.EngagementScoreResponse.md): Typed EngagementScoreResponse model.
- [ApolloSignal.Types.GetMetricsAdvisorQuery](ApolloSignal.Types.GetMetricsAdvisorQuery.md): Typed GetMetricsAdvisorQuery model.
- [ApolloSignal.Types.GetProjectMetricsSummaryQuery](ApolloSignal.Types.GetProjectMetricsSummaryQuery.md): Typed GetProjectMetricsSummaryQuery model.
- [ApolloSignal.Types.GetProjectMetricsTimelineQuery](ApolloSignal.Types.GetProjectMetricsTimelineQuery.md): Typed GetProjectMetricsTimelineQuery model.
- [ApolloSignal.Types.GetTopicPerformanceQuery](ApolloSignal.Types.GetTopicPerformanceQuery.md): Typed GetTopicPerformanceQuery model.
- [ApolloSignal.Types.LinkResultItem](ApolloSignal.Types.LinkResultItem.md): Typed LinkResultItem model.
- [ApolloSignal.Types.ListApiKeysResponse](ApolloSignal.Types.ListApiKeysResponse.md): Typed ListApiKeysResponse model.
- [ApolloSignal.Types.MetricsWindowResponse](ApolloSignal.Types.MetricsWindowResponse.md): Typed MetricsWindowResponse model.
- [ApolloSignal.Types.PageInfo](ApolloSignal.Types.PageInfo.md): Typed PageInfo model.
- [ApolloSignal.Types.ProjectLimitsModel](ApolloSignal.Types.ProjectLimitsModel.md): Typed ProjectLimitsModel model.
- [ApolloSignal.Types.ProjectMetricsSummaryResponse](ApolloSignal.Types.ProjectMetricsSummaryResponse.md): Typed ProjectMetricsSummaryResponse model.
- [ApolloSignal.Types.ProjectMetricsTimelineResponse](ApolloSignal.Types.ProjectMetricsTimelineResponse.md): Typed ProjectMetricsTimelineResponse model.
- [ApolloSignal.Types.ProjectPageResponse](ApolloSignal.Types.ProjectPageResponse.md): Typed ProjectPageResponse model.
- [ApolloSignal.Types.ProjectResponse](ApolloSignal.Types.ProjectResponse.md): Typed ProjectResponse model.
- [ApolloSignal.Types.ProjectTimelineBucketResponse](ApolloSignal.Types.ProjectTimelineBucketResponse.md): Typed ProjectTimelineBucketResponse model.
- [ApolloSignal.Types.ProjectTrackingSettingsModel](ApolloSignal.Types.ProjectTrackingSettingsModel.md): Typed ProjectTrackingSettingsModel model.
- [ApolloSignal.Types.RecordValidationBody](ApolloSignal.Types.RecordValidationBody.md): Typed RecordValidationBody model.
- [ApolloSignal.Types.RegisterDomainRequest](ApolloSignal.Types.RegisterDomainRequest.md): Typed RegisterDomainRequest model.
- [ApolloSignal.Types.SegmentContactResponse](ApolloSignal.Types.SegmentContactResponse.md): Typed SegmentContactResponse model.
- [ApolloSignal.Types.SegmentPageResponse](ApolloSignal.Types.SegmentPageResponse.md): Typed SegmentPageResponse model.
- [ApolloSignal.Types.SegmentRef](ApolloSignal.Types.SegmentRef.md): Typed SegmentRef model.
- [ApolloSignal.Types.SegmentResponse](ApolloSignal.Types.SegmentResponse.md): Typed SegmentResponse model.
- [ApolloSignal.Types.SendEmailRequest](ApolloSignal.Types.SendEmailRequest.md): Typed SendEmailRequest model.
- [ApolloSignal.Types.SendEmailResponse](ApolloSignal.Types.SendEmailResponse.md): Typed SendEmailResponse model.
- [ApolloSignal.Types.SetImageUrlBody](ApolloSignal.Types.SetImageUrlBody.md): Typed SetImageUrlBody model.
- [ApolloSignal.Types.StreamEventResponse](ApolloSignal.Types.StreamEventResponse.md): Typed StreamEventResponse model.
- [ApolloSignal.Types.StreamTokenResponse](ApolloSignal.Types.StreamTokenResponse.md): Typed StreamTokenResponse model.
- [ApolloSignal.Types.SuppressionImportBody](ApolloSignal.Types.SuppressionImportBody.md): Typed SuppressionImportBody model.
- [ApolloSignal.Types.SuppressionImportResponse](ApolloSignal.Types.SuppressionImportResponse.md): Typed SuppressionImportResponse model.
- [ApolloSignal.Types.SuppressionImportRowSerializable](ApolloSignal.Types.SuppressionImportRowSerializable.md): Typed SuppressionImportRowSerializable model.
- [ApolloSignal.Types.SuppressionPageResponse](ApolloSignal.Types.SuppressionPageResponse.md): Typed SuppressionPageResponse model.
- [ApolloSignal.Types.SuppressionResponse](ApolloSignal.Types.SuppressionResponse.md): Typed SuppressionResponse model.
- [ApolloSignal.Types.TopicPageResponse](ApolloSignal.Types.TopicPageResponse.md): Typed TopicPageResponse model.
- [ApolloSignal.Types.TopicPerformanceResponse](ApolloSignal.Types.TopicPerformanceResponse.md): Typed TopicPerformanceResponse model.
- [ApolloSignal.Types.TopicResponse](ApolloSignal.Types.TopicResponse.md): Typed TopicResponse model.
- [ApolloSignal.Types.TopicSubscriptionBody](ApolloSignal.Types.TopicSubscriptionBody.md): Typed TopicSubscriptionBody model.
- [ApolloSignal.Types.TopicSubscriptionResponse](ApolloSignal.Types.TopicSubscriptionResponse.md): Typed TopicSubscriptionResponse model.
- [ApolloSignal.Types.TrackingSettingsRequest](ApolloSignal.Types.TrackingSettingsRequest.md): Typed TrackingSettingsRequest model.
- [ApolloSignal.Types.UpdateBimiRequest](ApolloSignal.Types.UpdateBimiRequest.md): Typed UpdateBimiRequest model.
- [ApolloSignal.Types.UpdateContactBody](ApolloSignal.Types.UpdateContactBody.md): Typed UpdateContactBody model.
- [ApolloSignal.Types.UpdateContactPropertyBody](ApolloSignal.Types.UpdateContactPropertyBody.md): Typed UpdateContactPropertyBody model.
- [ApolloSignal.Types.UpdateProjectRequest](ApolloSignal.Types.UpdateProjectRequest.md): Typed UpdateProjectRequest model.
- [ApolloSignal.Types.UpdateTopicBody](ApolloSignal.Types.UpdateTopicBody.md): Typed UpdateTopicBody model.
- [ApolloSignal.Types.UpdateTopicsBody](ApolloSignal.Types.UpdateTopicsBody.md): Typed UpdateTopicsBody model.
- [ApolloSignal.Types.UpdateWebhookBody](ApolloSignal.Types.UpdateWebhookBody.md): Typed UpdateWebhookBody model.
- [ApolloSignal.Types.UsagePage](ApolloSignal.Types.UsagePage.md): Typed UsagePage model.
- [ApolloSignal.Types.ValidateLinksRequest](ApolloSignal.Types.ValidateLinksRequest.md): Typed ValidateLinksRequest model.
- [ApolloSignal.Types.ValidateLinksResponse](ApolloSignal.Types.ValidateLinksResponse.md): Typed ValidateLinksResponse model.
- [ApolloSignal.Types.VerificationRecordsResponse](ApolloSignal.Types.VerificationRecordsResponse.md): Typed VerificationRecordsResponse model.
- [ApolloSignal.Types.WebhookCreateResponse](ApolloSignal.Types.WebhookCreateResponse.md): Typed WebhookCreateResponse model.
- [ApolloSignal.Types.WebhookDeliveryPageResponse](ApolloSignal.Types.WebhookDeliveryPageResponse.md): Typed WebhookDeliveryPageResponse model.
- [ApolloSignal.Types.WebhookDeliveryResponse](ApolloSignal.Types.WebhookDeliveryResponse.md): Typed WebhookDeliveryResponse model.
- [ApolloSignal.Types.WebhookFilterSerializable](ApolloSignal.Types.WebhookFilterSerializable.md): Typed WebhookFilterSerializable model.
- [ApolloSignal.Types.WebhookPageResponse](ApolloSignal.Types.WebhookPageResponse.md): Typed WebhookPageResponse model.
- [ApolloSignal.Types.WebhookResponse](ApolloSignal.Types.WebhookResponse.md): Typed WebhookResponse model.
- [ApolloSignal.Types.WebhookTransformationSerializable](ApolloSignal.Types.WebhookTransformationSerializable.md): Typed WebhookTransformationSerializable model.

- Exceptions
  - [ApolloSignal.Errors](ApolloSignal.Errors.md): Structured API and transport errors for Apollo Signal API.

