helo-email-sdk 1.0.0.pre.beta.1

data/lib/helo/enums/broadcast_status.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Helo
+  class BroadcastStatus
+    ACCEPTED = "accepted"
+    PROCESSING = "processing"
+    COMPLETED = "completed"
+    CANCELED = "canceled"
+
+    def self.all
+      [ACCEPTED, PROCESSING, COMPLETED, CANCELED].freeze
+    end
+  end
+end

data/lib/helo/enums/delivery_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Helo
+  class DeliveryType
+    LIVE = "live"
+    SANDBOX = "sandbox"
+
+    def self.all
+      [LIVE, SANDBOX].freeze
+    end
+  end
+end

data/lib/helo/enums/dns_record_status.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Helo
+  class DnsRecordStatus
+    PENDING = "pending"
+    VERIFIED = "verified"
+    FAILING = "failing"
+    FAILED = "failed"
+
+    def self.all
+      [PENDING, VERIFIED, FAILING, FAILED].freeze
+    end
+  end
+end

data/lib/helo/enums/dns_record_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Helo
+  class DnsRecordType
+    TXT = "txt"
+    CNAME = "cname"
+
+    def self.all
+      [TXT, CNAME].freeze
+    end
+  end
+end

data/lib/helo/enums/event_type.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Helo
+  class EventType
+    ACCEPTED = "accepted"
+    PROCESSED = "processed"
+    DELIVERED = "delivered"
+    BOUNCED = "bounced"
+    OPENED = "opened"
+    CLICKED = "clicked"
+    COMPLAINED = "complained"
+    UNSUBSCRIBED = "unsubscribed"
+    RESUBSCRIBED = "resubscribed"
+
+    def self.all
+      [ACCEPTED, PROCESSED, DELIVERED, BOUNCED, OPENED, CLICKED, COMPLAINED, UNSUBSCRIBED, RESUBSCRIBED].freeze
+    end
+  end
+end

data/lib/helo/enums/mail_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Helo
+  class MailType
+    TRANSACTIONAL = "transactional"
+    BROADCAST = "broadcast"
+
+    def self.all
+      [TRANSACTIONAL, BROADCAST].freeze
+    end
+  end
+end

data/lib/helo/enums/suppression_reason.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Helo
+  class SuppressionReason
+    BOUNCE = "bounce"
+    COMPLAINT = "complaint"
+    UNSUBSCRIBE = "unsubscribe"
+    MANUAL = "manual"
+
+    def self.all
+      [BOUNCE, COMPLAINT, UNSUBSCRIBE, MANUAL].freeze
+    end
+  end
+end

data/lib/helo/enums/webhook_event.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Helo
+  class WebhookEvent
+    ACCEPTED = "accepted"
+    PROCESSED = "processed"
+    BOUNCED = "bounced"
+    DELIVERED = "delivered"
+    OPENED = "opened"
+    CLICKED = "clicked"
+    COMPLAINED = "complained"
+    UNSUBSCRIBED = "unsubscribed"
+    RESUBSCRIBED = "resubscribed"
+
+    def self.all
+      [ACCEPTED, PROCESSED, BOUNCED, DELIVERED, OPENED, CLICKED, COMPLAINED, UNSUBSCRIBED, RESUBSCRIBED].freeze
+    end
+  end
+end

data/lib/helo/models/accepted_webhook_payload.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Helo
+  class AcceptedWebhookPayload
+    include Helo::Core::Model
+
+    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"
+  end
+end

data/lib/helo/models/activity_event.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Helo
+  class ActivityEvent
+    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 :mail_source, :string, key: "mailSource"
+    api_attribute :event_type, :string, key: "eventType"
+    api_attribute :timestamp, :datetime, key: "timestamp"
+    api_attribute :subject, :string, key: "subject"
+    api_attribute :recipients, key: "recipients"
+    api_attribute :tags, key: "tags"
+    api_attribute :metadata, key: "metadata"
+    api_attribute :details, key: "details"
+  end
+end

