mailjet 1.8.3 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d20c3811d37360e2c0da2176c227b7328f3e4f329fd36c1e91c723e28b3946d9
-  data.tar.gz: d13fbd83f731ddcb162ac9776af0261971bba3d0dac4887d7088c4f1b788c110
+  metadata.gz: 0d0848688b6e2cc4cdc79891142ebdb5589ba9104e9a3a8542272879c3eae647
+  data.tar.gz: 410632493ccee4d6239af3f0062a8babe986139329a1fe7d0d6eca50e2e28fd5
 SHA512:
-  metadata.gz: 7780c42117a2b9e6601f18a9480c0368cf33f4e7723091970dd28817affe727de3540d19c849daa56c1e3c65e0e9d8d4703e9765a73b0344cbc9263be37eae2a
-  data.tar.gz: 5aa121079dc94441e0bd876b7090ceac961a6a84c6264f73d8f65bd1242ff1182b2796d2b7dc0c2dc0b727159e10155c85c969b095df8cc101bab088a416d194
+  metadata.gz: 20c7088de3527b7a0ae07f3e88087cf112e7009e2b1e9399847457481da6ddc6e0842a6bb985e8740dbfd6231b4a22c6c0a727607d8e1f2faf76d0a4cadefc29
+  data.tar.gz: ca85d5e43414bd5bd2523bfb857ff08759a16b5f69d2ee9f74a66007fae5dd988eb213d5ef3d3b292c8671018ab74789dababa3f4af48aeb46fa8d94bd6a3619

data/README.md

