mailerlite 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c12879562f401358996022b1ca5cdebbbadda822
-  data.tar.gz: 871117ea177f7b68c68cdf6bfcca64daacdd3c9d
+  metadata.gz: 9de4d75cd5a4ead0366d3877ea110f1a551e01f0
+  data.tar.gz: 8b439fd20c4839f14f000305279c5839142de63b
 SHA512:
-  metadata.gz: a7087390b80ed3f0ca82b0d2e4cd91c0b1fd73974ee548ba03964fbcf56b99edec4ad7e38182c3d49a71e6d5ed6cb23049c6d3baaca0f65c8b9d613ba89dc1ea
-  data.tar.gz: 52ae9d8a5750e887d7ce477380a0e63afbdb58c32a5d73ea4442e4a0bdc0a4244e72096ca7bfd4b7fff552d2cfdb6812a6f0f4a174e99e04c411ed8c391efd86
+  metadata.gz: d14e38d75a5382bcd8864d99c11e1e6261f81b42a47ab1eb8cd256c1f58ffaa39b0140a3798e7ca11df97a72d7d58aee5385f9dec36c3338bcf77c1847aa9a94
+  data.tar.gz: 8940d6c252b925e788e55b06c545fa40de345756b42308f63cb62c49c5c437366997011db48c3c5b8414b415f48865c8e299553c733d71c0482493df51eaf100

data/examples/README.md

@@ -7,6 +7,7 @@
 * [Fields](fields.md)
 * [Groups](groups.md)
 * [Subscribers](subscribers.md)
+* [Webhooks](webhooks.md)
 
 ## How To
 

data/examples/fields.md

@@ -16,10 +16,11 @@ client.create_field(options)
 ## Update custom field in account
 
 ```ruby
-client.update_field(id, { title: 'New title' })
+client.update_field(id, title: 'New title')
 ```
 
-##Remove custom field from account
+## Remove custom field from account
+
 ```ruby
 client.delete_field(id)
 ```

data/examples/webhooks.md

@@ -0,0 +1,31 @@
+# Webhooks
+
+## Get all webhooks
+
+```ruby
+client.webhooks
+```
+
+## Get single webhook
+
+```ruby
+client.webhook(1)
+```
+
+## Create webhook
+
+```ruby
+client.create_webhook('example.com', 'event')
+```
+
+## Update webhook
+
+```ruby
+client.update_webhook(1, event: 'event')
+```
+
+## Remove webhook
+
+```ruby
+client.delete_webhook(1)
+```

data/lib/mailerlite/client.rb

@@ -5,6 +5,7 @@ require 'mailerlite/clients/campaigns'
 require 'mailerlite/clients/fields'
 require 'mailerlite/clients/groups'
 require 'mailerlite/clients/subscribers'
+require 'mailerlite/clients/webhooks'
 
 module MailerLite
   # Wrapper class for all actions.
@@ -13,6 +14,7 @@ module MailerLite
     include MailerLite::Clients::Fields
     include MailerLite::Clients::Groups
     include MailerLite::Clients::Subscribers
+    include MailerLite::Clients::Webhooks
 
     # Initialize client.
     #

data/lib/mailerlite/clients/campaigns.rb

@@ -4,7 +4,7 @@ module MailerLite
     module Campaigns
       # Create campaign where you will use your custom HTML template
       #
-      # @see https://developers.mailerlite.com/docs/campaigns
+      # @see https://developers.mailerlite.com/v2/reference#campaigns
       #
       # @param options [Hash] A customizable set of options.
       # @option options [String] :type Type of campaign. Available values:
@@ -24,7 +24,7 @@ module MailerLite
 
       # Upload your HTML template to created campaign
       #
-      # @see https://developers.mailerlite.com/docs/put-custom-content-to-campaign
+      # @see https://developers.mailerlite.com/v2/reference#put-custom-content-to-campaign
       #
       # @param id [Integer] ID of campaign
       # @param options [Hash] A customizable set of options.
@@ -40,7 +40,7 @@ module MailerLite
 
       # Send, schedule or cancel campaign
       #
-      # @see https://developers.mailerlite.com/docs/campaign-actions-and-triggers
+      # @see https://developers.mailerlite.com/v2/reference#campaign-actions-and-triggers
       #
       # @param id [Integer] ID of campaign
       # @param action [String] Action type. Possible values: send, cancel
@@ -53,7 +53,7 @@ module MailerLite
       # Returns all campaigns you have in your account by :status which is
       # required. Also basic summary for each campaign including the ID.
       #
-      # @see http://developers.mailerlite.com/reference#campaigns-by-type
+      # @see https://developers.mailerlite.com/v2/reference#campaigns-by-type
       #
       # @param status [String] possible values: 'sent', 'outbox', 'draft'
       # no value means 'sent'