data/lib/helo/models/activity_list_events_request.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Helo
+  # Generated request model for query parameters
+  class ActivityListEventsRequest
+    include Helo::Core::Model
+
+    api_attribute :channel_id, :string, key: "channelId"
+    api_attribute :message_id, :string, key: "messageId"
+    api_attribute :after, :integer, key: "after"
+    api_attribute :start_date, :datetime, key: "startDate"
+    api_attribute :end_date, :datetime, key: "endDate"
+    api_attribute :limit, :integer, key: "limit"
+    api_attribute :recipient, :string, key: "recipient"
+    api_attribute :subject, :string, key: "subject"
+    api_attribute :tags, key: "tags", explode: false
+    api_attribute :mail_type, :string, key: "mailType"
+    api_attribute :event_types, key: "eventTypes", explode: false
+  end
+end

data/lib/helo/models/activity_list_messages_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Helo
+  # Generated request model for query parameters
+  class ActivityListMessagesRequest
+    include Helo::Core::Model
+
+    api_attribute :channel_id, :string, key: "channelId"
+    api_attribute :after, :integer, key: "after"
+    api_attribute :start_date, :datetime, key: "startDate"
+    api_attribute :end_date, :datetime, key: "endDate"
+    api_attribute :limit, :integer, key: "limit"
+    api_attribute :recipient, :string, key: "recipient"
+    api_attribute :subject, :string, key: "subject"
+    api_attribute :tags, key: "tags", explode: false
+    api_attribute :mail_type, :string, key: "mailType"
+    api_attribute :status, :string, key: "status"
+  end
+end

data/lib/helo/models/activity_mail_address.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Helo
+  class ActivityMailAddress
+    include Helo::Core::Model
+
+    api_attribute :email, :string, key: "email"
+    api_attribute :name, :string, key: "name"
+  end
+end

data/lib/helo/models/attachment.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Helo
+  class Attachment
+    include Helo::Core::Model
+
+    api_attribute :content, :string, key: "content"
+    api_attribute :content_id, :string, key: "contentId"
+    api_attribute :content_type, :string, key: "contentType"
+    api_attribute :file_name, :string, key: "fileName"
+    api_attribute :disposition, :string, key: "disposition"
+  end
+end

data/lib/helo/models/bounced_webhook_payload.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Helo
+  class BouncedWebhookPayload
+    include Helo::Core::Model
+
+    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"
+  end
+end

data/lib/helo/models/broadcast_content.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Helo
+  class BroadcastContent
+    include Helo::Core::Model
+
+    api_attribute :from, Helo::Core::ModelType.new("Helo::MailAddress"), key: "from"
+    api_attribute :reply_to, Helo::Core::ArrayType.new("Helo::MailAddress"), key: "replyTo"
+    api_attribute :template, Helo::Core::ModelType.new("Helo::BroadcastContentTemplate"), key: "template"
+    api_attribute :attachments, Helo::Core::ArrayType.new("Helo::BroadcastContentAttachment"), key: "attachments"
+    api_attribute :tags, key: "tags"
+    api_attribute :headers, key: "headers"
+    api_attribute :metadata, key: "metadata"
+  end
+end

data/lib/helo/models/broadcast_content_attachment.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Helo
+  class BroadcastContentAttachment
+    include Helo::Core::Model
+
+    api_attribute :file_name, :string, key: "fileName"
+    api_attribute :disposition, :string, key: "disposition"
+    api_attribute :size, :integer, key: "size"
+  end
+end

data/lib/helo/models/broadcast_content_template.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Helo
+  class BroadcastContentTemplate
+    include Helo::Core::Model
+
+    api_attribute :subject, :string, key: "subject"
+    api_attribute :html, :string, key: "html"
+    api_attribute :text, :string, key: "text"
+  end
+end

data/lib/helo/models/broadcast_details_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Helo
+  class BroadcastDetailsResponse
+    include Helo::Core::Model
+
+    api_attribute :id, :string, key: "id"
+    api_attribute :created_at, :datetime, key: "createdAt"
+    api_attribute :status, :string, key: "status"
+    api_attribute :subject, :string, key: "subject"
+    api_attribute :completion, :string, key: "completion"
+    api_attribute :messages, :integer, key: "messages"
+    api_attribute :failed, :integer, key: "failed"
+    api_attribute :suppressed, :integer, key: "suppressed"
+    api_attribute :content, Helo::Core::ModelType.new("Helo::BroadcastContent"), key: "content"
+    api_attribute :tracking, Helo::Core::ModelType.new("Helo::BroadcastTracking"), key: "tracking"
+    api_attribute :statistics, Helo::Core::ModelType.new("Helo::BroadcastStatistics"), key: "statistics"
+  end
+end

