class Basecamp3::Person

A model for Basecamp's Message Person

{github.com/basecamp/bc3-api/blob/master/sections/people.md#people For more information, see the official Basecamp3 API documentation for People}

Attributes

admin[RW]
avatar_url[RW]
bio[RW]
created_at[RW]
email_address[RW]
id[RW]
name[RW]
owner[RW]
time_zone[RW]
title[RW]
updated_at[RW]

Public Class Methods

all() click to toggle source

Returns a list of all people visible to the current user.

@return [Array<Basecamp3::Person>]

# File lib/basecamp3/models/person.rb, line 20
def self.all
  Basecamp3.request.get("/people", {}, Basecamp3::Person)
end
find(id) click to toggle source

Returns the person.

@param [Integer] id the id of the person

@return [Basecamp3::Person]

# File lib/basecamp3/models/person.rb, line 36
def self.find(id)
  Basecamp3.request.get("/people/#{id}", {}, Basecamp3::Person)
end
me() click to toggle source

Returns the current user's personal info..

@return [Basecamp3::Person]

# File lib/basecamp3/models/person.rb, line 43
def self.me
  Basecamp3.request.get("/my/profile", {}, Basecamp3::Person)
end
pingable() click to toggle source

Returns a list of all people who can be pinged.

@return [Array<Basecamp3::Person>]

# File lib/basecamp3/models/person.rb, line 27
def self.pingable
  Basecamp3.request.get("/circles/people", {}, Basecamp3::Person)
end