Module: Helo

Defined in:
lib/helo.rb,
lib/helo.rb,
lib/helo/client.rb,
lib/helo/version.rb,
lib/helo/api_error.rb,
lib/helo/apis/domains.rb,
lib/helo/apis/sending.rb,
lib/helo/apis/activity.rb,
lib/helo/apis/channels.rb,
lib/helo/apis/webhooks.rb,
lib/helo/configuration.rb,
lib/helo/models/message.rb,
lib/helo/apis/broadcasts.rb,
lib/helo/apis/statistics.rb,
lib/helo/enums/mail_type.rb,
lib/helo/enums/event_type.rb,
lib/helo/apis/suppressions.rb,
lib/helo/models/attachment.rb,
lib/helo/enums/delivery_type.rb,
lib/helo/enums/webhook_event.rb,
lib/helo/models/mail_address.rb,
lib/helo/enums/dns_record_type.rb,
lib/helo/models/activity_event.rb,
lib/helo/models/delivery_stats.rb,
lib/helo/models/error_response.rb,
lib/helo/models/webhook_header.rb,
lib/helo/enums/broadcast_status.rb,
lib/helo/models/domain_response.rb,
lib/helo/enums/dns_record_status.rb,
lib/helo/models/channel_tracking.rb,
lib/helo/models/validation_error.rb,
lib/helo/models/webhook_response.rb,
lib/helo/enums/suppression_reason.rb,
lib/helo/models/broadcast_content.rb,
lib/helo/models/recipient_headers.rb,
lib/helo/models/broadcast_response.rb,
lib/helo/models/broadcast_tracking.rb,
lib/helo/models/suppression_result.rb,
lib/helo/models/dns_record_response.rb,
lib/helo/models/broadcast_statistics.rb,
lib/helo/models/dns_records_response.rb,
lib/helo/models/domains_list_request.rb,
lib/helo/models/send_message_request.rb,
lib/helo/models/suppression_response.rb,
lib/helo/enums/attachment_disposition.rb,
lib/helo/models/activity_mail_address.rb,
lib/helo/models/channels_list_request.rb,
lib/helo/models/create_domain_request.rb,
lib/helo/models/send_message_response.rb,
lib/helo/models/update_domain_request.rb,
lib/helo/models/webhook_last_response.rb,
lib/helo/models/webhooks_list_request.rb,
lib/helo/models/channel_basic_response.rb,
lib/helo/models/create_channel_request.rb,
lib/helo/models/create_webhook_request.rb,
lib/helo/models/opened_webhook_payload.rb,
lib/helo/models/recipient_event_fields.rb,
lib/helo/models/send_broadcast_request.rb,
lib/helo/models/update_channel_request.rb,
lib/helo/models/update_webhook_request.rb,
lib/helo/models/webhook_payload_common.rb,
lib/helo/models/bounced_webhook_payload.rb,
lib/helo/models/broadcasts_list_request.rb,
lib/helo/models/clicked_webhook_payload.rb,
lib/helo/models/create_channel_tracking.rb,
lib/helo/models/domain_channel_response.rb,
lib/helo/models/send_broadcast_response.rb,
lib/helo/models/update_channel_tracking.rb,
lib/helo/models/accepted_webhook_payload.rb,
lib/helo/models/channel_details_response.rb,
lib/helo/models/domain_with_dns_response.rb,
lib/helo/models/message_details_response.rb,
lib/helo/models/delivered_webhook_payload.rb,
lib/helo/models/paginated_events_response.rb,
lib/helo/models/processed_webhook_payload.rb,
lib/helo/models/remove_suppression_result.rb,
lib/helo/models/statistics_daily_response.rb,
lib/helo/models/suppressions_list_request.rb,
lib/helo/models/broadcast_content_template.rb,
lib/helo/models/broadcast_details_response.rb,
lib/helo/models/broadcast_failure_response.rb,
lib/helo/models/complained_webhook_payload.rb,
lib/helo/models/send_message_batch_request.rb,
lib/helo/models/statistics_hourly_response.rb,
lib/helo/models/statistics_totals_response.rb,
lib/helo/models/create_suppressions_request.rb,
lib/helo/models/paginated_messages_response.rb,
lib/helo/models/remove_suppressions_request.rb,
lib/helo/models/send_message_batch_response.rb,
lib/helo/models/activity_list_events_request.rb,
lib/helo/models/broadcast_content_attachment.rb,
lib/helo/models/create_suppressions_response.rb,
lib/helo/models/remove_suppressions_response.rb,
lib/helo/models/resubscribed_webhook_payload.rb,
lib/helo/models/send_message_failed_response.rb,
lib/helo/models/unsubscribed_webhook_payload.rb,
lib/helo/models/send_message_request_template.rb,
lib/helo/models/send_message_request_tracking.rb,
lib/helo/models/activity_list_messages_request.rb,
lib/helo/models/message_details_response_event.rb,
lib/helo/models/send_broadcast_request_message.rb,
lib/helo/models/send_message_accepted_response.rb,
lib/helo/models/paginated_response_of_broadcast.rb,
lib/helo/models/send_broadcast_request_template.rb,
lib/helo/models/send_broadcast_request_tracking.rb,
lib/helo/models/broadcasts_list_failures_request.rb,
lib/helo/models/statistics_daily_response_result.rb,
lib/helo/models/message_details_response_tracking.rb,
lib/helo/models/statistics_hourly_response_result.rb,
lib/helo/models/statistics_retrieve_daily_request.rb,
lib/helo/models/statistics_retrieve_hourly_request.rb,
lib/helo/models/statistics_retrieve_totals_request.rb,
lib/helo/models/message_details_response_attachment.rb,
lib/helo/models/broadcasts_list_suppressions_request.rb,
lib/helo/models/paginated_response_of_domain_response.rb,
lib/helo/models/pagination_result_of_webhook_response.rb,
lib/helo/models/paginated_response_of_broadcast_failure.rb,
lib/helo/models/paginated_response_of_suppression_response.rb,
lib/helo/models/paginated_response_of_broadcast_suppression.rb,
lib/helo/models/pagination_result_of_channel_basic_response.rb

