Module: Camper::Client::TodolistsAPI

Included in:

Camper::Client

Defined in:

lib/camper/api/todolists.rb

Overview

Defines methods related to todolists.

See Also:

• https://github.com/basecamp/bc3-api/blob/master/sections/todolists.md

Instance Method Summary

• #create_todolist(todoset, name, description = '') ⇒ Resource

  Create a todolist within the given todoset.

• #todolist(todoset, id) ⇒ Resource

  Get a todolist with a given id.

• #todolists(todoset, options = {}) ⇒ PaginatedResponse<Resource>

  Get the todolists associated with the todoset.

• #trash_todolist(todolist) ⇒ Object

  Trash a todolist it calls the trash_recording endpoint under the hood.

• #update_todolist(todolist, name, description = nil) ⇒ Resource

  Update a todolist to change name and description.

Instance Method Details

#create_todolist(todoset, name, description = '') ⇒ Resource

Create a todolist within the given todoset

Examples:

client.create_todolist(todoset, 'Launch', "<div><em>Finish it!</em></div>")

Parameters:

• todoset (Resource) —

  the parent todoset resource

• name (String) —

  the name of the new todolist

• description (String) (defaults to: '') —

  an optional description for the todolist

Returns:

• (Resource)

Raises:

• (Error::InvalidParameter) —

  if todolists_url field in todoset param is not a valid basecamp url

See Also:

• https://github.com/basecamp/bc3-api/blob/master/sections/todolists.md#create-a-to-do-list

# File 'lib/camper/api/todolists.rb', line 50

def create_todolist(todoset, name, description = '')
  body = { name: name, description: description }

  post(todoset.todolists_url, body: body, override_path: true)
end

#todolist(todoset, id) ⇒ Resource

Get a todolist with a given id

Examples:

client.todolist(todoset, '2345')

Parameters:

• todoset (Resource) —

  the parent todoset resource

• id (Integer, String) —

  the id of the todolist to get

Returns:

• (Resource)

See Also:

• https://github.com/basecamp/bc3-api/blob/master/sections/todolists.md#get-a-to-do-list

# File 'lib/camper/api/todolists.rb', line 34

def todolist(todoset, id)
  get("/buckets/#{todoset.bucket.id}/todolists/#{id}")
end

#todolists(todoset, options = {}) ⇒ PaginatedResponse<Resource>

Get the todolists associated with the todoset

Examples:

client.todolists(todoset)

client.todolists(todoset, status: 'archived')

Parameters:

• todoset (Resource) —

  the parent todoset resource

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

  extra options to filter the list of todolist

Returns:

• (PaginatedResponse<Resource>)

Raises:

• (Error::InvalidParameter) —

  if todolists_url field in todoset param is not a valid basecamp url

See Also:

• https://github.com/basecamp/bc3-api/blob/master/sections/todolists.md#get-to-do-lists

# File 'lib/camper/api/todolists.rb', line 21

def todolists(todoset, options = {})
  get(todoset.todolists_url, query: options, override_path: true)
end

#trash_todolist(todolist) ⇒ Object

Trash a todolist

it calls the trash_recording endpoint under the hood

Examples:

client.trash_todolist(todolist)

Parameters:

• todolist (Resource) —

  the todolist to be trashed

Raises:

• (Error::InvalidParameter) —

  if the type field in todolist param is not an allowed type in the recording API

See Also:

• https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md#trash-a-recording

# File 'lib/camper/api/todolists.rb', line 90

def trash_todolist(todolist)
  trash_recording(todolist)
end

#update_todolist(todolist, name, description = nil) ⇒ Resource

Update a todolist to change name and description

Examples:

client.update_todolist(todolist, 'Launch')

client.update_todolist(todolist, 'Launch', "<div><em>Finish it!</em></div>")

client.update_todolist(todolist, 'Launch', '')

Parameters:

• todolist (Resource) —

  the todolist resource to update

• name (String) —

  the new name of the todolist

• description (String) (defaults to: nil) —

  a new optional description for the todolist. If not specified, it will be set to the current description value

Returns:

• (Resource)

Raises:

• (Error::InvalidParameter) —

  if url field in todolist param is not a valid basecamp url

See Also:

• https://github.com/basecamp/bc3-api/blob/master/sections/todolists.md#update-a-to-do-list

# File 'lib/camper/api/todolists.rb', line 73

def update_todolist(todolist, name, description = nil)
  body = { name: name }
  body[:description] = description.nil? ? todolist.description : description

  put(todolist.url, body: body, override_path: true)
end