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

data/lib/helo/models/domain_channel_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Helo
+  class DomainChannelResponse
+    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 :deleted, :boolean, key: "deleted"
+  end
+end

data/lib/helo/models/domain_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Helo
+  class DomainResponse
+    include Helo::Core::Model
+
+    api_attribute :id, :string, key: "id"
+    api_attribute :created_at, :datetime, key: "createdAt"
+    api_attribute :name, :string, key: "name"
+    api_attribute :verified, :boolean, key: "verified"
+    api_attribute :channels, Helo::Core::ArrayType.new("Helo::DomainChannelResponse"), key: "channels"
+  end
+end

data/lib/helo/models/domain_with_dns_response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Helo
+  class DomainWithDnsResponse
+    include Helo::Core::Model
+
+    api_attribute :id, :string, key: "id"
+    api_attribute :created_at, :datetime, key: "createdAt"
+    api_attribute :name, :string, key: "name"
+    api_attribute :verified, :boolean, key: "verified"
+    api_attribute :channels, Helo::Core::ArrayType.new("Helo::DomainChannelResponse"), key: "channels"
+    api_attribute :dns_records, Helo::Core::ModelType.new("Helo::DnsRecordsResponse"), key: "dnsRecords"
+  end
+end

data/lib/helo/models/domains_list_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Helo
+  # Generated request model for query parameters
+  class DomainsListRequest
+    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
+  end
+end

data/lib/helo/models/error_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Helo
+  class ErrorResponse
+    include Helo::Core::Model
+
+    api_attribute :type, :string, key: "type"
+    api_attribute :title, :string, key: "title"
+    api_attribute :instance, :string, key: "instance"
+    api_attribute :status, :integer, key: "status"
+    api_attribute :code, :string, key: "code"
+    api_attribute :detail, :string, key: "detail"
+    api_attribute :request_id, :string, key: "requestId"
+    api_attribute :errors, key: "errors"
+  end
+end

data/lib/helo/models/mail_address.rb

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

data/lib/helo/models/message.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Helo
+  class Message
+    include Helo::Core::Model
+
+    api_attribute :message_id, :string, key: "messageId"
+    api_attribute :channel_id, :string, key: "channelId"
+    api_attribute :timestamp, :datetime, key: "timestamp"
+    api_attribute :mail_type, :string, key: "mailType"
+    api_attribute :mail_source, :string, key: "mailSource"
+    api_attribute :delivery_type, :string, key: "deliveryType"
+    api_attribute :status, :string, key: "status"
+    api_attribute :subject, :string, key: "subject"
+    api_attribute :recipients, key: "recipients"
+  end
+end

data/lib/helo/models/message_details_response.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Helo
+  class MessageDetailsResponse
+    include Helo::Core::Model
+
+    api_attribute :message_id, :string, key: "messageId"
+    api_attribute :channel_id, :string, key: "channelId"
+    api_attribute :timestamp, :datetime, key: "timestamp"
+    api_attribute :mail_type, :string, key: "mailType"
+    api_attribute :mail_source, :string, key: "mailSource"
+    api_attribute :delivery_type, :string, key: "deliveryType"
+    api_attribute :status, :string, key: "status"
+    api_attribute :subject, :string, key: "subject"
+    api_attribute :from, Helo::Core::ModelType.new("Helo::ActivityMailAddress"), key: "from"
+    api_attribute :to, Helo::Core::ArrayType.new("Helo::ActivityMailAddress"), key: "to"
+    api_attribute :cc, Helo::Core::ArrayType.new("Helo::ActivityMailAddress"), key: "cc"
+    api_attribute :bcc, Helo::Core::ArrayType.new("Helo::ActivityMailAddress"), key: "bcc"
+    api_attribute :reply_to, Helo::Core::ArrayType.new("Helo::ActivityMailAddress"), key: "replyTo"
+    api_attribute :text, :string, key: "text"
+    api_attribute :html, :string, key: "html"
+    api_attribute :body, :string, key: "body"
+    api_attribute :tags, key: "tags"
+    api_attribute :headers, key: "headers"
+    api_attribute :metadata, key: "metadata"
+    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"
+  end
+end

