bwapi 11.0.1.pre.595 → 11.0.1.pre.596

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OGM3NjQ4OTU2ODk3OGM3ZTVjMTc0ZDFkN2ZhMDQ4MTJkNzE5YjEwNw==
+    NjExZTRmYjIyY2RmZmVkYTc4OGQyNDEwMDA4MzhhMzc2NjRiZTdiYQ==
   data.tar.gz: !binary |-
-    OGNjODViZjNjODc0OGRhNmUzMDUxNDBjZDI5NjFmNzNmMmJiYjMxOQ==
+    NWJkZTJkNjY3MTA3Mjc3MGQ3NTM2NTEyMmM5YTdiMjFkYjA4MmQzNg==
 SHA512:
   metadata.gz: !binary |-
-    YTU3YjVkZTFlYjBmMmFlZmFmYzYyN2YxZDkyNGNiZTc0ZWY2NTMyMjhiMmQ4
-    ZGVhOTEzMzBmMTZjZDczZjM5OTU1NmJlMDBhMTdiNzFlNzFiN2JkYTEyMWNk
-    NGM5YTE5YWY1OTg4M2QxODE3NzA4ZDQwYTk1MGI2N2MyZGQxMzU=
+    YmU3NmFmMGEzOGZkM2IxMDkwNWQ5OWFkNDFlODRlN2VmOTc2YTIxNTBiODhm
+    NDYwNzVhZmJlZjQwNDE4NDI2ZmE5ZTI2NDEzZjhkNTEwZDg1ZjZmMjFiMDNm
+    NDFkOWFlZTViNjg5Y2E4Y2ZiZDRkYzRiMWYzNDk1MzZjZGY0ODM=
   data.tar.gz: !binary |-
-    ZjcxZGExN2VkNmI4NWVhY2U2ZjIyZDUxMTU5YjZkNTczOTJiYzc3NDhjNmIy
-    YzBkYzRhZTgxZTkzZWI5OGI2NDc0ZjY4NmYwMjhlY2RiNzMzYjBlYTgwODg0
-    MWM1NGExN2JiYWE5ZTQzMGI4NjVhMzAzNjM4NWI3MDAyNmUzY2Q=
+    YTg4NDI4MjlkMzI3NjM4YzEyMjlmOWNjOWEyYmNkZTVmMGZhOTBlNTM1ZmIz
+    NTBiMjY1NjUyMDNlZDNjZjIxZDVkNjc4NDEzZWVkNDg4OTkxYTAwNmUwZWEw
+    NTM1M2FhYTlkMTdmZmY1MzhjYjlmZjE4NjQyMWZiMWVkZTY4ZDI=

data/lib/bwapi/client/projects.rb

@@ -1,3 +1,4 @@
+require 'bwapi/client/projects/alerts'
 require 'bwapi/client/projects/bulk_actions'
 require 'bwapi/client/projects/categories'
 require 'bwapi/client/projects/data'
@@ -97,6 +98,7 @@ module BWAPI
         get "/projects/#{project_id}/twitteraudiencesummary", opts
       end
 
+      include BWAPI::Client::Projects::Alerts
       include BWAPI::Client::Projects::BulkActions
       include BWAPI::Client::Projects::Categories
       include BWAPI::Client::Projects::Data

data/lib/bwapi/client/projects/alerts.rb

@@ -0,0 +1,83 @@
+module BWAPI
+  class Client
+    module Projects
+      # Alerts module for alerts endpoints
+      module Alerts
+        # Get a list of alerts
+        #
+        # @param project_id [Integer] Id of project
+        # @return [Hash] Alerts in project
+        def alerts(project_id)
+          get "projects/#{project_id}/alerts"
+        end
+
+        # Get a selected alert
+        #
+        # @param project_id [Integer] Id of project
+        # @param alert_id [Integer] Id of alert
+        # @return [Hash] Alert in project
+        def get_alert(project_id, alert_id)
+          get "projects/#{project_id}/alerts/#{alert_id}"
+        end
+
+        # Create a new alert in project
+        #
+        # @param project_id [Integer] Id of project
+        # @param opts [Hash] options hash of parameters
+        # @option opts [String] alertTypes type of alert
+        # @option opts [Integer] clientId The id of the client
+        # @option opts [Date] created Creation date
+        # @option opts [Boolean] deleted Alert deleted check
+        # @option opts [Boolean] emailCreator Does this alert also email the creator
+        # @option opts [Boolean] enabled Alert enabled check
+        # @option opts [Boolean] externalLink External link
+        # @option opts [Integer] frequency Frequence of checks
+        # @option opts [Integer] id The id of Frequence
+        # @option opts [Long] lastResourceId Last checked resource id
+        # @option opts [Integer] mentionsPerAlert Number of mentions
+        # @option opts [String] name Alert name
+        # @option opts [Date] nextRun Date/time of next run
+        # @option opts [Integer] queryId Corresponding query id
+        # @option opts [String] queryName Name of the query this alert relates to
+        # @option opts [Integer] repeatOnDayOfWeek Repeats in a week
+        # @option opts [Integer] repeatOnHourOfDay Repeats in a day
+        # @option opts [String] searchLiteString Filters to be considered
+        # @option opts [Double] threshold Threshold
+        # @option opts [Integer] userId Corresponding user id
+        # @return [Hash] New alert
+        def create_alert(project_id, opts = {})
+          post "/projects/#{project_id}/alerts", opts
+        end
+
+        # Update an existing alert in project
+        #
+        # @param project_id [Integer] Id of project
+        # @param opts [Hash] options hash of parameters
+        # @option opts [String] alertTypes type of alert
+        # @option opts [Integer] clientId The id of the client
+        # @option opts [Date] created Creation date
+        # @option opts [Boolean] deleted Alert deleted check
+        # @option opts [Boolean] emailCreator Does this alert also email the creator
+        # @option opts [Boolean] enabled Alert enabled check
+        # @option opts [Boolean] externalLink External link
+        # @option opts [Integer] frequency Frequence of checks
+        # @option opts [Integer] id The id of Frequence
+        # @option opts [Long] lastResourceId Last checked resource id
+        # @option opts [Integer] mentionsPerAlert Number of mentions
+        # @option opts [String] name Alert name
+        # @option opts [Date] nextRun Date/time of next run
+        # @option opts [Integer] queryId Corresponding query id
+        # @option opts [String] queryName Name of the query this alert relates to
+        # @option opts [Integer] repeatOnDayOfWeek Repeats in a week
+        # @option opts [Integer] repeatOnHourOfDay Repeats in a day
+        # @option opts [String] searchLiteString Filters to be considered
+        # @option opts [Double] threshold Threshold
+        # @option opts [Integer] userId Corresponding user id
+        # @return [Hash] Returns alert as saved
+        def update_alert(project_id, opts = {})
+          put "/projects/#{project_id}/alerts", opts
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bwapi
 version: !ruby/object:Gem::Version
-  version: 11.0.1.pre.595
+  version: 11.0.1.pre.596
 platform: ruby
 authors:
 - Jonathan Chrisp
@@ -212,6 +212,7 @@ files:
 - lib/bwapi/client/oauth.rb
 - lib/bwapi/client/ping.rb
 - lib/bwapi/client/projects.rb
+- lib/bwapi/client/projects/alerts.rb
 - lib/bwapi/client/projects/bulk_actions.rb
 - lib/bwapi/client/projects/bulk_actions/author.rb
 - lib/bwapi/client/projects/bulk_actions/mentions.rb