simple_spark 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbdf85242494fe095cb7ce40c9e6c2ef485c079c2ff6dd306e0446c3f5b4f7a5
-  data.tar.gz: 43e97d881ece27eded5f6166ed8b9cdf5c716c0d23dfff99291e39149eed41d2
+  metadata.gz: ff21cc319280b3aa91e376df4209c374f097f8ce3a60bf4535b88de8dc58ba66
+  data.tar.gz: a73d02452feeebf2be58c31a4a4b459203dd008cb1c60febfe9549235e1dc78e
 SHA512:
-  metadata.gz: bce5c2d519fe46bb10aca0eabb8043a4888ab946d74c4334a987efadca0de08b1a12fa9744c435213dbed40057c4c2993d352fc8c7b9f3837afbfb458a2bc8d5
-  data.tar.gz: 801c0d5bfb2958a555ae45bd4de93f0941a548ae025ebe6d7b01a2214632694b6c4c1cf395c24361746b17e34a53431dd323700367e1decde23973302d43501f
+  metadata.gz: a08557569f6794eabe52b57ce37063192aedc2ea84604dcdcf5e7032ed0ea50b2030092cd173675d647e146eac5ea9b3406e98ab3202405888dba0dc2f11c6cf
+  data.tar.gz: d8a533270b9fcc2c01768a60a27260ecf11bb5a079607df40d4cd96ebf1f663851cc5265da6ef929552f118e1b09ac8574c8810821bafbd32c063f95257e1cea

data/README.md

@@ -833,9 +833,78 @@ simple_spark.templates.delete(yourtemplateid)
 
 <a href="https://developers.sparkpost.com/api/#/reference/templates/delete" target="_blank">see SparkPost API Documentation</a>
 
+### Recipient Lists
+
+#### List
+
+List all recipient lists
+
+```ruby
+simple_spark.recipient_lists.list
+```
+
+<a href="https://developers.sparkpost.com/api/recipient-lists/#recipient-lists-get-list-all-recipient-lists" target="_blank">see SparkPost API Documentation</a>
+
+#### Create
+
+Create a new Recipient list
+
+```ruby
+properties = { "name" => "Small List",
+               "recipients"=> [
+                 {
+                   "address" => {
+                     "email" => "somemail@somedomain.com"
+                   }
+                 }
+               ]
+             }
+num_rcpt_errors = 1
+simple_spark.recipient_lists.create(properties, num_rcpt_errors)
+```
+
+<a href="https://developers.sparkpost.com/api/recipient-lists/#recipient-lists-post-create-a-recipient-list" target="_blank">see SparkPost API Documentation</a>
+
+#### Retrieve
+
+Retrieves a Recipient list by its ID
+
+```ruby
+show_recipients = true
+simple_spark.recipient_lists.retrieve(your_list_id, show_recipients)
+```
+
+<a href="https://developers.sparkpost.com/api/recipient-lists/#recipient-lists-get-retrieve-a-recipient-list" target="_blank">see SparkPost API Documentation</a>
+
+#### Update
+
+Updates a Recipient list with new values
+
+```ruby
+properties = { "name" => "New List Name" }
+simple_spark.recipient_lists.update(your_list_id, properties)
+```
+
+<a href="https://developers.sparkpost.com/api/recipient-lists/#recipient-lists-put-update-a-recipient-list" target="_blank">see SparkPost API Documentation</a>
+
+#### Delete
+
+Deletes a Recipient list permanently
+
+```ruby
+simple_spark.recipient_lists.delete(your_list_id)
+```
+
+<a href="https://developers.sparkpost.com/api/recipient-lists/#recipient-lists-delete-delete-a-recipient-list" target="_blank">see SparkPost API Documentation</a>
+
+
 ## Changelog
 
 
+### 1.0.9
+
+- Add Recipients List Endpoint
+
 ### 1.0.8
 
 - Add Events Endpoint

data/lib/simple_spark.rb

@@ -10,6 +10,7 @@ require 'simple_spark/endpoints/sending_domains'
 require 'simple_spark/endpoints/message_events'
 require 'simple_spark/endpoints/events'
 require 'simple_spark/endpoints/webhooks'