Overview

Define module hierarchy before loading core

Defined Under Namespace

Modules: Core Classes: API, APIError, AcceptedWebhookPayload, Activity, ActivityEvent, ActivityListEventsRequest, ActivityListMessagesRequest, ActivityMailAddress, Attachment, AttachmentDisposition, BouncedWebhookPayload, BroadcastContent, BroadcastContentAttachment, BroadcastContentTemplate, BroadcastDetailsResponse, BroadcastFailureResponse, BroadcastResponse, BroadcastStatistics, BroadcastStatus, BroadcastTracking, Broadcasts, BroadcastsListFailuresRequest, BroadcastsListRequest, BroadcastsListSuppressionsRequest, ChannelBasicResponse, ChannelDetailsResponse, ChannelTracking, Channels, ChannelsListRequest, ClickedWebhookPayload, Client, ComplainedWebhookPayload, Configuration, CreateChannelRequest, CreateChannelTracking, CreateDomainRequest, CreateSuppressionsRequest, CreateSuppressionsResponse, CreateWebhookRequest, DeliveredWebhookPayload, DeliveryStats, DeliveryType, DnsRecordResponse, DnsRecordStatus, DnsRecordType, DnsRecordsResponse, DomainChannelResponse, DomainResponse, DomainWithDnsResponse, Domains, DomainsListRequest, ErrorResponse, EventType, MailAddress, MailType, Message, MessageDetailsResponse, MessageDetailsResponseAttachment, MessageDetailsResponseEvent, MessageDetailsResponseTracking, OpenedWebhookPayload, PaginatedEventsResponse, PaginatedMessagesResponse, PaginatedResponseOfBroadcast, PaginatedResponseOfBroadcastFailure, PaginatedResponseOfBroadcastSuppression, PaginatedResponseOfDomainResponse, PaginatedResponseOfSuppressionResponse, PaginationResultOfChannelBasicResponse, PaginationResultOfWebhookResponse, ProcessedWebhookPayload, RecipientEventFields, RecipientHeaders, RemoveSuppressionResult, RemoveSuppressionsRequest, RemoveSuppressionsResponse, ResubscribedWebhookPayload, SendBroadcastRequest, SendBroadcastRequestMessage, SendBroadcastRequestTemplate, SendBroadcastRequestTracking, SendBroadcastResponse, SendMessageAcceptedResponse, SendMessageBatchRequest, SendMessageBatchResponse, SendMessageFailedResponse, SendMessageRequest, SendMessageRequestTemplate, SendMessageRequestTracking, SendMessageResponse, Sending, Statistics, StatisticsDailyResponse, StatisticsDailyResponseResult, StatisticsHourlyResponse, StatisticsHourlyResponseResult, StatisticsRetrieveDailyRequest, StatisticsRetrieveHourlyRequest, StatisticsRetrieveTotalsRequest, StatisticsTotalsResponse, SuppressionReason, SuppressionResponse, SuppressionResult, Suppressions, SuppressionsListRequest, UnsubscribedWebhookPayload, UpdateChannelRequest, UpdateChannelTracking, UpdateDomainRequest, UpdateWebhookRequest, ValidationError, WebhookEvent, WebhookHeader, WebhookLastResponse, WebhookPayloadCommon, WebhookResponse, Webhooks, WebhooksListRequest

Constant Summary collapse

VERSION = 
"1.0.0-beta.1"

Class Method Summary collapse

Class Method Details

.configure {|@configuration| ... } ⇒ Object

Yields:

  • (@configuration) 


23
24
25
26
27
 
# File 'lib/helo.rb', line 23

def self.configure
  @configuration ||= Configuration.new
  yield(@configuration)
  API.default_client = Client.new(@configuration)
end