@@ -67,6 +67,10 @@ Check out all the resources and Ruby code examples in the [Offical Documentation
     - [Retrieve the first object matching the query](retrieve-the-first-object-matching-the-query)
   - [PUT request](#put-request)
   - [DELETE request](#delete-request)
+- [Deprecated resources](#deprecated-resources)
+  - [Newsletters to campaign drafts](#newsletters-to-campaign-drafts)
+  - [Legacy statistics to statcounters](#legacy-statistics-to-statcounters)
+  - [Domain statistics to recipient ESP statistics](#domain-statistics-to-recipient-esp-statistics)
 - [Send emails with ActionMailer](#send-emails-with-actionmailer)
 - [Track email delivery](#track-email-delivery)
 - [Testing](#testing)
@@ -204,7 +208,7 @@ You can find the list of all available resources for this library, as well as th
 ### Naming conventions
 
 - Class names' first letter is capitalized followed by the rest of the resource name in lowercase (e.g. `listrecipient` will be `Listrecipient` in ruby)
-- Ruby attribute names are the underscored versions of API attributes names (e.g. `IsActive` will be `is_active` in ruby)
+- Ruby attribute names are the underscored versions of API attributes names (e.g. `IsUnsubscribed` will be `is_unsubscribed` in ruby)
 
 ## Request examples
 
@@ -314,13 +318,13 @@ Here's an example of a PUT request:
 ```ruby
 > recipient = Mailjet::Listrecipient.first
 => #<Mailjet::Listrecipient>
-> recipient.is_active = false
-=> false
+> recipient.is_unsubscribed = true
+=> true
 > recipient.attributes
 => {...} # attributes hash
 > recipient.save
 => true
-> recipient.update_attributes(is_active: true)
+> recipient.update_attributes(is_unsubscribed: false)
 => true
 ```
 
@@ -338,6 +342,98 @@ Here's an example of a `DELETE` request:
 
 Upon a successful `DELETE` request the response will not include a response body, but only a `204 No Content` response code.
 
+## Deprecated resources
+
+Mailjet has [deprecated some Email API endpoints](https://dev.mailjet.com/openapi/openapi-mailjet/deprecated-endpoints) and plans to shut them down. Since 1.9.0, the classes that wrap them print a warning the first time they are used, naming the replacement; run Ruby with `-W0` to silence it. They will be removed in 2.0.0, once Mailjet shuts the endpoints down.
+
+| Deprecated class | Replacement |
+| --- | --- |
+| `Newsletter` | `Campaigndraft` |
+| `Newsletter_detailcontent` | `Campaigndraft_detailcontent` |
+| `Newsletter_schedule` | `Campaigndraft_schedule` |
+| `Newsletter_send` | `Campaigndraft_send` |
+| `Newsletter_status` | `Campaigndraft_status` |
+| `Newsletter_test` | `Campaigndraft_test` |
+| `Apikeytotals` | `Statcounters` with `counter_source: "APIKey"` |
+| `Campaigngraphstatistics` | `Statcounters` with `counter_source: "Campaign"` |
+| `Campaignstatistics` | `Statcounters` with `counter_source: "Campaign"` |
+| `Graphstatistics` | `Statcounters` with `counter_resolution: "Day"` or `"Hour"` |
+| `Liststatistics` | `Statcounters` with `counter_source: "List"` |
+| `Messagestatistics` | `Statcounters` with `counter_timing: "Message"` |
+| `Openstatistics` | `Statcounters` with `counter_timing: "Message"` |
+| `Senderstatistics` | `Statcounters` with `counter_source: "Sender"` |
+| `Domainstatistics` | `Statistics_recipient_esp` |
+
+### Newsletters to campaign drafts
+
+The `Campaigndraft` classes take the same calls as the `Newsletter` ones. `Sender` is the ID of a validated sender (see `Mailjet::Sender`).
+
+```ruby
+draft = Mailjet::Campaigndraft.create(
+  "Locale" => "en_US",
+  "Title" => "October news",
+  "Subject" => "October news",
+  "Sender" => sender_id,
+  "SenderEmail" => "sender@example.com",
+  "ContactsListID" => contacts_list_id
+)
+Mailjet::Campaigndraft_detailcontent.create(id: draft.id, "Text-part" => "Hello", "Html-part" => "<p>Hello</p>")
+Mailjet::Campaigndraft_send.create(id: draft.id)
+```
+
+One call behaves differently: `Campaigndraft_detailcontent.find` returns an array, where `Newsletter_detailcontent.find` returned a single object.
+
+```ruby
+# Before
+content = Mailjet::Newsletter_detailcontent.find(newsletter_id)
+
+# After
+content = Mailjet::Campaigndraft_detailcontent.find(draft_id).first
+```
+
+### Legacy statistics to statcounters
+
+`Statcounters` takes a source, a timing and a resolution. The `Day` and `Hour` resolutions also need a `from_ts`/`to_ts` range; without one the API answers 400.
+
+```ruby
+# Before
+Mailjet::Campaignstatistics.find(campaign_id)
+
+# After
+Mailjet::Statcounters.all(
+  source_id: campaign_id,
+  counter_source: "Campaign",
+  counter_timing: "Message",
+  counter_resolution: "Lifetime"
+)
+
+# Totals for your API key, replacing Apikeytotals
+Mailjet::Statcounters.all(counter_source: "APIKey", counter_timing: "Message", counter_resolution: "Lifetime")
+
+# Daily counts, replacing the graph statistics
+Mailjet::Statcounters.all(
+  source_id: campaign_id,
+  counter_source: "Campaign",
+  counter_timing: "Message",
+  counter_resolution: "Day",
+  from_ts: Time.utc(2026, 10, 1).to_i,
+  to_ts: Time.utc(2026, 11, 1).to_i
+)
+```
+
+### Domain statistics to recipient ESP statistics
+
+`Statistics_recipient_esp` groups a campaign's statistics by recipient email service provider (Gmail, Microsoft and so on) rather than by domain, and it needs a campaign ID.
+
+```ruby
+# Before
+Mailjet::Domainstatistics.all
+
+# After
+Mailjet::Statistics_recipient_esp.all(campaign_id: campaign_id)
+Mailjet::Statistics_recipient_esp.all(campaign_id: campaign_id, esp_name: "gmail")
+```
+
 ## Send emails with ActionMailer
 
 A quick walkthrough to use Rails Action Mailer [here](http://guides.rubyonrails.org/action_mailer_basics.html).

data/lib/mailjet/resource.rb

@@ -24,12 +24,13 @@ module Mailjet
     def self.included(base)
       base.extend ClassMethods
       base.class_eval do
-        cattr_accessor :resource_path, :public_operations, :read_only, :filters, :resourceprop, :read_only_attributes, :action, :non_json_urls, :version
+        cattr_accessor :resource_path, :public_operations, :read_only, :filters, :resourceprop, :read_only_attributes, :action, :non_json_urls, :version, :replaced_by
         cattr_writer :connection
 
         self.read_only_attributes = []
 
         def self.connection(options = {})
+          warn_if_deprecated
           class_variable_get(:@@connection) || default_connection(options)
         end
 
@@ -241,6 +242,8 @@ module Mailjet
               'Html-part'
             elsif key == "inline_attachments"
               'Inline_attachments'
+            elsif method == :camelcase && key.to_s == "esp_name"
+              'ESP_Name'
             else
               key.to_s.send(method)
             end
@@ -259,6 +262,14 @@ module Mailjet
         .merge(options.symbolize_keys.slice(*OPTIONS))
       end
 
+      # deprecated resources set replaced_by and warn once, on first use
+      def warn_if_deprecated
+        return if replaced_by.nil? || @deprecation_warned
+
+        @deprecation_warned = true
+        Kernel.warn("[mailjet] #{name} is deprecated and will be removed in 2.0.0. Use #{replaced_by} instead.")
+      end
+
     end
 
     attr_accessor :attributes, :persisted

data/lib/mailjet/resources/apikeytotals.rb

@@ -3,6 +3,7 @@ module Mailjet
     include Mailjet::Resource
     self.resource_path = 'REST/apikeytotals'
     self.public_operations = [:get]
+    self.replaced_by = 'Mailjet::Statcounters with counter_source: "APIKey"'
     self.filters = []
     self.resourceprop = [:blocked_count, :bounced_count, :clicked_count, :delivered_count, :last_activity, :opened_count, :processed_count, :queued_count, :spamcomplaint_count, :unsubscribed_count]
 

data/lib/mailjet/resources/campaigngraphstatistics.rb

@@ -3,6 +3,7 @@ module Mailjet
     include Mailjet::Resource
     self.resource_path = 'REST/campaigngraphstatistics'
     self.public_operations =  [:get]
+    self.replaced_by = 'Mailjet::Statcounters with counter_source: "Campaign"'
     self.filters = [:click, :ids, :open, :range, :spam, :unsub]
     self.resourceprop = [:click_count, :id, :opencount, :spamcount, :tick, :unsubcount]
 

data/lib/mailjet/resources/campaignstatistics.rb

@@ -3,6 +3,7 @@ module Mailjet
     include Mailjet::Resource
     self.resource_path = 'REST/campaignstatistics'
     self.public_operations = [:get]
+    self.replaced_by = 'Mailjet::Statcounters with counter_source: "Campaign"'
     self.filters = [:blocked, :bounced, :campaign_status, :click, :contacts_list, :from_type, :is_deleted, :is_starred, :last_activity_at, :max_last_activity_at, :min_last_activity_at, :news_letter, :open, :queued, :sender, :sent, :spam, :subject, :unsubscribed]
     self.resourceprop = [:blocked_count, :bounced_count, :campaign, :clicked_count, :delivered_count, :last_activity_at, :news_letter, :opened_count, :processed_count, :queued_count, :spam_complaint_count, :unsubscribed_count]
 

data/lib/mailjet/resources/domainstatistics.rb

@@ -3,6 +3,7 @@ module Mailjet
     include Mailjet::Resource
     self.resource_path = 'REST/domainstatistics'
     self.public_operations = [:get]
+    self.replaced_by = 'Mailjet::Statistics_recipient_esp'
     self.filters = [:campaign_id, :campaign_status, :contacts_list, :custom_campaign, :from, :from_domain, :from_id, :from_ts, :from_type, :is_deleted, :is_newsletter_tool, :is_starred, :message_status, :period, :to_ts]
     self.resourceprop = [:blocked_count, :bounced_count, :clicked_count, :delivered_count, :domain, :id, :opened_count, :processed_count, :queued_count, :spam_complaint_count, :unsubscribed_count]
 

data/lib/mailjet/resources/graphstatistics.rb

@@ -3,6 +3,7 @@ module Mailjet
     include Mailjet::Resource
     self.resource_path = 'REST/graphstatistics'
     self.public_operations = [:get]
+    self.replaced_by = 'Mailjet::Statcounters with counter_resolution: "Day" or "Hour"'
     self.filters = [:campaign_id, :campaign_status, :contact, :contacts_list, :custom_campaign, :from, :from_domain, :from_id, :from_ts, :from_type, :is_deleted, :is_newsletter_tool, :is_starred, :message_status, :period, :scale, :to_ts]
     self.resourceprop = [:blocked_count, :bounced_count, :clicked_count, :delivered_count, :opened_count, :processed_count, :queued_count, :ref_timestamp, :sendtime_start, :spamcomplaint_count, :unsubscribed_count]
 

data/lib/mailjet/resources/liststatistics.rb

@@ -3,6 +3,7 @@ module Mailjet
     include Mailjet::Resource
     self.resource_path = 'REST/liststatistics'
     self.public_operations = [:get]
+    self.replaced_by = 'Mailjet::Statcounters with counter_source: "List"'
     self.filters = [:address, :calc_active_unsub, :exclude_id, :is_deleted, :name]
     self.resourceprop = [:active_count, :active_unsubscribed_count, :address, :blocked_count, :bounced_count, :clicked_count, :created_at, :delivered_count, :id, :is_deleted, :last_activity_at, :name, :opened_count, :spam_complaint_count, :subscriber_count, :unsubscribed_count]
 

data/lib/mailjet/resources/messagestatistics.rb

@@ -3,6 +3,7 @@ module Mailjet
     include Mailjet::Resource
     self.resource_path = 'REST/messagestatistics'
     self.public_operations = [:get]
+    self.replaced_by = 'Mailjet::Statcounters with counter_timing: "Message"'
     self.filters = [:campaign_id, :campaign_status, :contact_email, :contact_id, :custom_campaign, :from, :from_domain, :from_id, :from_ts, :from_type, :is_deleted, :is_newsletter_tool, :is_starred, :message_status, :period, :to_ts]
     self.resourceprop = [:average_click_delay, :average_clicked_count, :average_open_delay, :average_opened_count, :blocked_count, :bounced_count, :campaign_count, :clicked_count, :delivered_count, :opened_count, :processed_count, :queued_count, :spam_complaint_count, :transactional_count, :unsubscribed_count]
 

data/lib/mailjet/resources/newsletter.rb

@@ -3,6 +3,7 @@ module Mailjet
     include Mailjet::Resource
     self.resource_path = 'REST/newsletter'
     self.public_operations = [:get, :put, :post]
+    self.replaced_by = 'Mailjet::Campaigndraft'
     self.filters = [:campaign, :contacts_list, :delivered_at, :edit_mode, :is_archived, :is_campaign, :is_deleted, :is_handled, :is_starred, :modified, :news_letter_template, :segmentation, :status, :subject]
     self.resourceprop = [:callback, :campaign, :contacts_list, :created_at, :delivered_at, :edit_mode, :edit_type, :footer, :footer_address, :footer_wysiwyg_type, :header_filename, :header_link, :header_text, :header_url, :id, :ip, :is_handled, :is_starred, :is_text_part_included, :locale, :modified_at, :permalink, :permalink_host, :permalink_wysiwyg_type, :politeness_mode, :reply_email, :segmentation, :segmentation_id, :sender, :sender_email, :sender_name, :status, :subject, :template, :test_address, :title, :url, 'CampaignID', 'CampaignALT', 'ContactsListID', 'ContactsListALT', 'SegmentationID', 'SegmentationALT', :contacts_list_id]
   end

data/lib/mailjet/resources/newsletter_detailcontent.rb

@@ -4,6 +4,7 @@ module Mailjet
     self.action = "detailcontent"
     self.resource_path = "REST/newsletter/id/#{self.action}"
     self.public_operations = [:get, :post]
+    self.replaced_by = 'Mailjet::Campaigndraft_detailcontent'
     self.filters = []
     self.resourceprop = [:text_part, :html_part, :headers, :mjml_content]
 

data/lib/mailjet/resources/newsletter_schedule.rb

@@ -4,6 +4,7 @@ module Mailjet
     self.action = "schedule"
     self.resource_path = "REST/newsletter/id/#{self.action}"
     self.public_operations = [:get, :post, :delete]
+    self.replaced_by = 'Mailjet::Campaigndraft_schedule'
     self.filters = []
     self.resourceprop = [:date]
 

data/lib/mailjet/resources/newsletter_send.rb

@@ -4,6 +4,7 @@ module Mailjet
     self.action = "send"
     self.resource_path = "REST/newsletter/id/#{self.action}"
     self.public_operations = [:post]
+    self.replaced_by = 'Mailjet::Campaigndraft_send'
     self.filters = []
     self.resourceprop = []
   end

data/lib/mailjet/resources/newsletter_status.rb

@@ -4,6 +4,7 @@ module Mailjet
     self.action = 'status'
     self.resource_path = "REST/newsletter/id/#{self.action}"
     self.public_operations =  [:get]
+    self.replaced_by = 'Mailjet::Campaigndraft_status'
     self.filters = []
     self.resourceprop = []
 

data/lib/mailjet/resources/newsletter_test.rb

@@ -4,6 +4,7 @@ module Mailjet
     self.action = "test"
     self.resource_path = "REST/newsletter/id/#{self.action}"
     self.public_operations = [:post]
+    self.replaced_by = 'Mailjet::Campaigndraft_test'
     self.filters = []
     self.resourceprop = [:email, :name]
 

data/lib/mailjet/resources/openstatistics.rb

@@ -3,6 +3,7 @@ module Mailjet
     include Mailjet::Resource
     self.resource_path = 'REST/openstatistics'
     self.public_operations = [:get]
+    self.replaced_by = 'Mailjet::Statcounters with counter_timing: "Message"'
     self.filters = [:campaign_id, :campaign_status, :contacts_list, :custom_campaign, :from, :from_domain, :from_id, :from_ts, :from_type, :is_deleted, :is_newsletter_tool, :is_starred, :message_status, :period, :to_ts]
     self.resourceprop = [:opened_count, :opened_delay, :processed_count]
 

data/lib/mailjet/resources/senderstatistics.rb

@@ -3,6 +3,7 @@ module Mailjet
     include Mailjet::Resource
     self.resource_path = 'REST/senderstatistics'
     self.public_operations = [:get]
+    self.replaced_by = 'Mailjet::Statcounters with counter_source: "Sender"'
     self.filters = [:domain, :email, :sender]
     self.resourceprop = [:blocked_count, :bounced_count, :clicked_count, :delivered_count, :last_activity_at, :opened_count, :processed_count, :queued_count, :sender, :spam_complaint_count, :unsubscribed_count]
 

data/lib/mailjet/resources/statcounters.rb

@@ -3,7 +3,7 @@ module Mailjet
     include Mailjet::Resource
     self.resource_path = 'REST/statcounters'
     self.public_operations = [:get]
-    self.filters = [:source_id, :counter_resolution, :counter_source, :counter_timing]
+    self.filters = [:source_id, :counter_resolution, :counter_source, :counter_timing, :from_ts, :to_ts]
     self.resourceprop = [
       :api_key_id,
       :event_click_delay,

data/lib/mailjet/resources/statistics_recipient_esp.rb

@@ -0,0 +1,30 @@
+module Mailjet
+  class Statistics_recipient_esp
+    include Mailjet::Resource
+    self.resource_path = 'REST/statistics/recipient-esp'
+    self.public_operations = [:get]
+    self.filters = [:campaign_id, :esp_name]
+    self.resourceprop = [
+      :attempted_messages_count,
+      :click_through_rate,
+      :clicked_messages_count,
+      :deferred_messages_count,
+      :deferred_rate,
+      :delivered_messages_count,
+      :esp_name,
+      :hard_bounced_messages_count,
+      :hard_bounced_rate,
+      :open_rate,
+      :opened_messages_count,
+      :soft_bounced_messages_count,
+      :soft_bounced_rate,
+      :spam_reports_count,
+      :spam_reports_rate,
+      :unsubscribed_messages_count,
+      :unsubscribed_rate,
+    ]
+
+    self.read_only = true
+
+  end
+end

data/lib/mailjet/version.rb

@@ -1,3 +1,3 @@
 module Mailjet
-  VERSION = "1.8.3"
+  VERSION = "1.9.0"
 end

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: mailjet
 version: !ruby/object:Gem::Version
-  version: 1.8.3
+  version: 1.9.0
 platform: ruby
 authors:
 - Tyler Nappy
 - Jean-Baptiste Escoyez
 - Aurélien AMILIN
 - Benoit Bénézech
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -268,6 +269,7 @@ files:
 - lib/mailjet/resources/senderstatistics.rb
 - lib/mailjet/resources/statcounters.rb
 - lib/mailjet/resources/statistics_linkclick.rb
+- lib/mailjet/resources/statistics_recipient_esp.rb
 - lib/mailjet/resources/template.rb
 - lib/mailjet/resources/template_detailcontent.rb
 - lib/mailjet/resources/toplinkclicked.rb
@@ -305,11 +307,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Mailjet a powerful all-in-one email service provider clients can use to get
   maximum insight and deliverability results from both their marketing and transactional
   emails. Our analytics tools and intelligent APIs give senders the best understanding
   of how to maximize benefits for each individual contact, with each email sent.
 test_files: []
-...