helo-email-sdk 1.0.0.pre.beta.2 → 1.0.0.pre.beta.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 612d57ecd6a1b1917fe6d79997e1e444bee7b26d2d7dc851a7727509f4f29e67
-  data.tar.gz: 28bc563518998af787122744b916eab205993fff3d492ee00fd4b196e864f989
+  metadata.gz: 68419322a6f7e1bb6857bbb9e38f76ca48ea993bd31b1ac11756502b6ee54df6
+  data.tar.gz: c2e11364e91c861ea02c07afa73f5a2a6ee9b930c5e905c01ad6be8637a8b117
 SHA512:
-  metadata.gz: 0e7b810a2624aaec9cfcb9818b90bdcbf5771bd70f566aab9b29f7d36e811003cd28895038fce168d2e50ddc476032b52c70f01ea08aca31debce6963e3e8ac9
-  data.tar.gz: 847cf7cf9fe2e78f5d1ff75e246fbe68d88d1eab506b18588af26a1f00d490a866dd6f75dbb569dbd8251cce9c28a051197b1728ff941d4c36a4f53c39fbece4
+  metadata.gz: 249cbacbb3dbba114acc15bca15ebbbb0c530c401f67e332ca8043f6520b6bbbddee848293bf0189c226084ec365a1309e054bc7a90aadb77d0dcf9d943a23c2
+  data.tar.gz: ed1b2ddb57aebe804fe6d75223cd4f8f002c4d0fbdda2cb9cbf0ca9e1b86e180d01d6de6cb8851606fd978afa36fc6c2934b9b102870e097e96c9210615924bc

data/lib/helo/apis/statistics.rb

@@ -4,19 +4,19 @@ module Helo
   class Statistics < API
     def retrieve_hourly(request_data = {})
       request = StatisticsRetrieveHourlyRequest.new(request_data)
-      response = @client.request(:get, "/activity/statistics/hourly", params: request.to_params)
+      response = @client.request(:get, "/statistics/hourly", params: request.to_params)
       StatisticsHourlyResponse.from_hash(response.body)
     end
 
     def retrieve_daily(request_data = {})
       request = StatisticsRetrieveDailyRequest.new(request_data)
-      response = @client.request(:get, "/activity/statistics/daily", params: request.to_params)
+      response = @client.request(:get, "/statistics/daily", params: request.to_params)
       StatisticsDailyResponse.from_hash(response.body)
     end
 
     def retrieve_totals(request_data = {})
       request = StatisticsRetrieveTotalsRequest.new(request_data)
-      response = @client.request(:get, "/activity/statistics/totals", params: request.to_params)
+      response = @client.request(:get, "/statistics/totals", params: request.to_params)
       StatisticsTotalsResponse.from_hash(response.body)
     end
 

data/lib/helo/core/client.rb

@@ -10,15 +10,6 @@ module Helo::Core
       raise ArgumentError, "base_url is not configured" if configuration.base_url.to_s.empty?
 
       @configuration = configuration
-      @connection = Faraday.new(url: configuration.base_url) do |f|
-        f.request :json
-        f.response :json
-        f.adapter Faraday.default_adapter
-        f.options.params_encoder = Faraday::FlatParamsEncoder
-
-        # Allow custom Faraday configuration
-        configuration.faraday_configuration_block&.call(f)
-      end
     end
 
     def request(method, path, params: {}, body: nil, headers: {})
@@ -43,7 +34,17 @@ module Helo::Core
 
     private
 
-    attr_reader :connection
+    def connection
+      @_connection ||= Faraday.new(url: configuration.base_url) do |f|
+        f.request :json
+        f.response :json
+        f.adapter Faraday.default_adapter
+        f.options.params_encoder = Faraday::FlatParamsEncoder
+
+        # Allow custom Faraday configuration
+        configuration.faraday_configuration_block&.call(f)
+      end
+    end
 
     def current_api_key
       token = configuration.api_key

data/lib/helo/enums/webhook_event.rb

@@ -11,9 +11,13 @@ module Helo
     COMPLAINED = "complained"
     UNSUBSCRIBED = "unsubscribed"
     RESUBSCRIBED = "resubscribed"
+    DOMAIN_KEY_VERIFIED = "domain-key-verified"
+    DOMAIN_KEY_VERIFICATION_FAILED = "domain-key-verification-failed"
+    RETURN_PATH_DOMAIN_VERIFIED = "return-path-domain-verified"
+    RETURN_PATH_DOMAIN_VERIFICATION_FAILED = "return-path-domain-verification-failed"
 
     def self.all