+require 'simple_spark/endpoints/recipient_lists'
 require 'simple_spark/endpoints/relay_webhooks'
 require 'simple_spark/endpoints/subaccounts'
 require 'simple_spark/endpoints/suppression_list'

data/lib/simple_spark/client.rb

@@ -151,5 +151,9 @@ module SimpleSpark
     def suppression_list
       Endpoints::SuppressionList.new(self)
     end
+
+    def recipient_lists
+      Endpoints::RecipientLists.new(self)
+    end
   end
 end

data/lib/simple_spark/endpoints/recipient_lists.rb

@@ -0,0 +1,56 @@
+module SimpleSpark
+  module Endpoints
+    # Provides access to the /recipient-lists endpoint
+    # @note See: https://developers.sparkpost.com/api/recipient-lists
+    class RecipientLists
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      # List all recipient lists
+      # @return [Array] an array of abbreviated recipient list objects
+      # @note See: https://developers.sparkpost.com/api/recipient-lists/#recipient-lists-get-list-all-recipient-lists
+      def list
+        @client.call(method: :get, path: 'recipient-lists')
+      end
+
+      # Create a recipient list
+      # @param values [Hash] the values to create the recipient list with, valid keys: [:id, :name, :description, :attributes, :recipients]
+      # @param num_rcpt_errors [Integer] max number of recipient errors that this call can return
+      # @return [Hash] details about created list
+      # @note See: https://developers.sparkpost.com/api/recipient-lists#recipient-lists-post-create-a-recipient-list
+      def create(values, num_rcpt_errors = nil)
+        query_params = num_rcpt_errors.nil? ? '' : "?num_rcpt_errors=#{num_rcpt_errors.to_i}"
+        @client.call(method: :post, path: "recipient-lists#{query_params}", body_values: values)
+      end
+
+      # Retrieve recipient list details
+      # @param id [Integer] the recipient list ID to retrieve
+      # @param show_recipients [Boolean] if true, return all the recipients contained in the list
+      # @return [Hash] details about a specified recipient list
+      # @note See: https://developers.sparkpost.com/api/recipient-lists/#recipient-lists-get-retrieve-a-recipient-list
+      def retrieve(id, show_recipients = false)
+        params = { show_recipients: show_recipients }.compact
+        @client.call(method: :get, path: "recipient-lists/#{id}", query_values: params)
+      end
+
+      # Update a recipient list
+      # @param id [Integer] the recipient list ID to update
+      # @param values [Hash] hash of values to update, valid keys: [:name, :description, :attributes, :recipients]
+      # @return [Hash] details on update operation
+      # @note See: https://developers.sparkpost.com/api/recipient-lists/#recipient-lists-put-update-a-recipient-list
+      def update(id, values)
+        @client.call(method: :put, path: "recipient-lists/#{id}", body_values: values)
+      end
+
+      # Delete a recipient list
+      # @param id [String] the ID
+      # @note See: https://developers.sparkpost.com/api/recipient-lists#recipient-lists-delete-delete-a-recipient-list
+      def delete(id)
+        @client.call(method: :delete, path: "recipient-lists/#{id}")
+      end
+    end
+  end
+end

data/lib/simple_spark/version.rb

@@ -1,3 +1,3 @@
 module SimpleSpark
-  VERSION = '1.0.8'
+  VERSION = '1.0.9'
 end

data/spec/simple_spark/client_spec.rb

@@ -100,6 +100,10 @@ describe SimpleSpark::Client do
         specify { expect(client.webhooks.class).to eq(SimpleSpark::Endpoints::Webhooks) }
       end
 
+      context 'recipient_lists' do
+        specify { expect(client.recipient_lists.class).to eq(SimpleSpark::Endpoints::RecipientLists) }
+      end
+
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_spark
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - Jak Charlton
@@ -72,6 +72,7 @@ files:
 - lib/simple_spark/endpoints/inbound_domains.rb
 - lib/simple_spark/endpoints/message_events.rb
 - lib/simple_spark/endpoints/metrics.rb
+- lib/simple_spark/endpoints/recipient_lists.rb
 - lib/simple_spark/endpoints/relay_webhooks.rb
 - lib/simple_spark/endpoints/sending_domains.rb
 - lib/simple_spark/endpoints/subaccounts.rb