ApolloSignal.Types (apollo_signal v1.0.5)

Copy Markdown View Source

Typed models and JSON conversion helpers for Apollo Signal API.

Summary

Functions

Types

from_get_contact_activity_response()

@type from_get_contact_activity_response() :: [
  ApolloSignal.Types.ActivityResponse.t()
]

from_get_contact_topics_response()

@type from_get_contact_topics_response() :: [
  ApolloSignal.Types.TopicSubscriptionResponse.t()
]

from_list_contact_segments_response()

@type from_list_contact_segments_response() :: [String.t()]

json_value()

@type json_value() :: nil | boolean() | number() | String.t() | [json_value()] | map()

Functions

decode_enum(value, pairs)

@spec decode_enum(term(), [{term(), term()}]) :: term()

decode_list(values, decoder)

@spec decode_list(term(), (term() -> term())) :: term()

decode_map(values, decoder)

@spec decode_map(term(), (term() -> term())) :: term()

decode_nullable(value, decoder)

@spec decode_nullable(term(), (term() -> term())) :: term()

decode_union(value, decoders)

@spec decode_union(term(), [(term() -> term())]) :: term()

encode(value)

extra_fields(data, known_fields)

@spec extra_fields(map(), [String.t()]) :: map()

field(data, key, atom)

@spec field(map(), String.t(), atom()) :: term()

from_activity_metadata_response(value)

@spec from_activity_metadata_response(term()) ::
  ApolloSignal.Types.ActivityMetadataResponse.t()

from_activity_response(value)

@spec from_activity_response(term()) :: ApolloSignal.Types.ActivityResponse.t()

from_add_suppression_body(value)

@spec from_add_suppression_body(term()) :: ApolloSignal.Types.AddSuppressionBody.t()

from_add_to_segment_body(value)

@spec from_add_to_segment_body(term()) :: ApolloSignal.Types.AddToSegmentBody.t()

from_advisor_recommendation_data_response(value)

@spec from_advisor_recommendation_data_response(term()) ::
  ApolloSignal.Types.AdvisorRecommendationDataResponse.t()

from_advisor_recommendation_response(value)

@spec from_advisor_recommendation_response(term()) ::
  ApolloSignal.Types.AdvisorRecommendationResponse.t()

from_advisor_report_response(value)

@spec from_advisor_report_response(term()) ::
  ApolloSignal.Types.AdvisorReportResponse.t()

from_api_key(value)

@spec from_api_key(term()) :: ApolloSignal.Types.ApiKey.t()

from_api_key_usage_record(value)

@spec from_api_key_usage_record(term()) :: ApolloSignal.Types.ApiKeyUsageRecord.t()

from_api_key_usage_response(value)

@spec from_api_key_usage_response(term()) ::
  ApolloSignal.Types.ApiKeyUsageResponse.t()

from_attachment_request(value)

@spec from_attachment_request(term()) :: ApolloSignal.Types.AttachmentRequest.t()

from_batch_send_item_response(value)

@spec from_batch_send_item_response(term()) ::
  ApolloSignal.Types.BatchSendItemResponse.t()

from_batch_send_request(value)

@spec from_batch_send_request(term()) :: ApolloSignal.Types.BatchSendRequest.t()

from_batch_send_response(value)

@spec from_batch_send_response(term()) :: ApolloSignal.Types.BatchSendResponse.t()

from_bulk_cancel_response(value)

@spec from_bulk_cancel_response(term()) :: ApolloSignal.Types.BulkCancelResponse.t()

from_cancel_response(value)

@spec from_cancel_response(term()) :: ApolloSignal.Types.CancelResponse.t()

from_contact_page_response(value)

@spec from_contact_page_response(term()) :: ApolloSignal.Types.ContactPageResponse.t()

from_contact_property_page_response(value)

@spec from_contact_property_page_response(term()) ::
  ApolloSignal.Types.ContactPropertyPageResponse.t()

from_contact_property_response(value)

@spec from_contact_property_response(term()) ::
  ApolloSignal.Types.ContactPropertyResponse.t()

from_contact_response(value)

@spec from_contact_response(term()) :: ApolloSignal.Types.ContactResponse.t()

from_create_contact_body(value)

@spec from_create_contact_body(term()) :: ApolloSignal.Types.CreateContactBody.t()

from_create_contact_property_body(value)

@spec from_create_contact_property_body(term()) ::
  ApolloSignal.Types.CreateContactPropertyBody.t()

from_create_segment_body(value)

@spec from_create_segment_body(term()) :: ApolloSignal.Types.CreateSegmentBody.t()

from_create_topic_body(value)

@spec from_create_topic_body(term()) :: ApolloSignal.Types.CreateTopicBody.t()

from_create_webhook_body(value)

@spec from_create_webhook_body(term()) :: ApolloSignal.Types.CreateWebhookBody.t()

from_cursor_info(value)

@spec from_cursor_info(term()) :: ApolloSignal.Types.CursorInfo.t()

from_cursor_page(value)

@spec from_cursor_page(term()) :: ApolloSignal.Types.CursorPage.t()

