ex_trello v0.2.1 ExTrello
Provides access interface to the Trello API.
Summary
Functions
GET OAuthGetAccessToken
GET OAuthAuthorizeToken
GET OAuthAuthorizeToken
Fetch board with board_id
Fetch board with board_id. See reference for list of options
Fetch all boards of authenticated user
Fetch all boards of authenticated user
Fetch all boards of given username or Trello User ID
Provides OAuth configuration settings for accessing trello server
Provides OAuth configuration settings for accessing trello server
Create board with supplied name
Create board with supplied name
& options
Edit board with supplied field values
GET OAuthGetRequestToken
false
Functions
GET OAuthGetAccessToken
Examples
ExTrello.access_token("OAUTH_VERIFIER", "OAUTH_TOKEN", "OAUTH_TOKEN_SECRET")
GET OAuthAuthorizeToken
Examples
token = ExTrello.request_token
ExTrello.authorize_url(token.oauth_token)
Returns the URL you should redirect the user to for authorization
GET OAuthAuthorizeToken
Examples
token = ExTrello.request_token("http://localhost:4000/auth/trello/callback/1234")
ExTrello.authorize_url(token.oauth_token, %{return_url: "http://localhost:4000/auth/trello/callback/1234", scope: "read,write", expiration: "never", name: "Example Authentication"})
Returns the URL you should redirect the user to for authorization
Specs
board(String.t) :: ExTrello.Model.Board.t | nil
Fetch board with board_id.
Examples
ExTrello.board("57663306e4b15193fcc97483")
Reference
https://developers.trello.com/advanced-reference/board#get-1-boards-board-id
Specs
board(String.t, Keyword.t) ::
ExTrello.Model.Board.t |
nil
Fetch board with board_id. See reference for list of options.
Examples
ExTrello.board("57663306e4b15193fcc97483", [actions_display: true])
Reference
https://developers.trello.com/advanced-reference/board#get-1-boards-board-id
Specs
boards :: [ExTrello.Model.Board] | []
Fetch all boards of authenticated user.
Examples
ExTrello.boards()
Specs
boards(Keyword.t) :: [ExTrello.Model.Board] | []
Fetch all boards of authenticated user.
Examples
ExTrello.boards([filter: "pinned,public", fields: "shortLink,subscribed"])
Reference
https://developers.trello.com/advanced-reference/member#get-1-members-idmember-or-username-boards
Fetch all boards of given username or Trello User ID.
Examples
ExTrello.boards("trello")
Reference
https://developers.trello.com/advanced-reference/member#get-1-members-idmember-or-username-boards
Specs
configure(Keyword.t) :: :ok
Provides OAuth configuration settings for accessing trello server.
The specified configuration applies globally. Use ExTrello.configure/2
for setting different configurations on each processes.
Examples
ExTrello.configure(
app_key: System.get_env("TRELLO_APP_KEY"),
app_secret: System.get_env("TRELLO_APP_SECRET"),
access_token: System.get_env("TRELLO_ACCESS_TOKEN"),
access_token_secret: System.get_env("TRELLO_ACCESS_SECRET")
)
Specs
configure(:global | :process, Keyword.t) :: :ok
Provides OAuth configuration settings for accessing trello server.
Options
The scope
can have one of the following values.
:global
- configuration is shared for all processes.:process
- configuration is isolated for each process.
Examples
ExTrello.configure(
:process,
app_key: System.get_env("TRELLO_APP_KEY"),
app_secret: System.get_env("TRELLO_APP_SECRET"),
access_token: System.get_env("TRELLO_ACCESS_TOKEN"),
access_token_secret: System.get_env("TRELLO_ACCESS_SECRET")
)
Specs
create_board(String.t) :: ExTrello.Model.Board.t | nil
Create board with supplied name
.
Examples
# Bad
ExTrello.create_board(123) #=> %ExTrello.Error{code: 422, message: "You must provide a name with a length between 1 and 16384 to create a board."}
# Good
ExTrello.create_board("TrelloHub")
Reference
https://developers.trello.com/advanced-reference/board#post-1-boards
Specs
create_board(String.t, Keyword.t) ::
ExTrello.Model.Board.t |
nil
Create board with supplied name
& options.
Examples
# Bad
ExTrello.create_board(123) #=> %ExTrello.Error{code: 422, message: "You must provide a name with a length between 1 and 16384 to create a board."}
# Good
ExTrello.create_board("TrelloHub", desc: "An application to synchronize your Trello boards with your GitHub activity.", powerups: "all")
Reference
https://developers.trello.com/advanced-reference/board#post-1-boards
Specs
edit_board(String.t, Keyword.t) ::
ExTrello.Model.Board.t |
nil
Edit board with supplied field values.
Examples
# Capture the id of our newly created board.
%ExTrello.Model.Board{id: id} = ExTrello.create_board("Some name")
# Let's edit the name of our new board.
ExTrello.edit_board(id, name: "Another name entirely.")
Reference
https://developers.trello.com/advanced-reference/board#put-1-boards-board-id
Specs
request_token(String.t) :: [ExTrello.Model.RequestToken.t]
GET OAuthGetRequestToken
Examples
ExTrello.request_token("http://localhost:4000/auth/trello/callback/1234")