Tentacat v0.3.1 → Overview → Tentacat → Pulls

Tentacat.Pulls

Summary

create(owner, repo, body, client)	Create a pull request
filter(owner, repo, filters, client \\ %Tentacat.Client{})	Filter pull requests
find(owner, repo, number, client \\ %Tentacat.Client{})	Get a single pull request
list(owner, repo, client \\ %Tentacat.Client{})	List pull requests
update(owner, repo, number, body, client)	Update a pull request

create(owner, repo, body, client)

(function) # ↑

Specs:

Create a pull request

Pull Request body example:

%{
  "title" => "Amazing new feature",
  "body"  => "Please pull this in!",
  "head"  => "octocat:new-feature",
  "base"  => "master"
 }

Alternative input (using an existing issue):

%{
  "issue" => "5",
  "head"  => "octocat:new-feature",
  "base"  => "master"
 }

Tentacat.Pulls.create "elixir-lang", "elixir", body, client

filter(owner, repo, filters, client \\ %Tentacat.Client{})

(function) # ↑

Specs:

Filter pull requests

Tentacat.Pulls.filter "elixir-lang", "elixir", %{state: "open"}
Tentacat.Pulls.filter "elixir-lang", "elixir", %{state: "open"}, client

find(owner, repo, number, client \\ %Tentacat.Client{})

(function) # ↑

Specs:

Get a single pull request

Tentacat.Pulls.find "elixir-lang", "elixir", "2974"
Tentacat.Pulls.find "elixir-lang", "elixir", "2974", client

list(owner, repo, client \\ %Tentacat.Client{})

(function) # ↑

Specs:

List pull requests

Tentacat.Pulls.list "elixir-lang", "elixir"
Tentacat.Pulls.list "elixir-lang", "elixir", client

update(owner, repo, number, body, client)

(function) # ↑

Specs:

update(binary, binary, binary | integer, list | map, Tentacat.Client.t) :: Tentacat.response

Update a pull request

Pull Request body example:

%{
  "title" => "new title",
  "body"  => "updated body",
  "state" => "open"
 }

Tentacat.Pulls.update "elixir-lang", "elixir", "2974", body, client