View Source GitHub.Projects (GitHub REST API Client v0.0.1)
Provides API endpoints related to projects
Link to this section Summary
Functions
Add project collaborator
Create a project card
Create a project column
Create a user project
Create an organization project
Create a repository project
Delete a project
Delete a project card
Delete a project column
Get a project
Get a project card
Get a project column
Get project permission for a user
List project cards
List project collaborators
List project columns
List organization projects
List repository projects
List user projects
Move a project card
Move a project column
Remove user as a collaborator
Update a project
Update an existing project card
Update an existing project column
Link to this section Functions
@spec add_collaborator(integer(), String.t(), map(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Add project collaborator
resources
Resources
@spec create_card(integer(), map(), keyword()) :: {:ok, GitHub.Project.Card.t()} | {:error, GitHub.Error.t()}
Create a project card
resources
Resources
@spec create_column(integer(), map(), keyword()) :: {:ok, GitHub.Project.Column.t()} | {:error, GitHub.Error.t()}
Create a project column
resources
Resources
@spec create_for_authenticated_user( map(), keyword() ) :: {:ok, GitHub.Project.t()} | {:error, GitHub.Error.t()}
Create a user project
resources
Resources
@spec create_for_org(String.t(), map(), keyword()) :: {:ok, GitHub.Project.t()} | {:error, GitHub.Error.t()}
Create an organization project
resources
Resources
@spec create_for_repo(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Project.t()} | {:error, GitHub.Error.t()}
Create a repository project
resources
Resources
@spec delete( integer(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Delete a project
resources
Resources
@spec delete_card( integer(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Delete a project card
resources
Resources
@spec delete_column( integer(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Delete a project column
resources
Resources
@spec get( integer(), keyword() ) :: {:ok, GitHub.Project.t()} | {:error, GitHub.Error.t()}
Get a project
resources
Resources
@spec get_card( integer(), keyword() ) :: {:ok, GitHub.Project.Card.t()} | {:error, GitHub.Error.t()}
Get a project card
resources
Resources
@spec get_column( integer(), keyword() ) :: {:ok, GitHub.Project.Column.t()} | {:error, GitHub.Error.t()}
Get a project column
resources
Resources
@spec get_permission_for_user(integer(), String.t(), keyword()) :: {:ok, GitHub.Project.CollaboratorPermission.t()} | {:error, GitHub.Error.t()}
Get project permission for a user
resources
Resources
@spec list_cards( integer(), keyword() ) :: {:ok, [GitHub.Project.Card.t()]} | {:error, GitHub.Error.t()}
List project cards
options
Options
archived_state
(String.t()): Filters the project cards that are returned by the card's state.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_collaborators( integer(), keyword() ) :: {:ok, [GitHub.User.simple()]} | {:error, GitHub.Error.t()}
List project collaborators
options
Options
affiliation
(String.t()): Filters the collaborators by their affiliation.outside
means outside collaborators of a project that are not a member of the project's organization.direct
means collaborators with permissions to a project, regardless of organization membership status.all
means all collaborators the authenticated user can see.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_columns( integer(), keyword() ) :: {:ok, [GitHub.Project.Column.t()]} | {:error, GitHub.Error.t()}
List project columns
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_org( String.t(), keyword() ) :: {:ok, [GitHub.Project.t()]} | {:error, GitHub.Error.t()}
List organization projects
options
Options
state
(String.t()): Indicates the state of the projects to return.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_repo(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Project.t()]} | {:error, GitHub.Error.t()}
List repository projects
options
Options
state
(String.t()): Indicates the state of the projects to return.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.Project.t()]} | {:error, GitHub.Error.t()}
List user projects
options
Options
state
(String.t()): Indicates the state of the projects to return.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec move_card(integer(), map(), keyword()) :: {:ok, map()} | {:error, GitHub.Error.t()}
Move a project card
resources
Resources
@spec move_column(integer(), map(), keyword()) :: {:ok, map()} | {:error, GitHub.Error.t()}
Move a project column
resources
Resources
@spec remove_collaborator(integer(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Remove user as a collaborator
resources
Resources
@spec update(integer(), map(), keyword()) :: {:ok, GitHub.Project.t()} | {:error, GitHub.Error.t()}
Update a project
resources
Resources
@spec update_card(integer(), map(), keyword()) :: {:ok, GitHub.Project.Card.t()} | {:error, GitHub.Error.t()}
Update an existing project card
resources
Resources
@spec update_column(integer(), map(), keyword()) :: {:ok, GitHub.Project.Column.t()} | {:error, GitHub.Error.t()}
Update an existing project column