gds-api-adapters 77.0.0 → 77.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ea534ae361e87fde66ed0a9909c3920b0a58c86ad5e26b3dd4c7d13baabe15c
-  data.tar.gz: a24876d1c08767f5d934e9327feb212a6e35f33142c4c6764e85f28eca525de5
+  metadata.gz: 4ae9935a6f00ed43737c077e942ba2fb89deff13e02bac93917b1db6215162d2
+  data.tar.gz: 0c7da0e74c80afc296468a98cd79f11f357957b12ba9ed90247c2d2ac0b0aff0
 SHA512:
-  metadata.gz: 23a867c3eb864e2078989ac9f395d572a3679a06ad1efc20f080563d4aabd65e46e27b29118e77daa130924d00c9de4c6f7a7a4f1131d2b242099dc3a05783d6
-  data.tar.gz: 2340a2464e1971055760d1169f05e18c40e9ef50e75610b763f6c6018fcae863a8669aa77a8c9aedaa9ed3632c8e463f0147b92a80d2a811c69d2f4b1ec47a94
+  metadata.gz: '0279189027b025193a9340b849a3fea6c682563af8affbf73ebdae40a83f4aecbaa878b039d6d23311bda729c7ab7fb94f1fa6b9739e867ac44136830f145c0e'
+  data.tar.gz: dc55f3c73fb2c1e45ac97dcd74581f3c52701186ca7f96171abbea8178d6721629f1c6deee08e7dce3d68bcf5277544f2bced1189fa9bbeb49f2b179d0da14af

data/lib/gds_api/email_alert_api.rb

@@ -247,6 +247,22 @@ class GdsApi::EmailAlertApi < GdsApi::Base
     )
   end
 
+  # Unsubscribe all users for a subscription list
+  # optionally send a notification email explaining the reason
+  #
+  # @param [string]               subscriber_list_id    Identifier for the subscription list
+  # @param [string] (optional)    body                  Optional email body to send to alert users they are being unsubscribed
+  # @param [string] (optional)    sender_message_id     A UUID to prevent multiple emails for the same event
+  def bulk_unsubscribe(subscriber_list_id:, body: nil, sender_message_id: nil)
+    post_json(
+      "#{endpoint}/subscriber-lists/#{subscriber_list_id}/bulk-unsubscribe",
+      {
+        body: body,
+        sender_message_id: sender_message_id,
+      }.compact,
+    )
+  end
+
 private
 
   def nested_query_string(params)

data/lib/gds_api/test_helpers/email_alert_api.rb

@@ -408,6 +408,53 @@ module GdsApi
           .to_return(status: 404)
       end
 
+      def stub_email_alert_api_bulk_unsubscribe(subscriber_list_id:)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{subscriber_list_id}/bulk-unsubscribe")
+          .to_return(status: 202)
+      end
+
+      def stub_email_alert_api_bulk_unsubscribe_with_message(subscriber_list_id:, body:, sender_message_id:)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{subscriber_list_id}/bulk-unsubscribe")
+        .with(
+          body: {
+            body: body,
+            sender_message_id: sender_message_id,
+          }.to_json,
+        ).to_return(status: 202)
+      end
+
+      def stub_email_alert_api_bulk_unsubscribe_not_found(subscriber_list_id:)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{subscriber_list_id}/bulk-unsubscribe")
+          .to_return(status: 404)
+      end
+
+      def stub_email_alert_api_bulk_unsubscribe_not_found_with_message(subscriber_list_id:, body:, sender_message_id:)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{subscriber_list_id}/bulk-unsubscribe")
+        .with(
+          body: {
+            body: body,
+            sender_message_id: sender_message_id,
+          }.to_json,
+        ).to_return(status: 404)
+      end
+
+      def stub_email_alert_api_bulk_unsubscribe_conflict_with_message(subscriber_list_id:, body:, sender_message_id:)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{subscriber_list_id}/bulk-unsubscribe")
+        .with(
+          body: {
+            body: body,
+            sender_message_id: sender_message_id,
+          }.to_json,
+        ).to_return(status: 409)
+      end
+
+      def stub_email_alert_api_bulk_unsubscribe_bad_request(subscriber_list_id:, body:)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{subscriber_list_id}/bulk-unsubscribe")
+        .with(
+          body: { body: body }.to_json,
+        ).to_return(status: 422)
+      end
+
     private
 
       def get_subscriber_response(id, address, govuk_account_id)

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "77.0.0".freeze
+  VERSION = "77.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 77.0.0
+  version: 77.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-10 00:00:00.000000000 Z
+date: 2022-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable