simple_spark 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 676d80d0849c4c6c5afda568f14191eade9233f1
-  data.tar.gz: 4997b6feca164a87ecc49d31919c14c96f91c8d0
+  metadata.gz: 8dc5b026632213e5e88bc3e7c4260ce79ba4184a
+  data.tar.gz: 0beacfa2100f3a4a9419104e271983383780a4ea
 SHA512:
-  metadata.gz: 6ce14c7ad7ef085b1b5b4e3d4f7dba76d80ac5a081175f967a4dbc0efb8fc01e18d4ca366243d9485961ab3a74f46d6a70d2314d7a33c7807893dc575166aa8f
-  data.tar.gz: 982fc09009aceb4fcdafb2938afc5e784d5bb0a38c78806fbebe76619372202cbe8a6a098782f2440f11f289b6718959567297a6b73b633cb4cd91eebc5dcd75
+  metadata.gz: 2cb764d5b04dba18a6641994dd9235c7f71984b2b8d1ae664b0ab4b378d0dd41022c90ddf267932f6a40da6cce91c4253f4c0bef60de0a601002049d99a3421e
+  data.tar.gz: faeef41ea69b60c34a7e7c9febc6e4c820ff10348f757e7a77b37a1894a96b00677e9c72b981e41f2560f4052dd6aca7b931bac24008b360ed4a163829578870

data/README.md

@@ -272,7 +272,7 @@ simple_spark.sending_domains.create('mail.mydomain.com')
 
 #### Retrieve
 
-Retrieves a Sending Template by its domain name
+Retrieves a Sending Domain by its domain name
 
 ```ruby
 simple_spark.sending_domains.retrieve('mail.mydomain.com')
@@ -342,7 +342,7 @@ simple_spark.inbound_domains.create('mail.mydomain.com')
 
 #### Retrieve
 
-Retrieves an Inbound Template by its domain name
+Retrieves an Inbound Domain by its domain name
 
 ```ruby
 simple_spark.inbound_domains.retrieve('mail.mydomain.com')
@@ -360,6 +360,68 @@ 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>
 
+### Relay Webhooks
+
+#### List
+
+List all Relay Webhooks
+
+```ruby
+simple_spark.relay_webhooks.list
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/relay-webhooks/create-and-list/list-all-relay-webhooks" target="_blank">see SparkPost API Documentation</a>
+
+#### Create
+
+Create a new Relay Webhook
+
+```ruby
+properties = {
+  name: "Replies Webhook",
+  target: "https://webhooks.customer.example/replies",
+  auth_token: "",
+  match: {
+    protocol: "SMTP",
+    domain: "email.example.com"
+  }
+}
+simple_spark.relay_webhooks.create(properties)
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/relay-webhooks/create-and-list/create-a-relay-webhook" target="_blank">see SparkPost API Documentation</a>
+
+#### Retrieve
+
+Retrieves a Relay Webhook by its id
+
+```ruby
+simple_spark.relay_webhooks.retrieve(id)
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/relay-webhooks/retrieve-update-and-delete/retrieve-a-relay-webhook" target="_blank">see SparkPost API Documentation</a>
+
+#### Update
+
+Updates a Relay Webhook with new values
+
+```ruby
+properties = { name: "Replies Webhook" }
+simple_spark.relay_webhooks.update(id, properties)
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/relay-webhooks/create-and-list/update-a-relay-webhook" target="_blank">see SparkPost API Documentation</a>
+
+#### Delete
+
+Deletes a Relay Webhook permanently
+
+```ruby
+simple_spark.relay_webhooks.delete(id)
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/relay-webhooks/retrieve-update-and-delete/delete-a-relay-webhook" target="_blank">see SparkPost API Documentation</a>
+
 ### Templates
 
 #### List
@@ -404,7 +466,7 @@ simple_spark.templates.retrieve(yourtemplateid, draft)
 Updates a Template with new values
 
 ```ruby
