Ehee v0.0.1 Ehee.Gists

The Gist Webhooks API

Summary

Functions

create(credential, description, is_public, file_name, content)

Create a gist

create_comment(credential, id, comment)

Create a comment

delete_comment(credential, gist_id, comment_id)

Delete a comment

destroy(credential, id)

Delete a gist

edit(credential, id, file_name, content)

Edit a gist

edit_comment(credential, gist_id, comment_id, comment)

Edit a comment

list(credential)

List authenticated users gists

list_comments(credential, id)

List gist on a gist

list_public(credential)

List all public gists

list_users(credential, username)

List public gists for specified user

show(credential, id)

Get a single gist

show_comment(credential, gist_id, comment_id)

Get a single comment

star(credential, id)

Star a gist

starred?(credential, id)

Check if a gist is starred

unstar(credential, id)

Unstar a gist

Functions

create(credential, description, is_public, file_name, content)

Specs

create(Ehee.Credential.t, binary, boolean, binary, binary) :: Ehee.response

Create a gist

Example

Ehee.Gists.create(credential, "gist description", true, "file1", "sample gist")

More info at: https://developer.github.com/v3/gists/#create-a-gist

create_comment(credential, id, comment)

Specs

create_comment(Credentail.t, binary | integer, binary) :: Ehee.response

Create a comment

Example

Ehee.Gists.create_comment(credential, 1234567, "gist comment!")

More info at: https://developer.github.com/v3/gists/comments/#create-a-comment

delete_comment(credential, gist_id, comment_id)

Specs

delete_comment(Ehee.Credential.t, binary | integer, binary | integer) :: Ehee.response

Delete a comment

Example

Ehee.Gists.delete_comment(credential, 1234567, 1234567)

More info at: https://developer.github.com/v3/gists/comments/#delete-a-comment

destroy(credential, id)

Specs

destroy(Ehee.Credential.t, binary | integer) :: Ehee.response

Delete a gist

Example

Ehee.Gists.destroy(credential, 1234567)

More info at: https://developer.github.com/v3/gists/#delete-a-gist

edit(credential, id, file_name, content)

Specs

edit(Ehee.Credential.t, binary | integer, binary, binary) :: Ehee.response

Edit a gist

Example

Ehee.Gists.edit(credential, 1234567, "files", "sample gist")

More info at: https://developer.github.com/v3/gists/#edit-a-gist

edit_comment(credential, gist_id, comment_id, comment)

Specs

edit_comment(Credentail.t, binary | integer, binary | integer, binary) :: Ehee.response

Edit a comment

Example

Ehee.Gists.edit_coment(credential, 1234567, 1234567, "gist comment!")

More info at: https://developer.github.com/v3/gists/comments/#edit-a-comment

list(credential)

Specs

list(Ehee.Credential.t) :: Ehee.response

List authenticated users gists

Example

Ehee.Gists.list(credential)

More info at: https://developer.github.com/v3/gists/#list-a-users-gists

list_comments(credential, id)

Specs

list_comments(Credentail.t, binary | integer) :: Ehee.response

List gist on a gist

Example

Ehee.Gists.list_comments(credential, 1234567)

More info at: https://developer.github.com/v3/gists/comments/#list-comments-on-a-gist

list_public(credential)

Specs

list_public(Ehee.Credential.t) :: Ehee.response

List all public gists

Example

Ehee.Gists.list_public(credential)

More info at: https://developer.github.com/v3/gists/#list-all-public-gists

list_users(credential, username)

Specs

list_users(Ehee.Credential.t, binary) :: Ehee.response

List public gists for specified user

Example

Ehee.Gists.list_users(credential, "username")

More info at: https://developer.github.com/v3/gists/#list-a-users-gists

show(credential, id)

Specs

show(Ehee.Credential.t, binary | integer) :: Ehee.response

Get a single gist

Example

Ehee.Gists.show(credential, 1234567)

More info at: https://developer.github.com/v3/gists/#get-a-single-gist

show_comment(credential, gist_id, comment_id)

Specs

show_comment(Credentail.t, binary | integer, binary | integer) :: Ehee.response

Get a single comment

Example

Ehee.Gists.show_comment(credential, 1234567, 1234567)

More info at: https://developer.github.com/v3/gists/comments/#get-a-single-comment

star(credential, id)

Specs

star(Ehee.Credential.t, binary | integer) :: Ehee.response

Star a gist

Example

Ehee.Gists.star(credential, 1234567)

More info at: https://developer.github.com/v3/gists/#star-a-gist

starred?(credential, id)

Specs

starred?(Ehee.Credential.t, binary | integer) :: boolean

Check if a gist is starred

Example

Ehee.Gists.starred?(credential, 1234567)

More info at: https://developer.github.com/v3/gists/#check-if-a-gist-is-starred

unstar(credential, id)

Specs

unstar(Credentail.t, binary | integer) :: Ehee.response

Unstar a gist

Example

Ehee.Gists.unstar(credential, 1234567)

More info at: https://developer.github.com/v3/gists/#unstar-a-gist