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

data/lib/helo/models/statistics_retrieve_hourly_request.rb

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

data/lib/helo/models/statistics_retrieve_totals_request.rb

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

data/lib/helo/models/statistics_totals_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Helo
+  class StatisticsTotalsResponse
+    include Helo::Core::Model
+
+    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/suppression_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Helo
+  class SuppressionResponse
+    include Helo::Core::Model
+
+    api_attribute :email, :string, key: "email"
+    api_attribute :reason, :string, key: "reason"
+    api_attribute :created_at, :datetime, key: "createdAt"
+  end
+end

data/lib/helo/models/suppression_result.rb

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Helo
+  # Generated request model for query parameters
+  class SuppressionsListRequest
+    include Helo::Core::Model
+
+    api_attribute :channel_id, :string, key: "channelId"
+    api_attribute :mail_type, :string, key: "mailType"
+    api_attribute :reason, :string, key: "reason"
+    api_attribute :email, :string, key: "email"
+    api_attribute :limit, :integer, key: "limit"
+    api_attribute :offset, :integer, key: "offset"
+  end
+end

data/lib/helo/models/unsubscribed_webhook_payload.rb

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Helo
+  class UpdateChannelRequest
+    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::UpdateChannelTracking"), key: "tracking"
+  end
+end

data/lib/helo/models/update_channel_tracking.rb

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

data/lib/helo/models/update_domain_request.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Helo
+  class UpdateDomainRequest
+    include Helo::Core::Model
+
+    api_attribute :channel_ids, key: "channelIds"
+  end
+end

data/lib/helo/models/update_webhook_request.rb

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

data/lib/helo/models/validation_error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Helo
+  class ValidationError
+    include Helo::Core::Model
+
+    api_attribute :message, :string, key: "message"
+  end
+end

data/lib/helo/models/webhook_header.rb

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

data/lib/helo/models/webhook_last_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Helo
+  class WebhookLastResponse
+    include Helo::Core::Model
+
+    api_attribute :status_code, :integer, key: "statusCode", nullable: true
+    api_attribute :error, :string, key: "error", nullable: true
+    api_attribute :at, :datetime, key: "at"
+  end
+end

data/lib/helo/models/webhook_payload_common.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Helo
+  class WebhookPayloadCommon
+    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/models/webhook_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Helo
+  class WebhookResponse
+    include Helo::Core::Model
+
+    api_attribute :id, :string, key: "id"
+    api_attribute :channel_id, :string, key: "channelId", nullable: true
+    api_attribute :url, :string, key: "url"
+    api_attribute :payload_signing_key, :string, key: "payloadSigningKey"
+    api_attribute :enabled, :boolean, key: "enabled"
+    api_attribute :additional_headers, Helo::Core::ArrayType.new("Helo::WebhookHeader"), key: "additionalHeaders"
+    api_attribute :events, key: "events"
+    api_attribute :last_response, Helo::Core::ModelType.new("Helo::WebhookLastResponse"), key: "lastResponse", nullable: true
+  end
+end

data/lib/helo/models/webhooks_list_request.rb

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

data/lib/helo/version.rb

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

data/lib/helo-email-sdk.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "helo"

data/lib/helo.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Define module hierarchy before loading core
+module Helo; end
+
+# Core framework
+require_relative "helo/core/model_type"
+require_relative "helo/core/array_type"
+require_relative "helo/core/model"
+require_relative "helo/core/api_error"
+require_relative "helo/core/configuration"
+require_relative "helo/core/client"
+require_relative "helo/core/api"
+
+# SDK
+require_relative "helo/version"
+require_relative "helo/api_error"
+require_relative "helo/configuration"
+require_relative "helo/client"
+
+
+module Helo
+  def self.configure
+    @configuration ||= Configuration.new
+    yield(@configuration)
+    API.default_client = Client.new(@configuration)
+  end
+
+  class API < Core::API
+  end
+end
+
+Dir[File.join(__dir__, "helo", "enums", "*.rb")].sort.each { |file| require file }
+Dir[File.join(__dir__, "helo", "models", "*.rb")].sort.each { |file| require file }
+Dir[File.join(__dir__, "helo", "apis", "*.rb")].sort.each { |file| require file }

metadata