@@ -65,6 +65,8 @@ module MailerLite
 
       # Remove a campaign.
       #
+      # @see https://developers.mailerlite.com/v2/reference#delete-campaign
+      #
       # @param id [Integer] id of campaign
       #
       # @return [Boolean] Response from API.

data/lib/mailerlite/clients/fields.rb

@@ -4,7 +4,7 @@ module MailerLite
     module Fields
       # Get subscriber fields of account
       #
-      # @see https://developers.mailerlite.com/docs/all-fields
+      # @see https://developers.mailerlite.com/v2/reference#all-fields
       #
       # @return [Array] Response from API.
       def fields
@@ -13,7 +13,7 @@ module MailerLite
 
       # Create new custom field in account
       #
-      # @see https://developers.mailerlite.com/docs/create-field
+      # @see https://developers.mailerlite.com/v2/reference#create-field
       #
       # @param options [Hash] A customizable set of options.
       # @option options [String] :title Title of field
@@ -27,7 +27,7 @@ module MailerLite
 
       # Update custom field in account
       #
-      # @see https://developers.mailerlite.com/docs/update-field
+      # @see https://developers.mailerlite.com/v2/reference#update-field
       #
       # @param id [Integer] ID of field.
       # @param options [Hash] A customizable set of options.
@@ -40,7 +40,7 @@ module MailerLite
 
       # Remove custom field from account
       #
-      # @see https://developers.mailerlite.com/docs/remove-field
+      # @see https://developers.mailerlite.com/v2/reference#remove-field
       #
       # @param id [Integer] ID of field.
       #

data/lib/mailerlite/clients/groups.rb

@@ -4,7 +4,7 @@ module MailerLite
     module Groups
       # Get list of groups
       #
-      # @see https://developers.mailerlite.com/docs/groups
+      # @see https://developers.mailerlite.com/v2/reference#groups
       #
       # @return [Array] Response from API.
       def groups
@@ -13,7 +13,7 @@ module MailerLite
 
       # Get single group by ID
       #
-      # @see http://developers.mailerlite.com/reference#single-group
+      # @see https://developers.mailerlite.com/v2/reference#single-group
       #
       # @param id [Integer] Id of group
       #
@@ -25,7 +25,7 @@ module MailerLite
 
       # Create new group
       #
-      # @see http://developers.mailerlite.com/reference#create-group
+      # @see https://developers.mailerlite.com/v2/reference#create-group
       #
       # @param name [String] Name of your group
       #
@@ -34,13 +34,21 @@ module MailerLite
         connection.post('groups', name: name)
       end
 
+      # Update group
+      #
+      # @see https://developers.mailerlite.com/v2/reference#rename-group
+      #
+      # @param [Integer] Id of group
+      # @param options [Hash] Request options
+      #
+      # @return [Hash] Response from API.
       def update_group(id, options = {})
         connection.put("groups/#{id}", options)
       end
 
       # Remove group
       #
-      # @see http://developers.mailerlite.com/reference#delete-group
+      # @see https://developers.mailerlite.com/v2/reference#delete-group
       #
       # @param [Integer] Id of group
       #
@@ -51,7 +59,7 @@ module MailerLite
 
       # Get all subscribers in a specified group
       #
-      # @see http://developers.mailerlite.com/reference#subscribers-in-a-group
+      # @see https://developers.mailerlite.com/v2/reference#subscribers-in-a-group
       #
       # @param group_id [Integer] Id of group
       # @param options [Hash] Request options
@@ -63,7 +71,7 @@ module MailerLite
 
       # Add new single subscriber to specified group
       #
-      # @see http://developers.mailerlite.com/reference#add-single-subscriber
+      # @see https://developers.mailerlite.com/v2/reference#add-single-subscriber
       #
       # @param group_id [Integer] Id of group
       # @param options [Hash] Request options
@@ -75,7 +83,7 @@ module MailerLite
 
       # Add many new subscribers to specified group at once
       #
-      # @see http://developers.mailerlite.com/reference#add-many-subscribers
+      # @see https://developers.mailerlite.com/v2/reference#add-many-subscribers
       #
       # @param group_id [Integer] Id of group
       # @param subscribers [Array] Array of hash each indicates a subscriber
@@ -89,7 +97,7 @@ module MailerLite
 
       # Remove single subscriber from specified group
       #
-      # @see http://developers.mailerlite.com/reference#remove-subscriber
+      # @see https://developers.mailerlite.com/v2/reference#remove-subscriber
       #
       # @param group_id [Integer|String] Id of group
       # @param subscriber_id_or_email [Array] Id or email of subscriber

