Module: Tacokit::Client::Boards
- Included in:
- Tacokit::Client
- Defined in:
- lib/tacokit/client/boards.rb
Overview
Methods for the Boards API
Instance Method Summary (collapse)
-
- (Object) add_board_member(board_id, email, full_name, options = {})
Add a member to a board.
-
- (Tacokit::Resource<Board>) board(board_id, options = nil)
Retrieve a board.
-
- (Tacokit::Collection<Action>) board_actions(board_id, options = {})
Retrieve a board's actions.
-
- (Tacokit::Collection<Card>) board_cards(board_id, options = {})
Retrieve a board's cards.
-
- (Tacokit::Collection<Checklist>) board_checklists(board_id, options = {})
Retrieve a board's checklists.
-
- (Tacokit::Collection<Label>) board_labels(board_id, options = {})
Retrieve a board's labels.
-
- (Tacokit::Collection<Member>) board_members(board_id, options = {})
Retrieve a board's members.
-
- (Tacokit::Collection) board_organization(board_id, options = {})
Retrieve a board's organization.
-
- (Tacokit::Collection) board_preferences(board_id, options = {})
Retrieve your preferences for a board.
-
- (Tacokit::Collection<Star>) board_stars(board_id, options = {})
Retrieve a board's stars.
-
- (Object) create_board(name, options = {})
Create a board.
-
- (Tacokit::Collection<List>) lists(board_id, options = {})
(also: #board_lists)
Retrieve a board's lists.
-
- (Object) update_board(board_id, options = {})
Update board attributes.
-
- (Object) update_board_member(board_id, member_id, type)
Update a board member's type.
Instance Method Details
- (Object) add_board_member(board_id, email, full_name, options = {})
Add a member to a board
168 169 170 171 172 173 |
# File 'lib/tacokit/client/boards.rb', line 168 def add_board_member(board_id, email, full_name, = {}) .update \ email: email, full_name: full_name put board_path(board_id, "members"), end |
- (Tacokit::Resource<Board>) board(board_id, options = nil)
Retrieve a board
17 18 19 |
# File 'lib/tacokit/client/boards.rb', line 17 def board(board_id, = nil) get board_path(board_id), end |
- (Tacokit::Collection<Action>) board_actions(board_id, options = {})
Retrieve a board's actions
29 30 31 |
# File 'lib/tacokit/client/boards.rb', line 29 def board_actions(board_id, = {}) paginated_board_resource(board_id, "actions", ) end |
- (Tacokit::Collection<Card>) board_cards(board_id, options = {})
Retrieve a board's cards
58 59 60 |
# File 'lib/tacokit/client/boards.rb', line 58 def board_cards(board_id, = {}) paginated_board_resource(board_id, "cards", ) end |
- (Tacokit::Collection<Checklist>) board_checklists(board_id, options = {})
Retrieve a board's checklists
70 71 72 |
# File 'lib/tacokit/client/boards.rb', line 70 def board_checklists(board_id, = {}) board_resource(board_id, "checklists", ) end |
- (Tacokit::Collection<Label>) board_labels(board_id, options = {})
Retrieve a board's labels
84 85 86 |
# File 'lib/tacokit/client/boards.rb', line 84 def board_labels(board_id, = {}) board_resource(board_id, "labels", ) end |
- (Tacokit::Collection<Member>) board_members(board_id, options = {})
Retrieve a board's members
116 117 118 |
# File 'lib/tacokit/client/boards.rb', line 116 def board_members(board_id, = {}) board_resource(board_id, "members", ) end |
- (Tacokit::Collection) board_organization(board_id, options = {})
Retrieve a board's organization
142 143 144 |
# File 'lib/tacokit/client/boards.rb', line 142 def board_organization(board_id, = {}) board_resource(board_id, "organization", ) end |
- (Tacokit::Collection) board_preferences(board_id, options = {})
Retrieve your preferences for a board
128 129 130 |
# File 'lib/tacokit/client/boards.rb', line 128 def board_preferences(board_id, = {}) board_resource(board_id, "my_prefs", ) end |
- (Tacokit::Collection<Star>) board_stars(board_id, options = {})
Retrieve a board's stars
41 42 43 |
# File 'lib/tacokit/client/boards.rb', line 41 def board_stars(board_id, = {}) board_resource(board_id, "board_stars", ) end |
- (Object) create_board(name, options = {})
Create a board
196 197 198 |
# File 'lib/tacokit/client/boards.rb', line 196 def create_board(name, = {}) post "boards", .merge(name: name) end |
- (Tacokit::Collection<List>) lists(board_id, options = {}) Also known as: board_lists
Retrieve a board's lists
101 102 103 |
# File 'lib/tacokit/client/boards.rb', line 101 def lists(board_id, = {}) board_resource(board_id, "lists", ) end |
- (Object) update_board(board_id, options = {})
Update board attributes
155 156 157 |
# File 'lib/tacokit/client/boards.rb', line 155 def update_board(board_id, = {}) put board_path(board_id), end |
- (Object) update_board_member(board_id, member_id, type)
Update a board member's type
184 185 186 |
# File 'lib/tacokit/client/boards.rb', line 184 def update_board_member(board_id, member_id, type) update_board_resource(board_id, "members", resource_id(member_id), type: type) end |