@@ -0,0 +1,239 @@
+--- !ruby/object:Gem::Specification
+name: helo-email-sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.beta.1
+platform: ruby
+authors:
+- Helo Email
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby SDK for the Helo Email API (https://helohq.com).
+email:
+- rubygems@helohq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/helo-email-sdk.rb
+- lib/helo.rb
+- lib/helo/api_error.rb
+- lib/helo/apis/activity.rb
+- lib/helo/apis/broadcasts.rb
+- lib/helo/apis/channels.rb
+- lib/helo/apis/domains.rb
+- lib/helo/apis/sending.rb
+- lib/helo/apis/statistics.rb
+- lib/helo/apis/suppressions.rb
+- lib/helo/apis/webhooks.rb
+- lib/helo/client.rb
+- lib/helo/configuration.rb
+- lib/helo/core/api.rb
+- lib/helo/core/api_error.rb
+- lib/helo/core/array_type.rb
+- lib/helo/core/client.rb
+- lib/helo/core/configuration.rb
+- lib/helo/core/model.rb
+- lib/helo/core/model_type.rb
+- lib/helo/enums/attachment_disposition.rb
+- lib/helo/enums/broadcast_status.rb
+- lib/helo/enums/delivery_type.rb
+- lib/helo/enums/dns_record_status.rb
+- lib/helo/enums/dns_record_type.rb
+- lib/helo/enums/event_type.rb
+- lib/helo/enums/mail_type.rb
+- lib/helo/enums/suppression_reason.rb
+- lib/helo/enums/webhook_event.rb
+- lib/helo/models/accepted_webhook_payload.rb
+- lib/helo/models/activity_event.rb
+- lib/helo/models/activity_list_events_request.rb
+- lib/helo/models/activity_list_messages_request.rb
+- lib/helo/models/activity_mail_address.rb
+- lib/helo/models/attachment.rb
+- lib/helo/models/bounced_webhook_payload.rb
+- lib/helo/models/broadcast_content.rb
+- lib/helo/models/broadcast_content_attachment.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/broadcast_response.rb
+- lib/helo/models/broadcast_statistics.rb
+- lib/helo/models/broadcast_tracking.rb
+- lib/helo/models/broadcasts_list_failures_request.rb
+- lib/helo/models/broadcasts_list_request.rb
+- lib/helo/models/broadcasts_list_suppressions_request.rb
+- lib/helo/models/channel_basic_response.rb
+- lib/helo/models/channel_details_response.rb
+- lib/helo/models/channel_tracking.rb
+- lib/helo/models/channels_list_request.rb
+- lib/helo/models/clicked_webhook_payload.rb
+- lib/helo/models/complained_webhook_payload.rb
+- lib/helo/models/create_channel_request.rb
+- lib/helo/models/create_channel_tracking.rb
+- lib/helo/models/create_domain_request.rb
+- lib/helo/models/create_suppressions_request.rb
+- lib/helo/models/create_suppressions_response.rb
+- lib/helo/models/create_webhook_request.rb
+- lib/helo/models/delivered_webhook_payload.rb
+- lib/helo/models/delivery_stats.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_response.rb
+- lib/helo/models/domain_with_dns_response.rb
+- lib/helo/models/domains_list_request.rb
+- lib/helo/models/error_response.rb
+- lib/helo/models/mail_address.rb
+- lib/helo/models/message.rb
+- lib/helo/models/message_details_response.rb
+- 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/opened_webhook_payload.rb
+- lib/helo/models/paginated_events_response.rb
+- lib/helo/models/paginated_messages_response.rb
+- lib/helo/models/paginated_response_of_broadcast.rb
+- lib/helo/models/paginated_response_of_broadcast_failure.rb
+- lib/helo/models/paginated_response_of_broadcast_suppression.rb
+- lib/helo/models/paginated_response_of_domain_response.rb
+- lib/helo/models/paginated_response_of_suppression_response.rb
+- lib/helo/models/pagination_result_of_channel_basic_response.rb
+- lib/helo/models/pagination_result_of_webhook_response.rb
+- lib/helo/models/processed_webhook_payload.rb
+- lib/helo/models/recipient_event_fields.rb
+- lib/helo/models/recipient_headers.rb
+- lib/helo/models/remove_suppression_result.rb
+- lib/helo/models/remove_suppressions_request.rb
+- lib/helo/models/remove_suppressions_response.rb
+- lib/helo/models/resubscribed_webhook_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
+- lib/helo/models/send_broadcast_request_tracking.rb
+- lib/helo/models/send_broadcast_response.rb
+- lib/helo/models/send_message_accepted_response.rb
+- lib/helo/models/send_message_batch_request.rb
+- lib/helo/models/send_message_batch_response.rb
+- lib/helo/models/send_message_failed_response.rb
+- lib/helo/models/send_message_request.rb
+- lib/helo/models/send_message_request_template.rb
+- lib/helo/models/send_message_request_tracking.rb
+- lib/helo/models/send_message_response.rb
+- lib/helo/models/statistics_daily_response.rb
+- lib/helo/models/statistics_daily_response_result.rb
+- lib/helo/models/statistics_hourly_response.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/statistics_totals_response.rb
+- lib/helo/models/suppression_response.rb
+- lib/helo/models/suppression_result.rb
+- lib/helo/models/suppressions_list_request.rb
+- lib/helo/models/unsubscribed_webhook_payload.rb
+- lib/helo/models/update_channel_request.rb
+- lib/helo/models/update_channel_tracking.rb
+- lib/helo/models/update_domain_request.rb
+- lib/helo/models/update_webhook_request.rb
+- lib/helo/models/validation_error.rb
+- lib/helo/models/webhook_header.rb
+- lib/helo/models/webhook_last_response.rb
+- lib/helo/models/webhook_payload_common.rb
+- lib/helo/models/webhook_response.rb
+- lib/helo/models/webhooks_list_request.rb
+- lib/helo/version.rb
+homepage: https://rubygems.org/gems/helo-email-sdk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/helo-email-sdk
+  source_code_uri: https://github.com/helo-email/helo-sdk-ruby
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: Helo Ruby SDK
+test_files: []