data/lib/mailerlite/clients/subscribers.rb

@@ -4,7 +4,7 @@ module MailerLite
     module Subscribers
       # Get single subscriber
       #
-      # @see https://developers.mailerlite.com/docs/single-subscriber
+      # @see https://developers.mailerlite.com/v2/reference#single-subscriber
       #
       # @param identifier [Integer,String] ID or email of subscriber.
       #
@@ -15,7 +15,7 @@ module MailerLite
 
       # Update single subscriber
       #
-      # @see https://developers.mailerlite.com/docs/update-subscriber
+      # @see https://developers.mailerlite.com/v2/reference#update-subscriber
       #
       # @param identifier [Integer,String] ID or email of subscriber.
       # @param options [Hash] A customizable set of options.
@@ -32,7 +32,7 @@ module MailerLite
 
       # Search for subscribers
       #
-      # @see https://developers.mailerlite.com/docs/search-for-subscribers
+      # @see https://developers.mailerlite.com/v2/reference#search-for-subscribers
       #
       # @param query [String] Search query
       # @param options [Hash] A customizable set of options.
@@ -48,7 +48,7 @@ module MailerLite
 
       # Get groups subscriber belongs to
       #
-      # @see https://developers.mailerlite.com/docs/groups-subscriber-belongs-to
+      # @see https://developers.mailerlite.com/v2/reference#groups-subscriber-belongs-to
       #
       # @param identifier [Integer,String] ID or email of subscriber.
       #
@@ -59,7 +59,7 @@ module MailerLite
 
       # Get activity (clicks, opens, etc) of selected subscriber
       #
-      # @see https://developers.mailerlite.com/docs/activity-of-single-subscriber
+      # @see https://developers.mailerlite.com/v2/reference#activity-of-single-subscriber
       #
       # @param identifier [Integer,String] ID or email of subscriber.
       #

data/lib/mailerlite/clients/webhooks.rb

@@ -0,0 +1,63 @@
+module MailerLite
+  module Clients
+    # MailerLite Webhooks
+    module Webhooks
+      # Get webhooks
+      #
+      # @see https://developers.mailerlite.com/v2/reference#webhooks-1
+      #
+      # @return [Hash] Response from API.
+      def webhooks
+        connection.get('webhooks')
+      end
+
+      # Get single webhook
+      #
+      # @see https://developers.mailerlite.com/v2/reference#webhooksid
+      #
+      # @param id [Integer] ID of a webhook
+      #
+      # @return [Hash] Response from API.
+      def webhook(id)
+        connection.get("webhooks/#{id}")
+      end
+
+      # Create webhook
+      #
+      # @see https://developers.mailerlite.com/v2/reference#webhooks-2
+      #
+      # @param url [String] Your URL where callbacks are sent.
+      # @param event [String] Subscribed event.
+      #
+      # @return [Hash] Response from API.
+      def create_webhook(url, event)
+        connection.post('webhooks', url: url, event: event)
+      end
+
+      # Update webhook
+      #
+      # @see https://developers.mailerlite.com/v2/reference#webhooksid-1
+      #
+      # @param id [Integer] ID of webhook.
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :url Your URL where callbacks are sent
+      # @option options [String] :event Subscribed event
+      #
+      # @return [Hash] Response from API.
+      def update_webhook(id, options = {})
+        connection.put("webhooks/#{id}", options)
+      end
+
+      # Remove webhook
+      #
+      # @see https://developers.mailerlite.com/v2/reference#webhooksid-2
+      #
+      # @param id [Integer] ID of webhook.
+      #
+      # @return [Hash] Response from API.
+      def delete_webhook(id)
+        connection.delete("webhooks/#{id}")
+      end
+    end
+  end
+end

data/lib/mailerlite/version.rb

@@ -1,4 +1,4 @@
 module MailerLite
   # @return [String] Version number.
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailerlite
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Justas Palumickas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-09 00:00:00.000000000 Z
+date: 2017-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -106,12 +106,14 @@ files:
 - examples/fields.md
 - examples/groups.md
 - examples/subscribers.md
+- examples/webhooks.md
 - lib/mailerlite.rb
 - lib/mailerlite/client.rb
 - lib/mailerlite/clients/campaigns.rb
 - lib/mailerlite/clients/fields.rb
 - lib/mailerlite/clients/groups.rb
 - lib/mailerlite/clients/subscribers.rb
+- lib/mailerlite/clients/webhooks.rb
 - lib/mailerlite/configuration.rb
 - lib/mailerlite/connection.rb
 - lib/mailerlite/error.rb
@@ -142,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for MailerLite API v2