Class: SimpleSpark::Endpoints::SuppressionList

Inherits:
Object
  • Object
show all
Defined in:
lib/simple_spark/endpoints/suppression_list.rb

Overview

Note:

Example suppression list recipient { “recipient”: “[email protected]”, “transactional”: true, “description”: “User requested to not receive any transactional emails.” }

Note:

See: developers.sparkpost.com/api/suppression-list

Provides access to the /suppression-list endpoint

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ SuppressionList

Returns a new instance of SuppressionList.



11
12
13
 
# File 'lib/simple_spark/endpoints/suppression_list.rb', line 11

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ Object

Returns the value of attribute client.



9
10
11
 
# File 'lib/simple_spark/endpoints/suppression_list.rb', line 9

def client
  @client
end

Instance Method Details

#create_or_update(recipients) ⇒ Object

Note:

See: developers.sparkpost.com/api/suppression-list#suppression-list-bulk-insert-update-put

Insert or Update List Entries

Parameters:

  • recipients (Array) —

    the entries to insert or update



26
27
28
 
# 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(recipient_email) ⇒ Object

Note:

See: developers.sparkpost.com/api/suppression-list#suppression-list-retrieve,-delete-delete

Delete a List Entry

Parameters:

  • recipient_email (String) —

    the recipient email to delete



42
43
44
45
 
# 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(recipient_email) ⇒ Hash

Note:

See: developers.sparkpost.com/api/suppression-list#suppression-list-retrieve,-delete-get

Retrieve a Recipient Suppression Status

Parameters:

  • recipient_email (String) —

    the recipient email to retrieve

Returns:

  • (Hash) —

    a suppression status result hash object



34
35
36
37
 
# 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(params = {}) ⇒ Array

Note:

See: developers.sparkpost.com/api/suppression-list#suppression-list-search-get

Search for list entries

Parameters:

  • params (String) (defaults to: {}) —

    Params to use in the search

Returns:

  • (Array) —

    a list of sample Suppression Status hash objects



19
20
21
 
# File 'lib/simple_spark/endpoints/suppression_list.rb', line 19

def search(params = {})
  @client.call(method: :get, path: 'suppression-list', query_params: params)
end