module Twitter::REST::AccountActivity

Public Instance Methods

check_subscription(env_name) click to toggle source

Provides a way to determine if a webhook configuration is subscribed to the provided user's events. If the provided user context has an active subscription with provided application, returns 204 OK. @see developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#get-account-activity-all-env-name-subscriptions @note Check if the user is subscribed to the given app @rate_limited Yes @authentication Requires user context - all consumer and access tokens @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [nil] @param env_name [String] Environment Name

# File lib/twitter/rest/account_activity.rb, line 82
def check_subscription(env_name)
  perform_request(:get, "/1.1/account_activity/all/#{env_name}/subscriptions.json")
end
create_subscription(env_name) click to toggle source

Subscribes the provided application to all events for the provided environment for all message types. After activation, all events for the requesting user will be sent to the application's webhook via POST request. @see developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#post-account-activity-all-env-name-subscriptions @note Subscribe the user(whose credentials are provided) to the app so that the webhook can receive all types of events from user @rate_limited Yes @authentication Requires user context - all consumer and access tokens @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [nil] @param env_name [String] Environment Name

# File lib/twitter/rest/account_activity.rb, line 70
def create_subscription(env_name)
  perform_request(:json_post, "/1.1/account_activity/all/#{env_name}/subscriptions.json")
end
create_webhook(env_name, url) click to toggle source

Registers a webhook URL for all event types. The URL will be validated via CRC request before saving. In case the validation failed, returns comprehensive error message to the requester. @see developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference @see developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#post-account-activity-all-env-name-webhooks @note Create a webhook @rate_limited Yes @authentication Requires user context - all consumer and access tokens @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Hash] @param env_name [String] Environment Name. @param url [String] Encoded URL for the callback endpoint.

# File lib/twitter/rest/account_activity.rb, line 21
def create_webhook(env_name, url)
  perform_request(:json_post, "/1.1/account_activity/all/#{env_name}/webhooks.json?url=#{url}")
end
deactivate_subscription(env_name) click to toggle source

Deactivates subscription(s) for the provided user context and application for all activities. After deactivation, all events for the requesting user will no longer be sent to the webhook URL. @see developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#delete-account-activity-all-env-name-subscriptions @note Deactivate a subscription, Users events will not be sent to the app @rate_limited Yes @authentication Requires user context - all consumer and access tokens @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [nil] @param env_name [String] Environment Name

# File lib/twitter/rest/account_activity.rb, line 94
def deactivate_subscription(env_name)
  perform_request(:delete, "/1.1/account_activity/all/#{env_name}/subscriptions.json")
end
delete_webhook(env_name, webhook_id) click to toggle source

Removes the webhook from the provided application's all activities configuration. The webhook ID can be accessed by making a call to GET /1.1/account_activity/all/webhooks. @see developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#delete-account-activity-all-env-name-webhooks-webhook-id @note Delete a webhook @authentication Requires user context - all consumer and access tokens @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [nil] @param env_name [String] Environment Name. @param webhook_id [String] Webhook ID.

# File lib/twitter/rest/account_activity.rb, line 45
def delete_webhook(env_name, webhook_id)
  perform_request(:delete, "/1.1/account_activity/all/#{env_name}/webhooks/#{webhook_id}.json")
end
list_webhooks(env_name) click to toggle source

Returns all environments, webhook URLs and their statuses for the authenticating app. Currently, only one webhook URL can be registered to each environment. @see developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#get-account-activity-all-webhooks @note List webhooks @rate_limited Yes @authentication Requires user context - all consumer and access tokens @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Hash] @param env_name [String] Environment Name.

# File lib/twitter/rest/account_activity.rb, line 33
def list_webhooks(env_name)
  perform_request(:get, "/1.1/account_activity/all/#{env_name}/webhooks.json")
end
trigger_crc_check(env_name, webhook_id) click to toggle source

Triggers the challenge response check (CRC) for the given enviroments webhook for all activites. If the check is successful, returns 204 and reenables the webhook by setting its status to valid. @see developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#put-account-activity-all-env-name-webhooks-webhook-id @note Trigger CRC check to a webhook @rate_limited Yes @authentication Requires user context - all consumer and access tokens @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [nil] @param env_name [String] Environment Name. @param webhook_id [String] Webhook ID.

# File lib/twitter/rest/account_activity.rb, line 58
def trigger_crc_check(env_name, webhook_id)
  perform_request(:json_put, "/1.1/account_activity/all/#{env_name}/webhooks/#{webhook_id}.json")
end