Packages

tentacat

1.4.0
2.5.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.1 2.0.0 1.6.1 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.9.0 0.8.0 0.7.2 0.7.1 0.7.0 0.6.2 0.6.1 0.6.0 0.5.3 0.5.2 0.5.1 0.5.0 0.4.0 0.3.1 0.3.0 0.2.1 0.2.0 0.1.5 0.1.4 0.1.3 0.1.2 0.1.1 0.1.0

Simple Elixir wrapper for the GitHub API

HexDocs

Current section

Files

Jump to
Readme
38 Versions
2 Dependencies
Dependants
Files
Activity
tentacat lib tentacat projects.ex
Raw

lib/tentacat/projects.ex 

defmodule Tentacat.Projects do

  import Tentacat, [:except, :delete, 2]

  alias Tentacat.Client



  @doc """

  Get a single `project`



  ## Example



      Tentacat.Projects.find client, 12345



  More info at: https://developer.github.com/v3/projects/#get-a-project

  """

  @spec find(Client.t(), binary) :: Tentacat.response()

  def find(client, id) do

    get("projects/#{id}", client)

  end



  @doc """

  Update the `project`



  Possible values for `options`:



  * [name: "name of project"]

  * [body: "description of project"]

  * [state: "open"]

  * [organization_permission: "read"]

  * [private: true]



  ## Example



      Tentcat.Projects.update client, [name: "My Board", private: true]



  More info at: https://developer.github.com/v3/projects/#update-a-project

  """

  @spec update(Client.t(), binary, Keyword.t()) :: Tentacat.response()

  def update(client, id, options) do

    patch("projects/#{id}", client, options)

  end



  @doc """

  Delete a `project`



  ## Example



      Tentacat.Projects.delete client, 12345



  More info at: https://developer.github.com/v3/projects/#delete-a-project

  """

  @spec delete(Client.t(), binary) :: Tentacat.response()

  def delete(client, id) do

    Tentacat.delete("projects/#{id}", client)

  end

end