simple_spark 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 987fbf9d3e51b544aa33eae28f83e65708b36a33
-  data.tar.gz: 38f6a9f0ca695c79904a72cb5d2cdd8dc007d8c7
+  metadata.gz: c2d4168cfad467ad86cb254fe01f6a17dcd3df92
+  data.tar.gz: bf14dc1293c65bdf3c7a7c4858dbf9ac4fe62acf
 SHA512:
-  metadata.gz: ef0589adda9275e41f1781ba27c1c6ec774ea8a6e0ad27ee469b9134bfece252e6f79117b744f69468b9df89a9e7ea7e3a301bbdc32e9d270f2f3eb9878fc7f9
-  data.tar.gz: afab1c06b5387fde2cb2646e6a588b2f28629f897374a641b9870035b876d44034496e2b52946ed1abaf97028f48953e904c411d05f7990b149dd3669fd4673a
+  metadata.gz: e3e3dba8c7f136987fbf9c697f608d7a8d1a748a14b663f164390179c2aab4cad6af0c8facf2ce74505d5a0d72e574eb793d3100a1bffca50de711337947cb9c
+  data.tar.gz: 06c246a18cdc54b6a3390b5e4fad8f54a78ff6ba7f51785c2443351bb5bb9a8feb98918045890373edabfe2567a05a1b57ab8ede7ceddd72d5367cdcddd72422

data/README.md

@@ -578,6 +578,59 @@ simple_spark.inbound_domains.delete('mail.mydomain.com')
 
 <a href="https://developers.sparkpost.com/api/#/reference/inbound-domains/retrieve-and-delete" target="_blank">see SparkPost API Documentation</a>
 
+### Supression List
+
+#### Search
+
+Find supression list entries
+
+```ruby
+params = {
+  from: '2013-04-20T07:12',
+  to: '2018-04-20T07:12'
+}
+simple_spark.suppression_list.create_or_update(params)
+```
+
+<a href="https://developers.sparkpost.com/api/suppression-list#suppression-list-search-get" target="_blank">see SparkPost API Documentation</a>
+
+#### Create or Update
+
+Bulk update supression list entries
+
+```ruby
+recipients = {
+  {
+    recipient: "rcpt_1@example.com",
+    transactional: true,
+    description: "User requested to not receive any transactional emails."
+  },
+  {
+    recipient: "rcpt_2@example.com",
+    non_transactional: true
+  }
+}
+simple_spark.suppression_list.create_or_update(recipients)
+```
+
+<a href="https://developers.sparkpost.com/api/suppression-list#suppression-list-bulk-insert-update-put" target="_blank">see SparkPost API Documentation</a>
+
+#### Retrieve
+
+```ruby
+simple_spark.suppression_list.retrieve("rcpt_1@example.com")
+```
+
+<a href="https://developers.sparkpost.com/api/suppression-list#suppression-list-retrieve,-delete-get" target="_blank">see SparkPost API Documentation</a>
+
+#### Delete
+
+```ruby
+simple_spark.suppression_list.delete("rcpt_1@example.com")
+```
+
+<a href="https://developers.sparkpost.com/api/suppression-list#suppression-list-retrieve,-delete-get" target="_blank">see SparkPost API Documentation</a>
+
 ### Relay Webhooks
 
 #### List
@@ -715,10 +768,14 @@ simple_spark.templates.delete(yourtemplateid)
 
 ## Changelog
 
+### 1.0.4
+
+- Add Supression List Endpoint
+
 ### 1.0.3
 
-Using JSON.generate instead of .to_json (https://github.com/leadmachineapp/simple_spark/pull/11)
-Fixing inbound domains bug (https://github.com/leadmachineapp/simple_spark/pull/9)
+- Using JSON.generate instead of .to_json (https://github.com/leadmachineapp/simple_spark/pull/11)
+- Fixing inbound domains bug (https://github.com/leadmachineapp/simple_spark/pull/9)
 
 ### 1.0.2
 

data/lib/simple_spark/client.rb

@@ -139,5 +139,9 @@ module SimpleSpark
     def relay_webhooks
       Endpoints::RelayWebhooks.new(self)
     end
+
+    def suppression_list
+      Endpoints::SuppressionList.new(self)
+    end
   end
 end

data/lib/simple_spark/endpoints/suppression_list.rb

@@ -0,0 +1,48 @@
+module SimpleSpark
+  module Endpoints
+    # 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." }
+    # @note See: https://developers.sparkpost.com/api/suppression-list
+    class SuppressionList
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      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: https://developers.sparkpost.com/api/suppression-list#suppression-list-search-get
+      def search(params = {})
+        @client.call(method: :get, path: 'suppression-list', query_params: params)
+      end
+
+      # Insert or Update List Entries
+      # @param recipients [Array] the entries to insert or update
+      # @note See: https://developers.sparkpost.com/api/suppression-list#suppression-list-bulk-insert-update-put
+      def create_or_update(recipients)
+        @client.call(method: :put, path: 'suppression-list', body_values: {recipients: recipients})
+      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: https://developers.sparkpost.com/api/suppression-list#suppression-list-retrieve,-delete-get
+      def retrieve(recipient_email)
+        recipient_email = @client.url_encode(recipient_email)
+        @client.call(method: :get, path: "suppression-list/#{recipient_email}")
+      end
+
+      # Delete a List Entry
+      # @param recipient_email [String] the recipient email to delete
+      # @note See: https://developers.sparkpost.com/api/suppression-list#suppression-list-retrieve,-delete-delete
+      def delete(recipient_email)
+        recipient_email = @client.url_encode(recipient_email)
+        @client.call(method: :delete, path: "suppression-list/#{recipient_email}")
+      end
+    end
+  end
+end

data/lib/simple_spark/version.rb

@@ -1,3 +1,3 @@
 module SimpleSpark
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 end

data/lib/simple_spark.rb

@@ -10,4 +10,5 @@ require 'simple_spark/endpoints/message_events'
 require 'simple_spark/endpoints/webhooks'
 require 'simple_spark/endpoints/relay_webhooks'
 require 'simple_spark/endpoints/subaccounts'
+require 'simple_spark/endpoints/suppression_list'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_spark
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Jak Charlton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-20 00:00:00.000000000 Z
+date: 2016-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -73,6 +73,7 @@ files:
 - lib/simple_spark/endpoints/relay_webhooks.rb
 - lib/simple_spark/endpoints/sending_domains.rb
 - lib/simple_spark/endpoints/subaccounts.rb
+- lib/simple_spark/endpoints/suppression_list.rb
 - lib/simple_spark/endpoints/templates.rb
 - lib/simple_spark/endpoints/transmissions.rb
 - lib/simple_spark/endpoints/webhooks.rb