Class: GdsApi::EmailAlertApi
- Defined in:
- lib/gds_api/email_alert_api.rb
Overview
Adapter for the Email Alert API
Instance Attribute Summary
Attributes inherited from Base
Instance Method Summary collapse
-
#authenticate_subscriber_by_govuk_account(govuk_account_session:) ⇒ Hash
Verify a GOV.UK Account-holder has a corresponding subscriber.
-
#bulk_unsubscribe(slug:, govuk_request_id: nil, body: nil, sender_message_id: nil) ⇒ Object
Unsubscribe all users for a subscription list optionally send a notification email explaining the reason.
-
#change_subscriber(id:, new_address:, on_conflict: nil) ⇒ Hash
Patch a Subscriber.
-
#change_subscription(id:, frequency:) ⇒ Hash
Patch a Subscription.
-
#create_content_change(content_change, headers = {}) ⇒ Object
Post a content change.
-
#find_or_create_subscriber_list(attributes) ⇒ Object
Get or Post subscriber list.
-
#find_subscriber_by_govuk_account(govuk_account_id:) ⇒ Hash
Find a subscriber which has been “linked” to a GOV.UK Account.
-
#find_subscriber_list(attributes) ⇒ Object
Get a subscriber list.
-
#get_latest_matching_subscription(id) ⇒ Hash
Get the latest Subscription that has the same subscriber_list and email as the Subscription associated with the ‘id` passed.
-
#get_subscriber_list(slug:) ⇒ Hash
Get a Subscriber List.
-
#get_subscription(id) ⇒ Hash
Get a Subscription.
-
#get_subscriptions(id:, order: nil) ⇒ Hash
Get Subscriptions for a Subscriber.
-
#link_subscriber_to_govuk_account(govuk_account_session:) ⇒ Hash
Mark a subscriber as “linked” to its corresponding GOV.UK Account.
-
#send_subscriber_verification_email(address:, destination:) ⇒ Hash
Verify a subscriber has control of a provided email.
-
#send_subscription_verification_email(address:, frequency:, topic_id:) ⇒ Object
Verify a subscriber intends to be added to a subscription.
-
#subscribe(subscriber_list_id:, address:, frequency: "immediately", skip_confirmation_email: false) ⇒ Hash
Subscribe.
-
#topic_matches(attributes) ⇒ Hash
Get topic matches.
-
#unsubscribe(uuid) ⇒ nil
Unsubscribe subscriber from subscription.
-
#unsubscribe_subscriber(id) ⇒ nil
Unsubscribe subscriber from everything.
-
#update_subscriber_list_details(slug:, params: {}) ⇒ Object
Update subscriber list details, such as title.
Methods inherited from Base
#client, #create_client, #get_list, #initialize, #url_for_slug
Constructor Details
This class inherits a constructor from GdsApi::Base
Instance Method Details
#authenticate_subscriber_by_govuk_account(govuk_account_session:) ⇒ Hash
Verify a GOV.UK Account-holder has a corresponding subscriber
178 179 180 181 182 183 |
# File 'lib/gds_api/email_alert_api.rb', line 178 def authenticate_subscriber_by_govuk_account(govuk_account_session:) post_json( "#{endpoint}/subscribers/govuk-account", govuk_account_session: govuk_account_session, ) end |
#bulk_unsubscribe(slug:, govuk_request_id: nil, body: nil, sender_message_id: nil) ⇒ Object
Unsubscribe all users for a subscription list optionally send a notification email explaining the reason
250 251 252 253 254 255 256 257 258 259 260 261 |
# File 'lib/gds_api/email_alert_api.rb', line 250 def bulk_unsubscribe(slug:, govuk_request_id: nil, body: nil, sender_message_id: nil) post_json( "#{endpoint}/subscriber-lists/#{slug}/bulk-unsubscribe", { body: body, sender_message_id: , }.compact, { "Govuk-Request-Id" => govuk_request_id, }.compact, ) end |
#change_subscriber(id:, new_address:, on_conflict: nil) ⇒ Hash
Patch a Subscriber
153 154 155 156 157 158 |
# File 'lib/gds_api/email_alert_api.rb', line 153 def change_subscriber(id:, new_address:, on_conflict: nil) patch_json( "#{endpoint}/subscribers/#{uri_encode(id)}", { new_address: new_address, on_conflict: on_conflict }.compact, ) end |
#change_subscription(id:, frequency:) ⇒ Hash
Patch a Subscription
166 167 168 169 170 171 |
# File 'lib/gds_api/email_alert_api.rb', line 166 def change_subscription(id:, frequency:) patch_json( "#{endpoint}/subscriptions/#{uri_encode(id)}", frequency: frequency, ) end |
#create_content_change(content_change, headers = {}) ⇒ Object
Post a content change
33 34 35 |
# File 'lib/gds_api/email_alert_api.rb', line 33 def create_content_change(content_change, headers = {}) post_json("#{endpoint}/content-changes", content_change, headers) end |
#find_or_create_subscriber_list(attributes) ⇒ Object
Get or Post subscriber list
12 13 14 15 16 17 18 19 20 |
# File 'lib/gds_api/email_alert_api.rb', line 12 def find_or_create_subscriber_list(attributes) present_fields = [attributes["content_id"], attributes["links"], attributes["tags"]].compact.count if (present_fields > 1) && (attributes["tags"]) = "Invalid attributes provided. Valid attributes are content_id only, tags only, links only, content_id AND links, or none." raise ArgumentError, end post_json("#{endpoint}/subscriber-lists", attributes) end |
#find_subscriber_by_govuk_account(govuk_account_id:) ⇒ Hash
Find a subscriber which has been “linked” to a GOV.UK Account.
205 206 207 208 209 |
# File 'lib/gds_api/email_alert_api.rb', line 205 def find_subscriber_by_govuk_account(govuk_account_id:) get_json( "#{endpoint}/subscribers/govuk-account/#{govuk_account_id}", ) end |
#find_subscriber_list(attributes) ⇒ Object
Get a subscriber list
25 26 27 28 |
# File 'lib/gds_api/email_alert_api.rb', line 25 def find_subscriber_list(attributes) query_string = nested_query_string(attributes) get_json("#{endpoint}/subscriber-lists?" + query_string) end |
#get_latest_matching_subscription(id) ⇒ Hash
Get the latest Subscription that has the same subscriber_list and email as the Subscription associated with the ‘id` passed. This may or may not be the same Subscription.
}
129 130 131 |
# File 'lib/gds_api/email_alert_api.rb', line 129 def get_latest_matching_subscription(id) get_json("#{endpoint}/subscriptions/#{uri_encode(id)}/latest") end |
#get_subscriber_list(slug:) ⇒ Hash
Get a Subscriber List
}
93 94 95 |
# File 'lib/gds_api/email_alert_api.rb', line 93 def get_subscriber_list(slug:) get_json("#{endpoint}/subscriber-lists/#{uri_encode(slug)}") end |
#get_subscription(id) ⇒ Hash
Get a Subscription
}
110 111 112 |
# File 'lib/gds_api/email_alert_api.rb', line 110 def get_subscription(id) get_json("#{endpoint}/subscriptions/#{uri_encode(id)}") end |
#get_subscriptions(id:, order: nil) ⇒ Hash
Get Subscriptions for a Subscriber
139 140 141 142 143 144 145 |
# File 'lib/gds_api/email_alert_api.rb', line 139 def get_subscriptions(id:, order: nil) if order get_json("#{endpoint}/subscribers/#{uri_encode(id)}/subscriptions?order=#{uri_encode(order)}") else get_json("#{endpoint}/subscribers/#{uri_encode(id)}/subscriptions") end end |
#link_subscriber_to_govuk_account(govuk_account_session:) ⇒ Hash
Mark a subscriber as “linked” to its corresponding GOV.UK Account. In practice “linking” will mean that email-alert-frontend and account-api will treat the subscriber specially (eg, only allowing address changes via the account).
193 194 195 196 197 198 |
# File 'lib/gds_api/email_alert_api.rb', line 193 def link_subscriber_to_govuk_account(govuk_account_session:) post_json( "#{endpoint}/subscribers/govuk-account/link", govuk_account_session: govuk_account_session, ) end |
#send_subscriber_verification_email(address:, destination:) ⇒ Hash
Verify a subscriber has control of a provided email
218 219 220 221 222 223 224 |
# File 'lib/gds_api/email_alert_api.rb', line 218 def send_subscriber_verification_email(address:, destination:) post_json( "#{endpoint}/subscribers/auth-token", address: address, destination: destination, ) end |
#send_subscription_verification_email(address:, frequency:, topic_id:) ⇒ Object
Verify a subscriber intends to be added to a subscription
return [Hash] subscription
234 235 236 237 238 239 240 241 |
# File 'lib/gds_api/email_alert_api.rb', line 234 def send_subscription_verification_email(address:, frequency:, topic_id:) post_json( "#{endpoint}/subscriptions/auth-token", address: address, frequency: frequency, topic_id: topic_id, ) end |
#subscribe(subscriber_list_id:, address:, frequency: "immediately", skip_confirmation_email: false) ⇒ Hash
Subscribe
69 70 71 72 73 74 75 76 77 |
# File 'lib/gds_api/email_alert_api.rb', line 69 def subscribe(subscriber_list_id:, address:, frequency: "immediately", skip_confirmation_email: false) post_json( "#{endpoint}/subscriptions", subscriber_list_id: subscriber_list_id, address: address, frequency: frequency, skip_confirmation_email: skip_confirmation_email, ) end |
#topic_matches(attributes) ⇒ Hash
Get topic matches
email_document_supertype, government_document_supertype
43 44 45 46 |
# File 'lib/gds_api/email_alert_api.rb', line 43 def topic_matches(attributes) query_string = nested_query_string(attributes) get_json("#{endpoint}/topic-matches.json?#{query_string}") end |
#unsubscribe(uuid) ⇒ nil
Unsubscribe subscriber from subscription
53 54 55 |
# File 'lib/gds_api/email_alert_api.rb', line 53 def unsubscribe(uuid) post_json("#{endpoint}/unsubscribe/#{uri_encode(uuid)}") end |
#unsubscribe_subscriber(id) ⇒ nil
Unsubscribe subscriber from everything
62 63 64 |
# File 'lib/gds_api/email_alert_api.rb', line 62 def unsubscribe_subscriber(id) delete_json("#{endpoint}/subscribers/#{uri_encode(id)}") end |
#update_subscriber_list_details(slug:, params: {}) ⇒ Object
Update subscriber list details, such as title
267 268 269 270 271 272 |
# File 'lib/gds_api/email_alert_api.rb', line 267 def update_subscriber_list_details(slug:, params: {}) patch_json( "#{endpoint}/subscriber-lists/#{slug}", params, ) end |