data/lib/helo/models/message_details_response_attachment.rb

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

data/lib/helo/models/message_details_response_event.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Helo
+  class MessageDetailsResponseEvent
+    include Helo::Core::Model
+
+    api_attribute :event_type, :string, key: "eventType"
+    api_attribute :timestamp, :datetime, key: "timestamp"
+    api_attribute :recipients, key: "recipients"
+    api_attribute :details, key: "details"
+  end
+end

data/lib/helo/models/message_details_response_tracking.rb

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

data/lib/helo/models/opened_webhook_payload.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Helo
+  class OpenedWebhookPayload
+    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/paginated_events_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Helo
+  class PaginatedEventsResponse
+    include Helo::Core::Model
+
+    api_attribute :after, :integer, key: "after"
+    api_attribute :total_count, :float, key: "totalCount"
+    api_attribute :results, Helo::Core::ArrayType.new("Helo::ActivityEvent"), key: "results"
+  end
+end

data/lib/helo/models/paginated_messages_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Helo
+  class PaginatedMessagesResponse
+    include Helo::Core::Model
+
+    api_attribute :after, :integer, key: "after"
+    api_attribute :total_count, :float, key: "totalCount"
+    api_attribute :results, Helo::Core::ArrayType.new("Helo::Message"), key: "results"
+  end
+end

data/lib/helo/models/paginated_response_of_broadcast.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Helo
+  class PaginatedResponseOfBroadcast
+    include Helo::Core::Model
+
+    api_attribute :total_count, :integer, key: "totalCount"
+    api_attribute :results, Helo::Core::ArrayType.new("Helo::BroadcastResponse"), key: "results"
+  end
+end

data/lib/helo/models/paginated_response_of_broadcast_failure.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Helo
+  class PaginatedResponseOfBroadcastFailure
+    include Helo::Core::Model
+
+    api_attribute :total_count, :integer, key: "totalCount"
+    api_attribute :results, Helo::Core::ArrayType.new("Helo::BroadcastFailureResponse"), key: "results"
+  end
+end

data/lib/helo/models/paginated_response_of_broadcast_suppression.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Helo
+  class PaginatedResponseOfBroadcastSuppression
+    include Helo::Core::Model
+
+    api_attribute :total_count, :integer, key: "totalCount"
+    api_attribute :results, key: "results"
+  end
+end

data/lib/helo/models/paginated_response_of_domain_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Helo
+  class PaginatedResponseOfDomainResponse
+    include Helo::Core::Model
+
+    api_attribute :total_count, :integer, key: "totalCount"
+    api_attribute :results, Helo::Core::ArrayType.new("Helo::DomainResponse"), key: "results"
+  end
+end

data/lib/helo/models/paginated_response_of_suppression_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Helo
+  class PaginatedResponseOfSuppressionResponse
+    include Helo::Core::Model
+
+    api_attribute :total_count, :integer, key: "totalCount"
+    api_attribute :results, Helo::Core::ArrayType.new("Helo::SuppressionResponse"), key: "results"
+  end
+end

data/lib/helo/models/pagination_result_of_channel_basic_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Helo
+  class PaginationResultOfChannelBasicResponse
+    include Helo::Core::Model
+
+    api_attribute :results, Helo::Core::ArrayType.new("Helo::ChannelBasicResponse"), key: "results"
+    api_attribute :total_count, :integer, key: "totalCount"
+  end
+end

data/lib/helo/models/pagination_result_of_webhook_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Helo
+  class PaginationResultOfWebhookResponse
+    include Helo::Core::Model
+
+    api_attribute :results, Helo::Core::ArrayType.new("Helo::WebhookResponse"), key: "results"
+    api_attribute :total_count, :integer, key: "totalCount"
+  end
+end

data/lib/helo/models/processed_webhook_payload.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Helo
+  class ProcessedWebhookPayload
+    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/recipient_event_fields.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Helo
+  class RecipientEventFields
+    include Helo::Core::Model
+
+    api_attribute :recipient, :string, key: "recipient"
+    api_attribute :details, :string, key: "details"
+  end
+end

data/lib/helo/models/recipient_headers.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Helo
+  class RecipientHeaders
+    include Helo::Core::Model
+
+    api_attribute :to, Helo::Core::ArrayType.new("Helo::MailAddress"), key: "to"
+    api_attribute :cc, Helo::Core::ArrayType.new("Helo::MailAddress"), key: "cc"
+    api_attribute :bcc, Helo::Core::ArrayType.new("Helo::MailAddress"), key: "bcc"
+  end
+end

data/lib/helo/models/remove_suppression_result.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Helo
+  class RemoveSuppressionResult
+    include Helo::Core::Model
+
+    api_attribute :email, :string, key: "email"
+    api_attribute :success, :boolean, key: "success"
+    api_attribute :message, :string, key: "message"
+  end
+end

data/lib/helo/models/remove_suppressions_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Helo
+  class RemoveSuppressionsRequest
+    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/remove_suppressions_response.rb

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

data/lib/helo/models/resubscribed_webhook_payload.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Helo
+  class ResubscribedWebhookPayload
+    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/send_broadcast_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Helo
+  class SendBroadcastRequest
+    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::SendBroadcastRequestTemplate"), key: "template"
+    api_attribute :tracking, Helo::Core::ModelType.new("Helo::SendBroadcastRequestTracking"), key: "tracking"
+    api_attribute :attachments, Helo::Core::ArrayType.new("Helo::Attachment"), key: "attachments"
+    api_attribute :tags, key: "tags"
+    api_attribute :headers, key: "headers"
+    api_attribute :metadata, key: "metadata"
+    api_attribute :messages, Helo::Core::ArrayType.new("Helo::SendBroadcastRequestMessage"), key: "messages"
+  end
+end

data/lib/helo/models/send_broadcast_request_message.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Helo
+  class SendBroadcastRequestMessage
+    include Helo::Core::Model
+
+    api_attribute :to, Helo::Core::ArrayType.new("Helo::MailAddress"), key: "to"
+    api_attribute :cc, Helo::Core::ArrayType.new("Helo::MailAddress"), key: "cc"
+    api_attribute :bcc, Helo::Core::ArrayType.new("Helo::MailAddress"), key: "bcc"
+    api_attribute :tags, key: "tags"
+    api_attribute :headers, key: "headers"
+    api_attribute :metadata, key: "metadata"
+    api_attribute :data, key: "data"
+  end
+end

data/lib/helo/models/send_broadcast_request_template.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Helo
+  class SendBroadcastRequestTemplate
+    include Helo::Core::Model
+
+    api_attribute :subject, :string, key: "subject"
+    api_attribute :html, :string, key: "html"
+    api_attribute :text, :string, key: "text"
+    api_attribute :inline_styles, :boolean, key: "inlineStyles"
+    api_attribute :data, key: "data"
+  end
+end

data/lib/helo/models/send_broadcast_request_tracking.rb

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

data/lib/helo/models/send_broadcast_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Helo
+  class SendBroadcastResponse
+    include Helo::Core::Model
+
+    api_attribute :status, :string, key: "status"
+    api_attribute :broadcast_id, :string, key: "broadcastId"
+  end
+end

data/lib/helo/models/send_message_accepted_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Helo
+  class SendMessageAcceptedResponse
+    include Helo::Core::Model
+
+    api_attribute :status, :string, key: "status"
+    api_attribute :message_id, :string, key: "messageId"
+    api_attribute :suppressions, key: "suppressions"
+  end
+end

data/lib/helo/models/send_message_batch_request.rb

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

