View Source GitHub.Gists (GitHub REST API Client v0.0.11)
Provides API endpoints related to gists
Link to this section Summary
Functions
Check if a gist is starred
Create a gist
Create a gist comment
Delete a gist
Delete a gist comment
Fork a gist
Get a gist
Get a gist comment
Get a gist revision
List gists for the authenticated user
List gist comments
List gist commits
List gists for a user
List gist forks
List public gists
List starred gists
Star a gist
Unstar a gist
Update a gist
Update a gist comment
Link to this section Functions
@spec check_is_starred( String.t(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Check if a gist is starred
resources
Resources
@spec create( map(), keyword() ) :: {:ok, GitHub.Gist.simple()} | {:error, GitHub.Error.t()}
Create a gist
resources
Resources
@spec create_comment(String.t(), map(), keyword()) :: {:ok, GitHub.Gist.Comment.t()} | {:error, GitHub.Error.t()}
Create a gist comment
resources
Resources
@spec delete( String.t(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Delete a gist
resources
Resources
@spec delete_comment(String.t(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete a gist comment
resources
Resources
@spec fork( String.t(), keyword() ) :: {:ok, GitHub.BaseGist.t()} | {:error, GitHub.Error.t()}
Fork a gist
resources
Resources
@spec get( String.t(), keyword() ) :: {:ok, GitHub.Gist.simple()} | {:error, GitHub.Error.t()}
Get a gist
resources
Resources
@spec get_comment(String.t(), integer(), keyword()) :: {:ok, GitHub.Gist.Comment.t()} | {:error, GitHub.Error.t()}
Get a gist comment
resources
Resources
@spec get_revision(String.t(), String.t(), keyword()) :: {:ok, GitHub.Gist.simple()} | {:error, GitHub.Error.t()}
Get a gist revision
resources
Resources
@spec list(keyword()) :: {:ok, [GitHub.BaseGist.t()]} | {:error, GitHub.Error.t()}
List gists for the authenticated user
options
Options
since
(String.t()): Only show notifications updated after 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_comments( String.t(), keyword() ) :: {:ok, [GitHub.Gist.Comment.t()]} | {:error, GitHub.Error.t()}
List gist comments
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_commits( String.t(), keyword() ) :: {:ok, [GitHub.Gist.Commit.t()]} | {:error, GitHub.Error.t()}
List gist commits
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_for_user( String.t(), keyword() ) :: {:ok, [GitHub.BaseGist.t()]} | {:error, GitHub.Error.t()}
List gists for a user
options
Options
since
(String.t()): Only show notifications updated after 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_forks( String.t(), keyword() ) :: {:ok, [GitHub.Gist.simple()]} | {:error, GitHub.Error.t()}
List gist forks
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(keyword()) :: {:ok, [GitHub.BaseGist.t()]} | {:error, GitHub.Error.t()}
List public gists
options
Options
since
(String.t()): Only show notifications updated after 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_starred(keyword()) :: {:ok, [GitHub.BaseGist.t()]} | {:error, GitHub.Error.t()}
List starred gists
options
Options
since
(String.t()): Only show notifications updated after 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 star( String.t(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Star a gist
resources
Resources
@spec unstar( String.t(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Unstar a gist
resources
Resources
@spec update(String.t(), map() | nil, keyword()) :: {:ok, GitHub.Gist.simple()} | {:error, GitHub.Error.t()}
Update a gist
resources
Resources
@spec update_comment(String.t(), integer(), map(), keyword()) :: {:ok, GitHub.Gist.Comment.t()} | {:error, GitHub.Error.t()}
Update a gist comment