-      [ACCEPTED, PROCESSED, BOUNCED, DELIVERED, OPENED, CLICKED, COMPLAINED, UNSUBSCRIBED, RESUBSCRIBED].freeze
+      [ACCEPTED, PROCESSED, BOUNCED, DELIVERED, OPENED, CLICKED, COMPLAINED, UNSUBSCRIBED, RESUBSCRIBED, DOMAIN_KEY_VERIFIED, DOMAIN_KEY_VERIFICATION_FAILED, RETURN_PATH_DOMAIN_VERIFIED, RETURN_PATH_DOMAIN_VERIFICATION_FAILED].freeze
     end
   end
 end

data/lib/helo/models/accepted_webhook_payload.rb

@@ -6,12 +6,12 @@ module Helo
 
     api_attribute :event_type, :string, key: "eventType"
     api_attribute :recipients, key: "recipients"
-    api_attribute :timestamp, :datetime, key: "timestamp"
     api_attribute :message_id, :string, key: "messageId"
     api_attribute :channel_id, :string, key: "channelId"
     api_attribute :mail_type, :string, key: "mailType"
     api_attribute :subject, :string, key: "subject"
     api_attribute :tags, key: "tags"
     api_attribute :metadata, key: "metadata"
+    api_attribute :timestamp, :datetime, key: "timestamp"
   end
 end

data/lib/helo/models/bounced_webhook_payload.rb

@@ -7,12 +7,12 @@ module Helo
     api_attribute :event_type, :string, key: "eventType"
     api_attribute :recipient, :string, key: "recipient"
     api_attribute :details, :string, key: "details"
-    api_attribute :timestamp, :datetime, key: "timestamp"
     api_attribute :message_id, :string, key: "messageId"
     api_attribute :channel_id, :string, key: "channelId"
     api_attribute :mail_type, :string, key: "mailType"
     api_attribute :subject, :string, key: "subject"
     api_attribute :tags, key: "tags"
     api_attribute :metadata, key: "metadata"
+    api_attribute :timestamp, :datetime, key: "timestamp"
   end
 end

data/lib/helo/models/clicked_webhook_payload.rb

@@ -7,12 +7,12 @@ module Helo
     api_attribute :event_type, :string, key: "eventType"
     api_attribute :recipient, :string, key: "recipient"
     api_attribute :details, :string, key: "details"
-    api_attribute :timestamp, :datetime, key: "timestamp"
     api_attribute :message_id, :string, key: "messageId"
     api_attribute :channel_id, :string, key: "channelId"
     api_attribute :mail_type, :string, key: "mailType"
     api_attribute :subject, :string, key: "subject"
     api_attribute :tags, key: "tags"
     api_attribute :metadata, key: "metadata"
+    api_attribute :timestamp, :datetime, key: "timestamp"
   end
 end

data/lib/helo/models/complained_webhook_payload.rb

@@ -7,12 +7,12 @@ module Helo
     api_attribute :event_type, :string, key: "eventType"
     api_attribute :recipient, :string, key: "recipient"
     api_attribute :details, :string, key: "details"
-    api_attribute :timestamp, :datetime, key: "timestamp"
     api_attribute :message_id, :string, key: "messageId"
     api_attribute :channel_id, :string, key: "channelId"
     api_attribute :mail_type, :string, key: "mailType"
     api_attribute :subject, :string, key: "subject"
     api_attribute :tags, key: "tags"
     api_attribute :metadata, key: "metadata"
+    api_attribute :timestamp, :datetime, key: "timestamp"
   end
 end

data/lib/helo/models/delivered_webhook_payload.rb

@@ -7,12 +7,12 @@ module Helo
     api_attribute :event_type, :string, key: "eventType"
     api_attribute :recipient, :string, key: "recipient"
     api_attribute :details, :string, key: "details"
-    api_attribute :timestamp, :datetime, key: "timestamp"
     api_attribute :message_id, :string, key: "messageId"
     api_attribute :channel_id, :string, key: "channelId"
     api_attribute :mail_type, :string, key: "mailType"
     api_attribute :subject, :string, key: "subject"
     api_attribute :tags, key: "tags"
     api_attribute :metadata, key: "metadata"
+    api_attribute :timestamp, :datetime, key: "timestamp"
   end
 end

data/lib/helo/models/delivery_webhook_payload_common.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Helo
+  class DeliveryWebhookPayloadCommon
+    include Helo::Core::Model
+
+    api_attribute :message_id, :string, key: "messageId"
+    api_attribute :channel_id, :string, key: "channelId"
+    api_attribute :mail_type, :string, key: "mailType"
+    api_attribute :subject, :string, key: "subject"
+    api_attribute :tags, key: "tags"
+    api_attribute :metadata, key: "metadata"
+    api_attribute :timestamp, :datetime, key: "timestamp"
+  end
+end