from_delivery_window_request(value)

@spec from_delivery_window_request(term()) ::
  ApolloSignal.Types.DeliveryWindowRequest.t()

from_dkim_record_response(value)

@spec from_dkim_record_response(term()) :: ApolloSignal.Types.DkimRecordResponse.t()

from_dns_record_response(value)

@spec from_dns_record_response(term()) :: ApolloSignal.Types.DnsRecordResponse.t()

from_domain_list_item_response(value)

@spec from_domain_list_item_response(term()) ::
  ApolloSignal.Types.DomainListItemResponse.t()

from_domain_list_page_response(value)

@spec from_domain_list_page_response(term()) ::
  ApolloSignal.Types.DomainListPageResponse.t()

from_domain_response(value)

@spec from_domain_response(term()) :: ApolloSignal.Types.DomainResponse.t()

from_email_detail_response(value)

@spec from_email_detail_response(term()) :: ApolloSignal.Types.EmailDetailResponse.t()

from_email_page_response(value)

@spec from_email_page_response(term()) :: ApolloSignal.Types.EmailPageResponse.t()

from_email_performance_response(value)

@spec from_email_performance_response(term()) ::
  ApolloSignal.Types.EmailPerformanceResponse.t()

from_email_read_scroll_analytics_response(value)

@spec from_email_read_scroll_analytics_response(term()) ::
  ApolloSignal.Types.EmailReadScrollAnalyticsResponse.t()

from_email_timeline_item(value)

@spec from_email_timeline_item(term()) :: ApolloSignal.Types.EmailTimelineItem.t()

from_email_timeline_response(value)

@spec from_email_timeline_response(term()) ::
  ApolloSignal.Types.EmailTimelineResponse.t()

from_email_validation_status_input(value)

@spec from_email_validation_status_input(term()) ::
  ApolloSignal.Types.EmailValidationStatusInput.t()

from_email_validation_status_response(value)

@spec from_email_validation_status_response(term()) ::
  ApolloSignal.Types.EmailValidationStatusResponse.t()

from_engagement_score_response(value)

@spec from_engagement_score_response(term()) ::
  ApolloSignal.Types.EngagementScoreResponse.t()

from_get_contact_activity_response(value)

@spec from_get_contact_activity_response(term()) ::
  from_get_contact_activity_response()

from_get_contact_topics_response(value)

@spec from_get_contact_topics_response(term()) :: from_get_contact_topics_response()

from_get_metrics_advisor_query(value)

@spec from_get_metrics_advisor_query(term()) ::
  ApolloSignal.Types.GetMetricsAdvisorQuery.t()

from_get_project_metrics_summary_query(value)

@spec from_get_project_metrics_summary_query(term()) ::
  ApolloSignal.Types.GetProjectMetricsSummaryQuery.t()

from_get_project_metrics_timeline_query(value)

@spec from_get_project_metrics_timeline_query(term()) ::
  ApolloSignal.Types.GetProjectMetricsTimelineQuery.t()

from_get_topic_performance_query(value)

@spec from_get_topic_performance_query(term()) ::
  ApolloSignal.Types.GetTopicPerformanceQuery.t()

from_list_api_keys_response(value)

@spec from_list_api_keys_response(term()) ::
  ApolloSignal.Types.ListApiKeysResponse.t()

from_list_contact_segments_response(value)

@spec from_list_contact_segments_response(term()) ::
  from_list_contact_segments_response()

from_metrics_window_response(value)

@spec from_metrics_window_response(term()) ::
  ApolloSignal.Types.MetricsWindowResponse.t()

from_page_info(value)

@spec from_page_info(term()) :: ApolloSignal.Types.PageInfo.t()

from_project_limits_model(value)

@spec from_project_limits_model(term()) :: ApolloSignal.Types.ProjectLimitsModel.t()

from_project_metrics_summary_response(value)

@spec from_project_metrics_summary_response(term()) ::
  ApolloSignal.Types.ProjectMetricsSummaryResponse.t()

from_project_metrics_timeline_response(value)

@spec from_project_metrics_timeline_response(term()) ::
  ApolloSignal.Types.ProjectMetricsTimelineResponse.t()

from_project_page_response(value)

@spec from_project_page_response(term()) :: ApolloSignal.Types.ProjectPageResponse.t()

from_project_response(value)

@spec from_project_response(term()) :: ApolloSignal.Types.ProjectResponse.t()

from_project_timeline_bucket_response(value)

@spec from_project_timeline_bucket_response(term()) ::
  ApolloSignal.Types.ProjectTimelineBucketResponse.t()

from_project_tracking_settings_model(value)

@spec from_project_tracking_settings_model(term()) ::
  ApolloSignal.Types.ProjectTrackingSettingsModel.t()

from_record_validation_body(value)

@spec from_record_validation_body(term()) ::
  ApolloSignal.Types.RecordValidationBody.t()

from_register_domain_request(value)

@spec from_register_domain_request(term()) ::
  ApolloSignal.Types.RegisterDomainRequest.t()

from_segment_contact_response(value)