data/lib/helo/models/broadcast_failure_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Helo
+  class BroadcastFailureResponse
+    include Helo::Core::Model
+
+    api_attribute :recipients, Helo::Core::ModelType.new("Helo::RecipientHeaders"), key: "recipients"
+    api_attribute :message_index, :integer, key: "messageIndex"
+    api_attribute :error_code, :string, key: "errorCode"
+    api_attribute :error_message, :string, key: "errorMessage"
+  end
+end

data/lib/helo/models/broadcast_response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Helo
+  class BroadcastResponse
+    include Helo::Core::Model
+
+    api_attribute :id, :string, key: "id"
+    api_attribute :created_at, :datetime, key: "createdAt"
+    api_attribute :status, :string, key: "status"
+    api_attribute :subject, :string, key: "subject"
+    api_attribute :completion, :string, key: "completion"
+    api_attribute :messages, :integer, key: "messages"
+  end
+end

data/lib/helo/models/broadcast_statistics.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Helo
+  class BroadcastStatistics
+    include Helo::Core::Model
+
+    api_attribute :sent, :integer, key: "sent"
+    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/broadcast_tracking.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Helo
+  class BroadcastTracking
+    include Helo::Core::Model
+
+    api_attribute :opens, :boolean, key: "opens"
+    api_attribute :links, :boolean, key: "links"
+  end
+end

data/lib/helo/models/broadcasts_list_failures_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Helo
+  # Generated request model for query parameters
+  class BroadcastsListFailuresRequest
+    include Helo::Core::Model
+
+    api_attribute :limit, :integer, key: "limit"
+    api_attribute :offset, :integer, key: "offset"
+  end
+end

data/lib/helo/models/broadcasts_list_request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Helo
+  # Generated request model for query parameters
+  class BroadcastsListRequest
+    include Helo::Core::Model
+
+    api_attribute :channel_id, :string, key: "channelId"
+    api_attribute :status, :string, key: "status"
+    api_attribute :subject, :string, key: "subject"
+    api_attribute :limit, :integer, key: "limit"
+    api_attribute :offset, :integer, key: "offset"
+  end
+end

data/lib/helo/models/broadcasts_list_suppressions_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Helo
+  # Generated request model for query parameters
+  class BroadcastsListSuppressionsRequest
+    include Helo::Core::Model
+
+    api_attribute :limit, :integer, key: "limit"
+    api_attribute :offset, :integer, key: "offset"
+  end
+end

data/lib/helo/models/channel_basic_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Helo
+  class ChannelBasicResponse
+    include Helo::Core::Model
+
+    api_attribute :id, :string, key: "id"
+    api_attribute :name, :string, key: "name"
+    api_attribute :delivery_type, :string, key: "deliveryType"
+    api_attribute :created_at, :datetime, key: "createdAt"
+  end
+end

data/lib/helo/models/channel_details_response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Helo
+  class ChannelDetailsResponse
+    include Helo::Core::Model
+
+    api_attribute :id, :string, key: "id"
+    api_attribute :name, :string, key: "name"
+    api_attribute :delivery_type, :string, key: "deliveryType"
+    api_attribute :created_at, :datetime, key: "createdAt"
+    api_attribute :updated_at, :datetime, key: "updatedAt"
+    api_attribute :tracking, Helo::Core::ModelType.new("Helo::ChannelTracking"), key: "tracking"
+  end
+end

data/lib/helo/models/channel_tracking.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Helo
+  class ChannelTracking
+    include Helo::Core::Model
+
+    api_attribute :links, :boolean, key: "links"
+    api_attribute :opens, :boolean, key: "opens"
+  end
+end