data/lib/helo/models/domain_key_verification_failed_payload.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Helo
+  class DomainKeyVerificationFailedPayload
+    include Helo::Core::Model
+
+    api_attribute :event_type, :string, key: "eventType"
+    api_attribute :domain_id, :string, key: "domainId"
+    api_attribute :domain_name, :string, key: "domainName"
+    api_attribute :dns_record_host, :string, key: "dnsRecordHost"
+    api_attribute :timestamp, :datetime, key: "timestamp"
+  end
+end

data/lib/helo/models/domain_key_verified_payload.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Helo
+  class DomainKeyVerifiedPayload
+    include Helo::Core::Model
+
+    api_attribute :event_type, :string, key: "eventType"
+    api_attribute :domain_id, :string, key: "domainId"
+    api_attribute :domain_name, :string, key: "domainName"
+    api_attribute :dns_record_host, :string, key: "dnsRecordHost"
+    api_attribute :timestamp, :datetime, key: "timestamp"
+  end
+end

data/lib/helo/models/domain_payload_common.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Helo
+  class DomainPayloadCommon
+    include Helo::Core::Model
+
+    api_attribute :domain_id, :string, key: "domainId"
+    api_attribute :domain_name, :string, key: "domainName"
+    api_attribute :dns_record_host, :string, key: "dnsRecordHost"
+    api_attribute :timestamp, :datetime, key: "timestamp"
+  end
+end

data/lib/helo/models/message.rb

@@ -13,5 +13,7 @@ module Helo
     api_attribute :status, :string, key: "status"
     api_attribute :subject, :string, key: "subject"
     api_attribute :recipients, key: "recipients"
+    api_attribute :tags, key: "tags"
+    api_attribute :statistics, Helo::Core::ModelType.new("Helo::MessageStatistics"), key: "statistics"
   end
 end

data/lib/helo/models/message_details_response.rb

@@ -26,5 +26,6 @@ module Helo
     api_attribute :attachments, Helo::Core::ArrayType.new("Helo::MessageDetailsResponseAttachment"), key: "attachments"
     api_attribute :tracking, Helo::Core::ModelType.new("Helo::MessageDetailsResponseTracking"), key: "tracking"
     api_attribute :events, Helo::Core::ArrayType.new("Helo::MessageDetailsResponseEvent"), key: "events"
+    api_attribute :statistics, Helo::Core::ModelType.new("Helo::MessageStatistics"), key: "statistics"
   end
 end

data/lib/helo/models/message_statistics.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Helo
+  class MessageStatistics
+    include Helo::Core::Model
+
+    api_attribute :delivered, :integer, key: "delivered"
+    api_attribute :bounced, :integer, key: "bounced"
+    api_attribute :opened, :integer, key: "opened"
+    api_attribute :clicked, :integer, key: "clicked"
+    api_attribute :complained, :integer, key: "complained"
+    api_attribute :unsubscribed, :integer, key: "unsubscribed"
+  end
+end

data/lib/helo/models/opened_webhook_payload.rb

@@ -7,12 +7,12 @@ module Helo
     api_attribute :event_type, :string, key: "eventType"
     api_attribute :recipient, :string, key: "recipient"
     api_attribute :details, :string, key: "details"
-    api_attribute :timestamp, :datetime, key: "timestamp"
     api_attribute :message_id, :string, key: "messageId"
     api_attribute :channel_id, :string, key: "channelId"
     api_attribute :mail_type, :string, key: "mailType"
     api_attribute :subject, :string, key: "subject"
     api_attribute :tags, key: "tags"
     api_attribute :metadata, key: "metadata"
+    api_attribute :timestamp, :datetime, key: "timestamp"
   end
 end

data/lib/helo/models/processed_webhook_payload.rb

@@ -6,12 +6,12 @@ module Helo
 
     api_attribute :event_type, :string, key: "eventType"
     api_attribute :recipients, key: "recipients"
-    api_attribute :timestamp, :datetime, key: "timestamp"
     api_attribute :message_id, :string, key: "messageId"
     api_attribute :channel_id, :string, key: "channelId"
     api_attribute :mail_type, :string, key: "mailType"
     api_attribute :subject, :string, key: "subject"
     api_attribute :tags, key: "tags"
     api_attribute :metadata, key: "metadata"
+    api_attribute :timestamp, :datetime, key: "timestamp"
   end
 end

data/lib/helo/models/resubscribed_webhook_payload.rb

@@ -7,12 +7,12 @@ module Helo
     api_attribute :event_type, :string, key: "eventType"
     api_attribute :recipient, :string, key: "recipient"
     api_attribute :details, :string, key: "details"
