View Source GitHub.Activity (GitHub REST API Client v0.0.9)
Provides API endpoints related to activity
Link to this section Summary
Functions
Check if a repository is starred by the authenticated user
Delete a repository subscription
Delete a thread subscription
Get feeds
Get a repository subscription
Get a thread
Get a thread subscription for the authenticated user
List events for the authenticated user
List notifications for the authenticated user
List organization events for the authenticated user
List public events
List public events for a network of repositories
List public events for a user
List public organization events
List events received by the authenticated user
List public events received by a user
List repository events
List repository notifications for the authenticated user
List repositories starred by the authenticated user
List repositories starred by a user
List repositories watched by a user
List stargazers
List repositories watched by the authenticated user
List watchers
Mark notifications as read
Mark repository notifications as read
Mark a thread as read
Set a repository subscription
Set a thread subscription
Star a repository for the authenticated user
Unstar a repository for the authenticated user
Link to this section Functions
check_repo_is_starred_by_authenticated_user(owner, repo, opts \\ [])
View Source@spec check_repo_is_starred_by_authenticated_user(String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Check if a repository is starred by the authenticated user
resources
Resources
@spec delete_repo_subscription(String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete a repository subscription
resources
Resources
@spec delete_thread_subscription( integer(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Delete a thread subscription
resources
Resources
@spec get_feeds(keyword()) :: {:ok, GitHub.Feed.t()} | {:error, GitHub.Error.t()}
Get feeds
resources
Resources
@spec get_repo_subscription(String.t(), String.t(), keyword()) :: {:ok, GitHub.Repository.Subscription.t()} | {:error, GitHub.Error.t()}
Get a repository subscription
resources
Resources
@spec get_thread( integer(), keyword() ) :: {:ok, GitHub.Thread.t()} | {:error, GitHub.Error.t()}
Get a thread
resources
Resources
get_thread_subscription_for_authenticated_user(thread_id, opts \\ [])
View Source@spec get_thread_subscription_for_authenticated_user( integer(), keyword() ) :: {:ok, GitHub.ThreadSubscription.t()} | {:error, GitHub.Error.t()}
Get a thread subscription for the authenticated user
resources
Resources
@spec list_events_for_authenticated_user( String.t(), keyword() ) :: {:ok, [GitHub.Event.t()]} | {:error, GitHub.Error.t()}
List events for the authenticated user
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_notifications_for_authenticated_user(keyword()) :: {:ok, [GitHub.Thread.t()]} | {:error, GitHub.Error.t()}
List notifications for the authenticated user
options
Options
all
(boolean): Iftrue
, show notifications marked as read.participating
(boolean): Iftrue
, only shows notifications in which the user is directly participating or mentioned.since
(String.t()): Only show notifications updated after the given time. This is a timestamp in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZ
.before
(String.t()): Only show notifications updated before the given time. This is a timestamp in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZ
.page
(integer): Page number of the results to fetch.per_page
(integer): The number of results per page (max 50).
resources
Resources
@spec list_org_events_for_authenticated_user(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Event.t()]} | {:error, GitHub.Error.t()}
List organization events for the authenticated user
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_public_events(keyword()) :: {:ok, [GitHub.Event.t()]} | {:error, GitHub.Error.t()}
List public events
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_public_events_for_repo_network(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Event.t()]} | {:error, GitHub.Error.t()}
List public events for a network of repositories
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_public_events_for_user( String.t(), keyword() ) :: {:ok, [GitHub.Event.t()]} | {:error, GitHub.Error.t()}
List public events for a user
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_public_org_events( String.t(), keyword() ) :: {:ok, [GitHub.Event.t()]} | {:error, GitHub.Error.t()}
List public organization events
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_received_events_for_user( String.t(), keyword() ) :: {:ok, [GitHub.Event.t()]} | {:error, GitHub.Error.t()}
List events received by the authenticated user
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_received_public_events_for_user( String.t(), keyword() ) :: {:ok, [GitHub.Event.t()]} | {:error, GitHub.Error.t()}
List public events received by a user
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_repo_events(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Event.t()]} | {:error, GitHub.Error.t()}
List repository events
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
list_repo_notifications_for_authenticated_user(owner, repo, opts \\ [])
View Source@spec list_repo_notifications_for_authenticated_user( String.t(), String.t(), keyword() ) :: {:ok, [GitHub.Thread.t()]} | {:error, GitHub.Error.t()}
List repository notifications for the authenticated user
options
Options
all
(boolean): Iftrue
, show notifications marked as read.participating
(boolean): Iftrue
, only shows notifications in which the user is directly participating or mentioned.since
(String.t()): Only show notifications updated after the given time. This is a timestamp in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZ
.before
(String.t()): Only show notifications updated before the given time. This is a timestamp in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZ
.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_repos_starred_by_authenticated_user(keyword()) :: {:ok, [GitHub.Repository.t()]} | {:error, GitHub.Error.t()}
List repositories starred by the authenticated user
options
Options
sort
(String.t()): The property to sort the results by.created
means when the repository was starred.updated
means when the repository was last pushed to.direction
(String.t()): The direction to sort the results by.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_repos_starred_by_user( String.t(), keyword() ) :: {:ok, [GitHub.Repository.t()] | [GitHub.StarredRepository.t()]} | {:error, GitHub.Error.t()}
List repositories starred by a user
options
Options
sort
(String.t()): The property to sort the results by.created
means when the repository was starred.updated
means when the repository was last pushed to.direction
(String.t()): The direction to sort the results by.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_repos_watched_by_user( String.t(), keyword() ) :: {:ok, [GitHub.Repository.minimal()]} | {:error, GitHub.Error.t()}
List repositories watched by a user
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_stargazers_for_repo(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Stargazer.t()] | [GitHub.User.simple()]} | {:error, GitHub.Error.t()}
List stargazers
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_watched_repos_for_authenticated_user(keyword()) :: {:ok, [GitHub.Repository.minimal()]} | {:error, GitHub.Error.t()}
List repositories watched by the authenticated user
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_watchers_for_repo(String.t(), String.t(), keyword()) :: {:ok, [GitHub.User.simple()]} | {:error, GitHub.Error.t()}
List watchers
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec mark_notifications_as_read( map(), keyword() ) :: {:ok, map()} | {:error, GitHub.Error.t()}
Mark notifications as read
resources
Resources
@spec mark_repo_notifications_as_read(String.t(), String.t(), map(), keyword()) :: {:ok, map()} | {:error, GitHub.Error.t()}
Mark repository notifications as read
resources
Resources
@spec mark_thread_as_read( integer(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Mark a thread as read
resources
Resources
@spec set_repo_subscription(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Repository.Subscription.t()} | {:error, GitHub.Error.t()}
Set a repository subscription
resources
Resources
@spec set_thread_subscription(integer(), map(), keyword()) :: {:ok, GitHub.ThreadSubscription.t()} | {:error, GitHub.Error.t()}
Set a thread subscription
resources
Resources
@spec star_repo_for_authenticated_user(String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Star a repository for the authenticated user
resources
Resources
@spec unstar_repo_for_authenticated_user(String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Unstar a repository for the authenticated user