helo-email-sdk 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24f067959418c6bacc218f81802bbcbda0eacedd25e5bc16f156c4e6e7ef2192
-  data.tar.gz: 1ee808b62e899e0df4a98e9c24385f5045df97daba11d55301a3312fb064bb03
+  metadata.gz: 84b8003d01a3e6278f8dff8ff9fba2a336475c5742fc2ac056c48af1137da1e8
+  data.tar.gz: a5de4d620766c12163910d1636c8fa2608d61eef455b28d336d1e4937e7ffb82
 SHA512:
-  metadata.gz: b06dc543d3d8773f415b3d0413c5524006742af0a6a6cb74a750a8e4ac9a552f83e24d631917b84cafb3810022694e953ab7a3034d6e6ab40a16d724afddd389
-  data.tar.gz: f07bba17cd695cb7728cef33bc396222c78208d541c0e331a15e8abff22b9beb77ee3bfdc4c00ae539618343ab994265822e8239294041c54f09be33d4a1a9bb
+  metadata.gz: e019cbeb7967169e5a6dc3f44c0a7ac82bc807be292495e70ac17b181a02eddd8157ab2346f1f8c0a46eb20745b60f84caec37902c39ba9db4f2aa46ee0fba4d
+  data.tar.gz: 951d97625eb2944af8713e90b02fcac28a3a7d2be603871ffa553d6a0f51370bd3ec4f43cb96020a65011ef07469fff7b7b22ce4e2fbc30fcde48d60c29f53af

data/README.md

@@ -167,4 +167,5 @@ To compute a signature yourself — signing a fixture in tests, for example —
 - [Helo::Broadcasts](docs/Broadcasts.md)
 - [Helo::Statistics](docs/Statistics.md)
 - [Helo::Suppressions](docs/Suppressions.md)
+- [Helo::Templates](docs/Templates.md)
 - [Helo::Webhooks](docs/Webhooks.md)

data/lib/helo/api_error.rb

@@ -20,4 +20,7 @@ module Helo
       @_json_response ||= response_body.try(:deep_symbolize_keys) || {}
     end
   end
+
+  class ConnectionError < APIError
+  end
 end

data/lib/helo/apis/templates.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Helo
+  class Templates < API
+    def list(request_data = {})
+      request = TemplatesListRequest.new(request_data)
+      response = @client.request(:get, "/templates", params: request.to_params)
+      PaginatedResponseOfTemplateSummaryResponse.from_hash(response.body)
+    end
+
+    def create(request_data)
+      request = CreateTemplateRequest.new(request_data)
+      response = @client.request(:post, "/templates", body: request.to_params)
+      TemplateResponse.from_hash(response.body)
+    end
+
+    def render_draft(request_data)
+      request = RenderDraftRequest.new(request_data)
+      response = @client.request(:post, "/templates/render", body: request.to_params)
+      RenderTemplateResponse.from_hash(response.body)
+    end
+
+    def retrieve(id)
+      response = @client.request(:get, "/templates/#{id}")
+      TemplateResponse.from_hash(response.body)
+    end
+
+    def update(id, request_data)
+      request = UpdateTemplateRequest.new(request_data)
+      response = @client.request(:patch, "/templates/#{id}", body: request.to_params)
+      TemplateResponse.from_hash(response.body)
+    end
+
+    def delete(id)
+      response = @client.request(:delete, "/templates/#{id}")
+      nil
+    end
+
+    def render(id, request_data)
+      request = RenderTemplateRequest.new(request_data)
+      response = @client.request(:post, "/templates/#{id}/render", body: request.to_params)
+      RenderTemplateResponse.from_hash(response.body)
+    end
+
+    class_methods :list, :create, :render_draft, :retrieve, :update, :delete, :render
+  end
+end

data/lib/helo/client.rb

@@ -22,7 +22,7 @@ module Helo
     end
 
     def handle_connection_error(exception)
-      raise APIError.new("Connection failed: #{exception.message}")
+      raise ConnectionError.new("Connection failed: #{exception.message}")
     end
   end
 end

data/lib/helo/models/create_domain_request.rb

@@ -6,5 +6,6 @@ module Helo
 
     api_attribute :name, :string, key: "name"
     api_attribute :channel_ids, key: "channelIds"
+    api_attribute :enable_custom_tracking, :boolean, key: "enableCustomTracking"
   end
 end

data/lib/helo/models/create_template_request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Helo
+  class CreateTemplateRequest
+    include Helo::Core::Model
+
+    api_attribute :name, :string, key: "name"
+    api_attribute :subject, :string, key: "subject"
+    api_attribute :html, :string, key: "html"
+    api_attribute :mjml, :string, key: "mjml"
+    api_attribute :text, :string, key: "text"
+    api_attribute :channel_ids, key: "channelIds"
+  end
+end

