Module: Tacokit::Client::Checklists

Included in:

Tacokit::Client

Defined in:

lib/tacokit/client/checklists.rb

Instance Method Summary

• #add_checklist_check_item(checklist_id, name, options = {}) ⇒ Object (also: #checklist_check_item_create, #add_checklist_item)

  Add a checklist item to a checklist.

• #check_items(checklist_id, options = {}) ⇒ Array (also: #checklist_check_items)

  Retrieve a checklist's check items.

• #checklist(checklist_id, options = nil) ⇒ Tacokit::Resource

  Retrieve a checklist.

• #checklist_board(checklist_id, options = {}) ⇒ Tacokit::Resource

  Retrieve the checklist's board.

• #checklist_card(checklist_id, options = {}) ⇒ Tacokit::Resource

  Retrieve a checklist's card.

• #create_checklist(card_id, name, options = {}) ⇒ Object (also: #checklist_create)

  Create a checklist.

• #delete_checklist(checklist_id) ⇒ Object (also: #checklist_delete)

  Delete a checklist.

• #update_checklist(checklist_id, options = {}) ⇒ Object (also: #checklist_update)

  Updates a checklist.

Instance Method Details

#add_checklist_check_item(checklist_id, name, options = {}) ⇒ Object Also known as: checklist_check_item_create, add_checklist_item

Add a checklist item to a checklist

Parameters:

• checklist_id (String) —

  the checklist identifier

• name (String) —

  name for the check item

See Also:

• https://developers.trello.com/advanced-reference/checklist#post-1-checklists-idchecklist-checkitems

# File 'lib/tacokit/client/checklists.rb', line 64

def add_checklist_check_item(checklist_id, name, options = {})
  post checklist_path(checklist_id, "checkItems"), options.merge(name: name)
end

#check_items(checklist_id, options = {}) ⇒ Array Also known as: checklist_check_items

Retrieve a checklist's check items

Parameters:

• checklist_id (String) —

  the checklist identifier

• options (Hash) (defaults to: {}) —

  the options to fetch the checklist with

Returns:

• (Array) —

  the check items collection

See Also:

• https://developers.trello.com/advanced-reference/checklist#get-1-checklists-idchecklist-checkitems

# File 'lib/tacokit/client/checklists.rb', line 36

def check_items(checklist_id, options = {})
  checklist_resource checklist_id, "check_items", options
end

#checklist(checklist_id, options = nil) ⇒ Tacokit::Resource

Retrieve a checklist

Parameters:

• checklist_id (String) —

  the checklist identifier

• options (Hash) (defaults to: nil) —

  options to fetch the checklist with

Returns:

• (Tacokit::Resource) —

  the checklist resource

See Also:

• https://developers.trello.com/advanced-reference/checklist#get-1-checklists-idchecklist

# File 'lib/tacokit/client/checklists.rb', line 9

def checklist(checklist_id, options = nil)
  get checklist_path(checklist_id), options
end

#checklist_board(checklist_id, options = {}) ⇒ Tacokit::Resource

Retrieve the checklist's board

Parameters:

• checklist_id (String) —

  the checklist identifier

• options (Hash) (defaults to: {}) —

  the options to fetch the board with

Returns:

• (Tacokit::Resource) —

  the board resource

See Also:

• https://developers.trello.com/advanced-reference/checklist#get-1-checklists-idchecklist-board

# File 'lib/tacokit/client/checklists.rb', line 18

def checklist_board(checklist_id, options = {})
  checklist_resource checklist_list_id, "board", options
end

#checklist_card(checklist_id, options = {}) ⇒ Tacokit::Resource

Retrieve a checklist's card

Parameters:

• checklist_id (String) —

  the checklist identifier

• options (Hash) (defaults to: {}) —

  the options to fetch the card with

Returns:

• (Tacokit::Resource) —

  the card resource

See Also:

• https://developers.trello.com/advanced-reference/checklist#get-1-checklists-idchecklist-cards

# File 'lib/tacokit/client/checklists.rb', line 27

def checklist_card(checklist_id, options = {})
  checklist_resource checklist_id, "card", options
end

#create_checklist(card_id, name, options = {}) ⇒ Object Also known as: checklist_create

Create a checklist

Parameters:

• card_id (String, Tacokit::Resource<Card>) —

  the card identifier, shortlink, or card

• name (String) —

  name for the checklist

See Also:

• https://developers.trello.com/advanced-reference/checklist#post-1-checklists

# File 'lib/tacokit/client/checklists.rb', line 54

def create_checklist(card_id, name, options = {})
  options.update card_id: card_id, name: name
  post "checklists", options
end

#delete_checklist(checklist_id) ⇒ Object Also known as: checklist_delete

Delete a checklist

Parameters:

• checklist_id (String) —

  the checklist identifier

See Also:

• https://developers.trello.com/advanced-reference/checklist#delete-1-checklists-idchecklist

# File 'lib/tacokit/client/checklists.rb', line 73

def delete_checklist(checklist_id)
  delete checklist_path(checklist_id)
end

#update_checklist(checklist_id, options = {}) ⇒ Object Also known as: checklist_update

Updates a checklist

Parameters:

• checklist_id (String) —

  the checklist identifier

• options (Hash) (defaults to: {}) —

  the options to update the checklist with

See Also:

• https://developers.trello.com/advanced-reference/checklist#put-1-checklists-idchecklist

# File 'lib/tacokit/client/checklists.rb', line 45

def update_checklist(checklist_id, options = {})
  put checklist_path(checklist_id), options
end