@spec from_segment_contact_response(term()) ::
  ApolloSignal.Types.SegmentContactResponse.t()

from_segment_page_response(value)

@spec from_segment_page_response(term()) :: ApolloSignal.Types.SegmentPageResponse.t()

from_segment_ref(value)

@spec from_segment_ref(term()) :: ApolloSignal.Types.SegmentRef.t()

from_segment_response(value)

@spec from_segment_response(term()) :: ApolloSignal.Types.SegmentResponse.t()

from_send_email_request(value)

@spec from_send_email_request(term()) :: ApolloSignal.Types.SendEmailRequest.t()

from_send_email_response(value)

@spec from_send_email_response(term()) :: ApolloSignal.Types.SendEmailResponse.t()

from_set_image_url_body(value)

@spec from_set_image_url_body(term()) :: ApolloSignal.Types.SetImageUrlBody.t()

from_stream_event_response(value)

@spec from_stream_event_response(term()) :: ApolloSignal.Types.StreamEventResponse.t()

from_stream_token_response(value)

@spec from_stream_token_response(term()) :: ApolloSignal.Types.StreamTokenResponse.t()

from_suppression_import_body(value)

@spec from_suppression_import_body(term()) ::
  ApolloSignal.Types.SuppressionImportBody.t()

from_suppression_import_response(value)

@spec from_suppression_import_response(term()) ::
  ApolloSignal.Types.SuppressionImportResponse.t()

from_suppression_import_row_serializable(value)

@spec from_suppression_import_row_serializable(term()) ::
  ApolloSignal.Types.SuppressionImportRowSerializable.t()

from_suppression_page_response(value)

@spec from_suppression_page_response(term()) ::
  ApolloSignal.Types.SuppressionPageResponse.t()

from_suppression_response(value)

@spec from_suppression_response(term()) :: ApolloSignal.Types.SuppressionResponse.t()

from_topic_page_response(value)

@spec from_topic_page_response(term()) :: ApolloSignal.Types.TopicPageResponse.t()

from_topic_performance_response(value)

@spec from_topic_performance_response(term()) ::
  ApolloSignal.Types.TopicPerformanceResponse.t()

from_topic_response(value)

@spec from_topic_response(term()) :: ApolloSignal.Types.TopicResponse.t()

from_topic_subscription_body(value)

@spec from_topic_subscription_body(term()) ::
  ApolloSignal.Types.TopicSubscriptionBody.t()

from_topic_subscription_response(value)

@spec from_topic_subscription_response(term()) ::
  ApolloSignal.Types.TopicSubscriptionResponse.t()

from_tracking_settings_request(value)

@spec from_tracking_settings_request(term()) ::
  ApolloSignal.Types.TrackingSettingsRequest.t()

from_update_bimi_request(value)

@spec from_update_bimi_request(term()) :: ApolloSignal.Types.UpdateBimiRequest.t()

from_update_contact_body(value)

@spec from_update_contact_body(term()) :: ApolloSignal.Types.UpdateContactBody.t()

from_update_contact_property_body(value)

@spec from_update_contact_property_body(term()) ::
  ApolloSignal.Types.UpdateContactPropertyBody.t()

from_update_project_request(value)

@spec from_update_project_request(term()) ::
  ApolloSignal.Types.UpdateProjectRequest.t()

from_update_topic_body(value)

@spec from_update_topic_body(term()) :: ApolloSignal.Types.UpdateTopicBody.t()

from_update_topics_body(value)

@spec from_update_topics_body(term()) :: ApolloSignal.Types.UpdateTopicsBody.t()

from_update_webhook_body(value)

@spec from_update_webhook_body(term()) :: ApolloSignal.Types.UpdateWebhookBody.t()

from_usage_page(value)

@spec from_usage_page(term()) :: ApolloSignal.Types.UsagePage.t()

from_verification_records_response(value)

@spec from_verification_records_response(term()) ::
  ApolloSignal.Types.VerificationRecordsResponse.t()

from_webhook_create_response(value)

@spec from_webhook_create_response(term()) ::
  ApolloSignal.Types.WebhookCreateResponse.t()

from_webhook_delivery_page_response(value)

@spec from_webhook_delivery_page_response(term()) ::
  ApolloSignal.Types.WebhookDeliveryPageResponse.t()

from_webhook_delivery_response(value)

@spec from_webhook_delivery_response(term()) ::
  ApolloSignal.Types.WebhookDeliveryResponse.t()

from_webhook_filter_serializable(value)

@spec from_webhook_filter_serializable(term()) ::
  ApolloSignal.Types.WebhookFilterSerializable.t()

from_webhook_page_response(value)

@spec from_webhook_page_response(term()) :: ApolloSignal.Types.WebhookPageResponse.t()

from_webhook_response(value)

@spec from_webhook_response(term()) :: ApolloSignal.Types.WebhookResponse.t()

from_webhook_transformation_serializable(value)

@spec from_webhook_transformation_serializable(term()) ::
  ApolloSignal.Types.WebhookTransformationSerializable.t()

put_field(data, key, value, include_nil)

@spec put_field(map(), String.t(), term(), boolean()) :: map()