class SimpleSpark::Endpoints::SuppressionList
Provides access to the /suppression-list endpoint @note Example suppression list recipient
{ "recipient": "rcpt_1@example.com", "transactional": true, "description": "User requested to not receive any transactional emails." }
Attributes
Public Class Methods
# File lib/simple_spark/endpoints/suppression_list.rb, line 11 def initialize(client) @client = client end
Public Instance Methods
Insert or Update List Entries @param recipients [Array] the entries to insert or update @note See: developers.sparkpost.com/api/suppression-list#suppression-list-bulk-insert-update-put
# File lib/simple_spark/endpoints/suppression_list.rb, line 26 def create_or_update(recipients) @client.call(method: :put, path: 'suppression-list', body_values: {recipients: recipients}) end
Delete a List Entry @param recipient_email [String] the recipient email to delete @note See: developers.sparkpost.com/api/suppression-list#suppression-list-retrieve,-delete-delete
# File lib/simple_spark/endpoints/suppression_list.rb, line 42 def delete(recipient_email) recipient_email = @client.url_encode(recipient_email) @client.call(method: :delete, path: "suppression-list/#{recipient_email}") end
Retrieve a Recipient Suppression Status @param recipient_email [String] the recipient email to retrieve @return [Hash] a suppression status result hash object @note See: developers.sparkpost.com/api/suppression-list#suppression-list-retrieve,-delete-get
# File lib/simple_spark/endpoints/suppression_list.rb, line 34 def retrieve(recipient_email) recipient_email = @client.url_encode(recipient_email) @client.call(method: :get, path: "suppression-list/#{recipient_email}") end
Search for list entries @param params [String] Params to use in the search @return [Array] a list of sample Suppression Status hash objects @note See: developers.sparkpost.com/api/suppression-list#suppression-list-search-get
# File lib/simple_spark/endpoints/suppression_list.rb, line 19 def search(params = {}) @client.call(method: :get, path: 'suppression-list', query_values: params) end