data/lib/helo/models/dns_records_response.rb

@@ -7,5 +7,6 @@ module Helo
     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"
   end
 end

data/lib/helo/models/paginated_response_of_template_summary_response.rb

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

data/lib/helo/models/render_draft_request.rb

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

data/lib/helo/models/render_template_request.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Helo
+  class RenderTemplateRequest
+    include Helo::Core::Model
+
+    api_attribute :inline_styles, :boolean, key: "inlineStyles"
+    api_attribute :data, key: "data"
+  end
+end

data/lib/helo/models/render_template_response.rb

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Helo
+  class TemplateResponse
+    include Helo::Core::Model
+
+    api_attribute :id, :string, key: "id"
+    api_attribute :created_at, :datetime, key: "createdAt"
+    api_attribute :updated_at, :datetime, key: "updatedAt"
+    api_attribute :version, :integer, key: "version"
+    api_attribute :name, :string, key: "name"
+    api_attribute :subject, :string, key: "subject"
+    api_attribute :html, :string, key: "html"
+    api_attribute :mjml, :string, key: "mjml"
+    api_attribute :text, :string, key: "text"
+    api_attribute :channel_ids, key: "channelIds"
+  end
+end

data/lib/helo/models/template_summary_response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Helo
+  class TemplateSummaryResponse
+    include Helo::Core::Model
+
+    api_attribute :id, :string, key: "id"
+    api_attribute :created_at, :datetime, key: "createdAt"
+    api_attribute :updated_at, :datetime, key: "updatedAt"
+    api_attribute :name, :string, key: "name"
+    api_attribute :subject, :string, key: "subject"
+    api_attribute :channel_ids, key: "channelIds"
+  end
+end

data/lib/helo/models/templates_list_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Helo
+  # Generated request model for query parameters
+  class TemplatesListRequest
+    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/update_domain_request.rb

@@ -5,5 +5,6 @@ module Helo
     include Helo::Core::Model
 
     api_attribute :channel_ids, key: "channelIds"
+    api_attribute :enable_custom_tracking, :boolean, key: "enableCustomTracking"
   end
 end

data/lib/helo/models/update_template_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Helo
+  class UpdateTemplateRequest
+    include Helo::Core::Model
+
+    api_attribute :name, :string, key: "name"
+    api_attribute :subject, :string, key: "subject"
+    api_attribute :html, :string, key: "html", nullable: true
+    api_attribute :mjml, :string, key: "mjml", nullable: true
+    api_attribute :text, :string, key: "text", nullable: true
+    api_attribute :channel_ids, key: "channelIds", nullable: true
+    api_attribute :version, :integer, key: "version"
+  end
+end

data/lib/helo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Helo
-  VERSION = "1.1.0"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: helo-email-sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Helo Email
@@ -111,6 +111,7 @@ files:
 - lib/helo/apis/sending.rb
 - lib/helo/apis/statistics.rb
 - lib/helo/apis/suppressions.rb
+- lib/helo/apis/templates.rb
 - lib/helo/apis/webhooks.rb
 - lib/helo/client.rb
 - lib/helo/configuration.rb
@@ -161,6 +162,7 @@ files:
 - 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_template_request.rb
 - lib/helo/models/create_webhook_request.rb
 - lib/helo/models/delivered_details.rb
 - lib/helo/models/delivery_stats.rb
@@ -198,6 +200,7 @@ files:
 - 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/paginated_response_of_template_summary_response.rb
 - lib/helo/models/pagination_result_of_channel_basic_response.rb
 - lib/helo/models/pagination_result_of_webhook_response.rb
 - lib/helo/models/recipient_complained_webhook_payload.rb
@@ -208,6 +211,9 @@ files:
 - lib/helo/models/remove_suppression_result.rb
 - lib/helo/models/remove_suppressions_request.rb
 - lib/helo/models/remove_suppressions_response.rb
+- lib/helo/models/render_draft_request.rb
+- lib/helo/models/render_template_request.rb
+- lib/helo/models/render_template_response.rb
 - lib/helo/models/resubscribed_details.rb
 - lib/helo/models/return_path_domain_verification_failed_payload.rb
 - lib/helo/models/return_path_domain_verified_payload.rb
@@ -235,10 +241,14 @@ files:
 - lib/helo/models/suppression_response.rb
 - lib/helo/models/suppression_result.rb
 - lib/helo/models/suppressions_list_request.rb
+- lib/helo/models/template_response.rb
+- lib/helo/models/template_summary_response.rb
+- lib/helo/models/templates_list_request.rb
 - lib/helo/models/unsubscribed_details.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_template_request.rb
 - lib/helo/models/update_webhook_request.rb
 - lib/helo/models/validation_error.rb
 - lib/helo/models/webhook_header.rb