-    api_attribute :timestamp, :datetime, key: "timestamp"
     api_attribute :message_id, :string, key: "messageId"
     api_attribute :channel_id, :string, key: "channelId"
     api_attribute :mail_type, :string, key: "mailType"
     api_attribute :subject, :string, key: "subject"
     api_attribute :tags, key: "tags"
     api_attribute :metadata, key: "metadata"
+    api_attribute :timestamp, :datetime, key: "timestamp"
   end
 end

data/lib/helo/models/return_path_domain_verification_failed_payload.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Helo
+  class ReturnPathDomainVerificationFailedPayload
+    include Helo::Core::Model
+
+    api_attribute :event_type, :string, key: "eventType"
+    api_attribute :domain_id, :string, key: "domainId"
+    api_attribute :domain_name, :string, key: "domainName"
+    api_attribute :dns_record_host, :string, key: "dnsRecordHost"
+    api_attribute :timestamp, :datetime, key: "timestamp"
+  end
+end

data/lib/helo/models/return_path_domain_verified_payload.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Helo
+  class ReturnPathDomainVerifiedPayload
+    include Helo::Core::Model
+
+    api_attribute :event_type, :string, key: "eventType"
+    api_attribute :domain_id, :string, key: "domainId"
+    api_attribute :domain_name, :string, key: "domainName"
+    api_attribute :dns_record_host, :string, key: "dnsRecordHost"
+    api_attribute :timestamp, :datetime, key: "timestamp"
+  end
+end

data/lib/helo/models/unsubscribed_webhook_payload.rb

@@ -7,12 +7,12 @@ module Helo
     api_attribute :event_type, :string, key: "eventType"
     api_attribute :recipient, :string, key: "recipient"
     api_attribute :details, :string, key: "details"
-    api_attribute :timestamp, :datetime, key: "timestamp"
     api_attribute :message_id, :string, key: "messageId"
     api_attribute :channel_id, :string, key: "channelId"
     api_attribute :mail_type, :string, key: "mailType"
     api_attribute :subject, :string, key: "subject"
     api_attribute :tags, key: "tags"
     api_attribute :metadata, key: "metadata"
+    api_attribute :timestamp, :datetime, key: "timestamp"
   end
 end

data/lib/helo/models/webhook_payload_common.rb

@@ -5,11 +5,5 @@ module Helo
     include Helo::Core::Model
 
     api_attribute :timestamp, :datetime, key: "timestamp"
-    api_attribute :message_id, :string, key: "messageId"
-    api_attribute :channel_id, :string, key: "channelId"
-    api_attribute :mail_type, :string, key: "mailType"
-    api_attribute :subject, :string, key: "subject"
-    api_attribute :tags, key: "tags"
-    api_attribute :metadata, key: "metadata"
   end
 end

data/lib/helo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Helo
-  VERSION = "1.0.0-beta.2"
+  VERSION = "1.0.0-beta.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: helo-email-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta.2
+  version: 1.0.0.pre.beta.6
 platform: ruby
 authors:
 - Helo Email
@@ -147,9 +147,13 @@ files:
 - lib/helo/models/create_webhook_request.rb
 - lib/helo/models/delivered_webhook_payload.rb
 - lib/helo/models/delivery_stats.rb
+- lib/helo/models/delivery_webhook_payload_common.rb
 - lib/helo/models/dns_record_response.rb
 - lib/helo/models/dns_records_response.rb
 - lib/helo/models/domain_channel_response.rb
+- lib/helo/models/domain_key_verification_failed_payload.rb
+- lib/helo/models/domain_key_verified_payload.rb
+- lib/helo/models/domain_payload_common.rb
 - lib/helo/models/domain_response.rb
 - lib/helo/models/domain_with_dns_response.rb
 - lib/helo/models/domains_list_request.rb
@@ -160,6 +164,7 @@ files:
 - lib/helo/models/message_details_response_attachment.rb
 - lib/helo/models/message_details_response_event.rb
 - lib/helo/models/message_details_response_tracking.rb
+- lib/helo/models/message_statistics.rb
 - lib/helo/models/opened_webhook_payload.rb
 - lib/helo/models/paginated_events_response.rb
 - lib/helo/models/paginated_messages_response.rb
@@ -177,6 +182,8 @@ files:
 - lib/helo/models/remove_suppressions_request.rb
 - lib/helo/models/remove_suppressions_response.rb
 - lib/helo/models/resubscribed_webhook_payload.rb
+- lib/helo/models/return_path_domain_verification_failed_payload.rb
+- lib/helo/models/return_path_domain_verified_payload.rb
 - lib/helo/models/send_broadcast_request.rb
 - lib/helo/models/send_broadcast_request_message.rb
 - lib/helo/models/send_broadcast_request_template.rb