Typed models and JSON conversion helpers for Apollo Signal API.
Summary
Types
@type from_get_contact_activity_response() :: [ ApolloSignal.Types.ActivityResponse.t() ]
@type from_get_contact_topics_response() :: [ ApolloSignal.Types.TopicSubscriptionResponse.t() ]
@type from_list_contact_segments_response() :: [String.t()]
@type json_value() :: nil | boolean() | number() | String.t() | [json_value()] | map()
Functions
@spec from_activity_metadata_response(term()) :: ApolloSignal.Types.ActivityMetadataResponse.t()
@spec from_activity_response(term()) :: ApolloSignal.Types.ActivityResponse.t()
@spec from_add_suppression_body(term()) :: ApolloSignal.Types.AddSuppressionBody.t()
@spec from_add_to_segment_body(term()) :: ApolloSignal.Types.AddToSegmentBody.t()
@spec from_advisor_recommendation_data_response(term()) :: ApolloSignal.Types.AdvisorRecommendationDataResponse.t()
@spec from_advisor_recommendation_response(term()) :: ApolloSignal.Types.AdvisorRecommendationResponse.t()
@spec from_advisor_report_response(term()) :: ApolloSignal.Types.AdvisorReportResponse.t()
@spec from_api_key(term()) :: ApolloSignal.Types.ApiKey.t()
@spec from_api_key_usage_record(term()) :: ApolloSignal.Types.ApiKeyUsageRecord.t()
@spec from_api_key_usage_response(term()) :: ApolloSignal.Types.ApiKeyUsageResponse.t()
@spec from_attachment_request(term()) :: ApolloSignal.Types.AttachmentRequest.t()
@spec from_batch_send_item_response(term()) :: ApolloSignal.Types.BatchSendItemResponse.t()
@spec from_batch_send_request(term()) :: ApolloSignal.Types.BatchSendRequest.t()
@spec from_batch_send_response(term()) :: ApolloSignal.Types.BatchSendResponse.t()
@spec from_bulk_cancel_response(term()) :: ApolloSignal.Types.BulkCancelResponse.t()
@spec from_cancel_response(term()) :: ApolloSignal.Types.CancelResponse.t()
@spec from_contact_page_response(term()) :: ApolloSignal.Types.ContactPageResponse.t()
@spec from_contact_property_page_response(term()) :: ApolloSignal.Types.ContactPropertyPageResponse.t()
@spec from_contact_property_response(term()) :: ApolloSignal.Types.ContactPropertyResponse.t()
@spec from_contact_response(term()) :: ApolloSignal.Types.ContactResponse.t()
@spec from_create_contact_body(term()) :: ApolloSignal.Types.CreateContactBody.t()
@spec from_create_contact_property_body(term()) :: ApolloSignal.Types.CreateContactPropertyBody.t()
@spec from_create_segment_body(term()) :: ApolloSignal.Types.CreateSegmentBody.t()
@spec from_create_topic_body(term()) :: ApolloSignal.Types.CreateTopicBody.t()
@spec from_create_webhook_body(term()) :: ApolloSignal.Types.CreateWebhookBody.t()
@spec from_cursor_info(term()) :: ApolloSignal.Types.CursorInfo.t()
@spec from_cursor_page(term()) :: ApolloSignal.Types.CursorPage.t()
@spec from_delivery_window_request(term()) :: ApolloSignal.Types.DeliveryWindowRequest.t()
@spec from_dkim_record_response(term()) :: ApolloSignal.Types.DkimRecordResponse.t()
@spec from_dns_record_response(term()) :: ApolloSignal.Types.DnsRecordResponse.t()
@spec from_domain_list_item_response(term()) :: ApolloSignal.Types.DomainListItemResponse.t()
@spec from_domain_list_page_response(term()) :: ApolloSignal.Types.DomainListPageResponse.t()
@spec from_domain_response(term()) :: ApolloSignal.Types.DomainResponse.t()
@spec from_email_detail_response(term()) :: ApolloSignal.Types.EmailDetailResponse.t()
@spec from_email_page_response(term()) :: ApolloSignal.Types.EmailPageResponse.t()
@spec from_email_performance_response(term()) :: ApolloSignal.Types.EmailPerformanceResponse.t()
@spec from_email_read_scroll_analytics_response(term()) :: ApolloSignal.Types.EmailReadScrollAnalyticsResponse.t()
@spec from_email_timeline_item(term()) :: ApolloSignal.Types.EmailTimelineItem.t()
@spec from_email_timeline_response(term()) :: ApolloSignal.Types.EmailTimelineResponse.t()
@spec from_email_validation_status_input(term()) :: ApolloSignal.Types.EmailValidationStatusInput.t()
@spec from_email_validation_status_response(term()) :: ApolloSignal.Types.EmailValidationStatusResponse.t()
@spec from_engagement_score_response(term()) :: ApolloSignal.Types.EngagementScoreResponse.t()
@spec from_get_contact_activity_response(term()) :: from_get_contact_activity_response()
@spec from_get_contact_topics_response(term()) :: from_get_contact_topics_response()
@spec from_get_metrics_advisor_query(term()) :: ApolloSignal.Types.GetMetricsAdvisorQuery.t()
@spec from_get_project_metrics_summary_query(term()) :: ApolloSignal.Types.GetProjectMetricsSummaryQuery.t()
@spec from_get_project_metrics_timeline_query(term()) :: ApolloSignal.Types.GetProjectMetricsTimelineQuery.t()
@spec from_get_topic_performance_query(term()) :: ApolloSignal.Types.GetTopicPerformanceQuery.t()
@spec from_link_result_item(term()) :: ApolloSignal.Types.LinkResultItem.t()
@spec from_list_api_keys_response(term()) :: ApolloSignal.Types.ListApiKeysResponse.t()
@spec from_list_contact_segments_response(term()) :: from_list_contact_segments_response()
@spec from_metrics_window_response(term()) :: ApolloSignal.Types.MetricsWindowResponse.t()
@spec from_page_info(term()) :: ApolloSignal.Types.PageInfo.t()
@spec from_project_limits_model(term()) :: ApolloSignal.Types.ProjectLimitsModel.t()
@spec from_project_metrics_summary_response(term()) :: ApolloSignal.Types.ProjectMetricsSummaryResponse.t()
@spec from_project_metrics_timeline_response(term()) :: ApolloSignal.Types.ProjectMetricsTimelineResponse.t()
@spec from_project_page_response(term()) :: ApolloSignal.Types.ProjectPageResponse.t()
@spec from_project_response(term()) :: ApolloSignal.Types.ProjectResponse.t()
@spec from_project_timeline_bucket_response(term()) :: ApolloSignal.Types.ProjectTimelineBucketResponse.t()
@spec from_project_tracking_settings_model(term()) :: ApolloSignal.Types.ProjectTrackingSettingsModel.t()
@spec from_record_validation_body(term()) :: ApolloSignal.Types.RecordValidationBody.t()
@spec from_register_domain_request(term()) :: ApolloSignal.Types.RegisterDomainRequest.t()
@spec from_segment_contact_response(term()) :: ApolloSignal.Types.SegmentContactResponse.t()
@spec from_segment_page_response(term()) :: ApolloSignal.Types.SegmentPageResponse.t()
@spec from_segment_ref(term()) :: ApolloSignal.Types.SegmentRef.t()
@spec from_segment_response(term()) :: ApolloSignal.Types.SegmentResponse.t()
@spec from_send_email_request(term()) :: ApolloSignal.Types.SendEmailRequest.t()
@spec from_send_email_response(term()) :: ApolloSignal.Types.SendEmailResponse.t()
@spec from_set_image_url_body(term()) :: ApolloSignal.Types.SetImageUrlBody.t()
@spec from_stream_event_response(term()) :: ApolloSignal.Types.StreamEventResponse.t()
@spec from_stream_token_response(term()) :: ApolloSignal.Types.StreamTokenResponse.t()
@spec from_suppression_import_body(term()) :: ApolloSignal.Types.SuppressionImportBody.t()
@spec from_suppression_import_response(term()) :: ApolloSignal.Types.SuppressionImportResponse.t()
@spec from_suppression_import_row_serializable(term()) :: ApolloSignal.Types.SuppressionImportRowSerializable.t()
@spec from_suppression_page_response(term()) :: ApolloSignal.Types.SuppressionPageResponse.t()
@spec from_suppression_response(term()) :: ApolloSignal.Types.SuppressionResponse.t()
@spec from_topic_page_response(term()) :: ApolloSignal.Types.TopicPageResponse.t()
@spec from_topic_performance_response(term()) :: ApolloSignal.Types.TopicPerformanceResponse.t()
@spec from_topic_response(term()) :: ApolloSignal.Types.TopicResponse.t()
@spec from_topic_subscription_body(term()) :: ApolloSignal.Types.TopicSubscriptionBody.t()
@spec from_topic_subscription_response(term()) :: ApolloSignal.Types.TopicSubscriptionResponse.t()
@spec from_tracking_settings_request(term()) :: ApolloSignal.Types.TrackingSettingsRequest.t()
@spec from_update_bimi_request(term()) :: ApolloSignal.Types.UpdateBimiRequest.t()
@spec from_update_contact_body(term()) :: ApolloSignal.Types.UpdateContactBody.t()
@spec from_update_contact_property_body(term()) :: ApolloSignal.Types.UpdateContactPropertyBody.t()
@spec from_update_project_request(term()) :: ApolloSignal.Types.UpdateProjectRequest.t()
@spec from_update_topic_body(term()) :: ApolloSignal.Types.UpdateTopicBody.t()
@spec from_update_topics_body(term()) :: ApolloSignal.Types.UpdateTopicsBody.t()
@spec from_update_webhook_body(term()) :: ApolloSignal.Types.UpdateWebhookBody.t()
@spec from_usage_page(term()) :: ApolloSignal.Types.UsagePage.t()
@spec from_validate_links_request(term()) :: ApolloSignal.Types.ValidateLinksRequest.t()
@spec from_validate_links_response(term()) :: ApolloSignal.Types.ValidateLinksResponse.t()
@spec from_verification_records_response(term()) :: ApolloSignal.Types.VerificationRecordsResponse.t()
@spec from_webhook_create_response(term()) :: ApolloSignal.Types.WebhookCreateResponse.t()
@spec from_webhook_delivery_page_response(term()) :: ApolloSignal.Types.WebhookDeliveryPageResponse.t()
@spec from_webhook_delivery_response(term()) :: ApolloSignal.Types.WebhookDeliveryResponse.t()
@spec from_webhook_filter_serializable(term()) :: ApolloSignal.Types.WebhookFilterSerializable.t()
@spec from_webhook_page_response(term()) :: ApolloSignal.Types.WebhookPageResponse.t()
@spec from_webhook_response(term()) :: ApolloSignal.Types.WebhookResponse.t()
@spec from_webhook_transformation_serializable(term()) :: ApolloSignal.Types.WebhookTransformationSerializable.t()