data/lib/helo/models/channels_list_request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Helo
+  # Generated request model for query parameters
+  class ChannelsListRequest
+    include Helo::Core::Model
+
+    api_attribute :limit, :integer, key: "limit"
+    api_attribute :offset, :integer, key: "offset"
+    api_attribute :name, :string, key: "name"
+    api_attribute :channel_ids, key: "channelIds", explode: false
+    api_attribute :delivery_type, :string, key: "deliveryType"
+  end
+end

data/lib/helo/models/clicked_webhook_payload.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Helo
+  class ClickedWebhookPayload
+    include Helo::Core::Model
+
+    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"
+  end
+end

data/lib/helo/models/complained_webhook_payload.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Helo
+  class ComplainedWebhookPayload
+    include Helo::Core::Model
+
+    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"
+  end
+end

data/lib/helo/models/create_channel_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Helo
+  class CreateChannelRequest
+    include Helo::Core::Model
+
+    api_attribute :name, :string, key: "name"
+    api_attribute :delivery_type, :string, key: "deliveryType"
+    api_attribute :tracking, Helo::Core::ModelType.new("Helo::CreateChannelTracking"), key: "tracking"
+  end
+end

data/lib/helo/models/create_channel_tracking.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Helo
+  class CreateChannelTracking
+    include Helo::Core::Model
+
+    api_attribute :links, :boolean, key: "links"
+    api_attribute :opens, :boolean, key: "opens"
+  end
+end

data/lib/helo/models/create_domain_request.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Helo
+  class CreateDomainRequest
+    include Helo::Core::Model
+
+    api_attribute :name, :string, key: "name"
+    api_attribute :channel_ids, key: "channelIds"
+  end
+end

data/lib/helo/models/create_suppressions_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Helo
+  class CreateSuppressionsRequest
+    include Helo::Core::Model
+
+    api_attribute :channel_id, :string, key: "channelId"
+    api_attribute :mail_type, :string, key: "mailType"
+    api_attribute :emails, key: "emails"
+  end
+end

data/lib/helo/models/create_suppressions_response.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Helo
+  class CreateSuppressionsResponse
+    include Helo::Core::Model
+
+    api_attribute :results, Helo::Core::ArrayType.new("Helo::SuppressionResult"), key: "results"
+  end
+end

data/lib/helo/models/create_webhook_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Helo
+  class CreateWebhookRequest
+    include Helo::Core::Model
+
+    api_attribute :url, :string, key: "url"
+    api_attribute :events, key: "events"
+    api_attribute :channel_id, :string, key: "channelId"
+    api_attribute :additional_headers, Helo::Core::ArrayType.new("Helo::WebhookHeader"), key: "additionalHeaders"
+    api_attribute :enabled, :boolean, key: "enabled"
+  end
+end

data/lib/helo/models/delivered_webhook_payload.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Helo
+  class DeliveredWebhookPayload
+    include Helo::Core::Model
+
+    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"
+  end
+end

data/lib/helo/models/delivery_stats.rb

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

data/lib/helo/models/dns_record_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Helo
+  class DnsRecordResponse
+    include Helo::Core::Model
+
+    api_attribute :type, :string, key: "type"
+    api_attribute :host, :string, key: "host"
+    api_attribute :value, :string, key: "value"
+    api_attribute :status, :string, key: "status"
+    api_attribute :last_checked_at, :datetime, key: "lastCheckedAt"
+  end
+end

data/lib/helo/models/dns_records_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Helo
+  class DnsRecordsResponse
+    include Helo::Core::Model
+
+    api_attribute :domain_key_active, Helo::Core::ModelType.new("Helo::DnsRecordResponse"), key: "domainKeyActive"
+    api_attribute :domain_key_pending, Helo::Core::ModelType.new("Helo::DnsRecordResponse"), key: "domainKeyPending"
+    api_attribute :return_path, Helo::Core::ArrayType.new("Helo::DnsRecordResponse"), key: "returnPath"
+    api_attribute :tracking, Helo::Core::ModelType.new("Helo::DnsRecordResponse"), key: "tracking"
+    api_attribute :unsubscribe, Helo::Core::ModelType.new("Helo::DnsRecordResponse"), key: "unsubscribe"
+  end
+end