module Remind101::Client::Subscribers

Public Instance Methods

delete_group_subscriber(group_id, subscriber_id) click to toggle source

Public: Removes a subscriber from the group.

Examples

remind101.delete_group_subscriber 1234, 4321

Returns the faraday response.

# File lib/remind101/client/subscribers.rb, line 54
def delete_group_subscriber(group_id, subscriber_id)
  api_delete("/groups/#{group_id}/subscribers/#{subscriber_id}")
end
delete_group_subscribers(group_id) click to toggle source

Public: Removes all subscribers from the group.

Examples

remind101.delete_group_subscribers

Returns the faraday response.

# File lib/remind101/client/subscribers.rb, line 65
def delete_group_subscribers(group_id)
  api_delete("/groups/#{group_id}/subscribers")
end
get_group_subscribers(group_id, options = {}) click to toggle source

Public: Returns all subscribers for the given group.

Examples

remind101.get_group_subscribers 1234

Returns the faraday response.

# File lib/remind101/client/subscribers.rb, line 21
def get_group_subscribers(group_id, options = {})
  api_get("/groups/#{group_id}/subscribers", options)
end
get_subscriber(subscriber_id, options = {}) click to toggle source

Public: Returns a single subscriber.

Examples

remind101.get_subscriber 4321

Returns the faraday response.

# File lib/remind101/client/subscribers.rb, line 32
def get_subscriber(subscriber_id, options = {})
  api_get("/subscribers/#{subscriber_id}", options)
end
get_subscribers(options = {}) click to toggle source

Public: Returns all subscribers for the current user.

Examples

remind101.get_subscribers

Returns the faraday response.

# File lib/remind101/client/subscribers.rb, line 10
def get_subscribers(options = {})
  api_get("/subscribers", options)
end
rename_subscriber(subscriber_id, name) click to toggle source

Public: Updates a subscriber.

Examples

remind101.patch_subscriber 4321, attributes

Returns the faraday response.

# File lib/remind101/client/subscribers.rb, line 43
def rename_subscriber(subscriber_id, name)
  api_post("/subscribers/#{subscriber_id}/rename", name: name)
end