data/lib/helo/models/send_message_batch_response.rb

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

data/lib/helo/models/send_message_failed_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Helo
+  class SendMessageFailedResponse
+    include Helo::Core::Model
+
+    api_attribute :status, :string, key: "status"
+    api_attribute :error_code, :string, key: "errorCode"
+    api_attribute :error_message, :string, key: "errorMessage"
+  end
+end

data/lib/helo/models/send_message_request.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Helo
+  class SendMessageRequest
+    include Helo::Core::Model
+
+    api_attribute :from, Helo::Core::ModelType.new("Helo::MailAddress"), key: "from"
+    api_attribute :to, Helo::Core::ArrayType.new("Helo::MailAddress"), key: "to"
+    api_attribute :cc, Helo::Core::ArrayType.new("Helo::MailAddress"), key: "cc"
+    api_attribute :bcc, Helo::Core::ArrayType.new("Helo::MailAddress"), key: "bcc"
+    api_attribute :reply_to, Helo::Core::ArrayType.new("Helo::MailAddress"), key: "replyTo"
+    api_attribute :subject, :string, key: "subject"
+    api_attribute :html, :string, key: "html"
+    api_attribute :text, :string, key: "text"
+    api_attribute :template, Helo::Core::ModelType.new("Helo::SendMessageRequestTemplate"), key: "template"
+    api_attribute :tracking, Helo::Core::ModelType.new("Helo::SendMessageRequestTracking"), key: "tracking"
+    api_attribute :attachments, Helo::Core::ArrayType.new("Helo::Attachment"), key: "attachments"
+    api_attribute :tags, key: "tags"
+    api_attribute :headers, key: "headers"
+    api_attribute :metadata, key: "metadata"
+  end
+end

data/lib/helo/models/send_message_request_template.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Helo
+  class SendMessageRequestTemplate
+    include Helo::Core::Model
+
+    api_attribute :subject, :string, key: "subject"
+    api_attribute :html, :string, key: "html"
+    api_attribute :text, :string, key: "text"
+    api_attribute :inline_styles, :boolean, key: "inlineStyles"
+    api_attribute :data, key: "data"
+  end
+end

data/lib/helo/models/send_message_request_tracking.rb

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

data/lib/helo/models/send_message_response.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Helo
+  class SendMessageResponse
+    include Helo::Core::Model
+
+  end
+end

data/lib/helo/models/statistics_daily_response.rb

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

data/lib/helo/models/statistics_daily_response_result.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Helo
+  class StatisticsDailyResponseResult
+    include Helo::Core::Model
+
+    api_attribute :timestamp, :date, key: "timestamp"
+    api_attribute :transactional, Helo::Core::ModelType.new("Helo::DeliveryStats"), key: "transactional"
+    api_attribute :broadcast, Helo::Core::ModelType.new("Helo::DeliveryStats"), key: "broadcast"
+  end
+end

data/lib/helo/models/statistics_hourly_response.rb

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

data/lib/helo/models/statistics_hourly_response_result.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Helo
+  class StatisticsHourlyResponseResult
+    include Helo::Core::Model
+
+    api_attribute :timestamp, :datetime, key: "timestamp"
+    api_attribute :transactional, Helo::Core::ModelType.new("Helo::DeliveryStats"), key: "transactional"
+    api_attribute :broadcast, Helo::Core::ModelType.new("Helo::DeliveryStats"), key: "broadcast"
+  end
+end

data/lib/helo/models/statistics_retrieve_daily_request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Helo
+  # Generated request model for query parameters
+  class StatisticsRetrieveDailyRequest
+    include Helo::Core::Model
+
+    api_attribute :channel_id, :string, key: "channelId"
+    api_attribute :from, :date, key: "from"
+    api_attribute :to, :date, key: "to"
+    api_attribute :tags, key: "tags", explode: false
+    api_attribute :timezone, :string, key: "timezone"
+  end
+end