-properties = { "name" => "Sorry, the Winter Sale!" }}
+properties = { "name" => "Sorry, the Winter Sale!" }
 update_published = false
 simple_spark.templates.update(yourtemplateid, properties, update_published)
 ```

data/lib/simple_spark/client.rb

@@ -78,5 +78,9 @@ module SimpleSpark
     def webhooks
       Endpoints::Webhooks.new(self)
     end
+
+    def relay_webhooks
+      Endpoints::RelayWebhooks.new(self)
+    end
   end
 end

data/lib/simple_spark/endpoints/relay_webhooks.rb

@@ -0,0 +1,66 @@
+module SimpleSpark
+  module Endpoints
+    # Provides access to the /relay-webhooks endpoint
+    # See: https://developers.sparkpost.com/api/#/reference/relay-webhooks
+    class RelayWebhooks
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      # Lists your relay webhooks
+      # @return [Array] a list of Relay Webhook hash objects
+      # @note See: https://developers.sparkpost.com/api/#/reference/relay-webhooks/create-and-list/list-all-relay-webhooks
+      def list
+        @client.call(:get, 'relay-webhooks')
+      end
+
+      # Create a relay webhook
+      # @param values [Hash] the values to create with
+      # @note See: https://developers.sparkpost.com/api/#/reference/relay-webhooks/create-and-list/create-a-relay-webhook
+      # @note Example:
+      # properties = {
+      #   name: "Replies Webhook",
+      #   target: "https://webhooks.customer.example/replies",
+      #   auth_token: "",
+      #   match: {
+      #     protocol: "SMTP",
+      #     domain: "email.example.com"
+      #   }
+      # }
+      def create(values)
+        @client.call(:post, 'relay-webhooks', values)
+      end
+
+      # Retrieve a relay webhook
+      # @param webhook_id [String] the id to retrieve
+      # @return [Hash] an Relay Webhook hash object
+      # @note See: https://developers.sparkpost.com/api/#/reference/relay-webhooks/retrieve-update-and-delete/retrieve-a-relay-webhook
+      def retrieve(webhook_id)
+        @client.call(:get, "relay-webhooks/#{webhook_id}")
+      end
+
+      # Update a relay webhook
+      # @param webhook_id [String] the id to retrieve
+      # @param values [Hash] the values to update the relay webhook with
+      # @return [Hash] an Relay Webhook hash object
+      # @note Example:
+      # properties = {
+      #   name: "New Replies Webhook",
+      #   target: "https://webhook.customer.example/replies"
+      # }
+      # @note See: https://developers.sparkpost.com/api/#/reference/relay-webhooks/create-and-list/update-a-relay-webhook
+      def update(webhook_id, values)
+        @client.call(:put, "relay-webhooks/#{webhook_id}", values)
+      end
+
+      # Delete a relay webhook
+      # @param webhook_id [String] the id to retrieve
+      # @note See: https://developers.sparkpost.com/api/#/reference/relay-webhooks/retrieve-update-and-delete/delete-a-relay-webhook
+      def delete(webhook_id)
+        @client.call(:delete, "relay-webhooks/#{webhook_id}")
+      end
+    end
+  end
+end

data/lib/simple_spark/endpoints/sending_domains.rb

@@ -24,8 +24,8 @@ module SimpleSpark
       # @param domain_name [String] the domain name to create
       # @param tracking_domain [String] the domain name to track this domain against
       # @note See: https://developers.sparkpost.com/api/#/reference/sending-domains/create-and-list
-      def create(domain_name, tracking_domain)
-        @client.call(:post, 'sending-domains', domain: domain_name, tracking_domain: tracking_domain)
+      def create(values)
+        @client.call(:post, 'sending-domains', values)
       end
 
       # Retrieve a sending domain
@@ -59,7 +59,7 @@ module SimpleSpark
       # @note See: https://developers.sparkpost.com/api/#/reference/sending-domains/verify
       def verify(domain_name, values)
         domain_name = @client.url_encode(domain_name)
-        @client.call(:post, "sending-domains/#{domain_name}", values)
+        @client.call(:post, "sending-domains/#{domain_name}/verify", values)
       end
 
       # Delete a sending domain

data/lib/simple_spark/version.rb

@@ -1,3 +1,3 @@
 module SimpleSpark
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/simple_spark.rb

@@ -7,4 +7,5 @@ require 'simple_spark/endpoints/inbound_domains'
 require 'simple_spark/endpoints/sending_domains'
 require 'simple_spark/endpoints/message_events'
 require 'simple_spark/endpoints/webhooks'
+require 'simple_spark/endpoints/relay_webhooks'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_spark
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jak Charlton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-15 00:00:00.000000000 Z
+date: 2016-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -209,6 +209,7 @@ files:
 - lib/simple_spark/client.rb
 - lib/simple_spark/endpoints/inbound_domains.rb
 - lib/simple_spark/endpoints/message_events.rb
+- lib/simple_spark/endpoints/relay_webhooks.rb
 - lib/simple_spark/endpoints/sending_domains.rb
 - lib/simple_spark/endpoints/templates.rb
 - lib/simple_spark/endpoints/transmissions.rb
@@ -245,4 +246,3 @@ summary: A library for accessing the SparkPost REST API http://www.sparkpost.com
 test_files:
 - spec/simple_spark/client_spec.rb
 - spec/spec_helper.rb
-has_rdoc: