Basecamp¶
-
class
basecamp.
Basecamp
(account_id, token_or_username, password=None)¶ Create a Basecamp service.
Variables: - account_id (int) – Your Basecamp account id.
- token_or_username (str) – Either an OAuth 2.0 token, or the username if you want to use Basic authentication.
- password (str) – Only used with the Basic authentication, leave this as None when using OAuth.
GlobalAttachments¶
-
Basecamp.
attachments
()¶ Return the resource corresponding to all attachments.
-
GlobalAttachments.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
GlobalAttachments.
delete
()¶ Delete this resource.
-
GlobalAttachments.
get
(page=None)¶ Fetch all resources.
Variables: page (int) – the page that will be return. If not indicated, first one is returned.
-
GlobalAttachments.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Access¶
-
Calendar.
access
(access_id)¶ Return the resource corresponding to a single access.
-
Access.
revoke
()¶ Delete this resource.
Accesses¶
-
Calendar.
accesses
()¶ Return the resource corresponding to all calendar accesses.
-
Accesses.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
Accesses.
grant
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
CalendarEvent¶
-
Calendar.
calendar_event
(calendar_event_id)¶ Return the resource corresponding to a single calendar event.
Comments¶
-
CalendarEvent.
comments
()¶ Return the resource corresponding to all comments.
-
Comments.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Comments.
delete
()¶ Delete this resource.
-
Comments.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
CalendarEvent.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
CalendarEvent.
delete
()¶ Delete this resource.
-
CalendarEvent.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
CalendarEvent.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
CalendarEvents¶
-
Calendar.
calendar_events
()¶ Return the resource corresponding to all calendar events.
-
CalendarEvents.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
CalendarEvents.
delete
()¶ Delete this resource.
-
CalendarEvents.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
CalendarEvents.
past
()¶
-
CalendarEvents.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Calendar.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Calendar.
delete
()¶ Delete this resource.
-
Calendar.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
Calendar.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Calendars¶
-
Basecamp.
calendars
()¶ Return the resource corresponding to all calendars.
-
Calendars.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Calendars.
delete
()¶ Delete this resource.
-
Calendars.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
Calendars.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
GlobalDocuments¶
-
Basecamp.
documents
()¶ Return the resource corresponding to all documents.
-
GlobalDocuments.
delete
()¶ Delete this resource.
-
GlobalDocuments.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
GlobalDocuments.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Events¶
-
Basecamp.
events
()¶ Return the resource corresponding to all events.
-
Events.
delete
()¶ Delete this resource.
-
Events.
get
(since, page=None)¶ Fetch all events.
Variables: - since (str) – a datetime.
- page (int) – the page that will be return. If not indicated, first one is returned.
-
Events.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
People¶
-
Basecamp.
people
()¶ Return the resource corresponding to all people.
-
People.
delete
()¶ Delete this resource.
-
People.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
Person, CurrentPerson¶
-
Basecamp.
person
(person_id=None)¶ Return the resource corresponding to a single person. If person_id is None, current person will be returned.
AssignedTodos¶
-
Person.
assigned_todos
()¶ Return the resource corresponding to all assigned todos.
-
AssignedTodos.
delete
()¶ Delete this resource.
-
AssignedTodos.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
AssignedTodos.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Events¶
-
Person.
events
()¶ Return the resource corresponding to all events.
-
Events.
delete
() Delete this resource.
-
Events.
get
(since, page=None) Fetch all events.
Variables: - since (str) – a datetime.
- page (int) – the page that will be return. If not indicated, first one is returned.
-
Events.
update
(obj) Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Person.
delete
()¶ Delete this resource.
-
Person.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
CurrentPerson.
get
()¶
Access¶
-
Project.
access
(access_id)¶ Return the resource corresponding to a single access.
-
Access.
revoke
() Delete this resource.
Accesses¶
-
Project.
accesses
()¶ Return the resource corresponding to all project accesses.
-
Accesses.
get
() For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
Accesses.
grant
(obj) Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
Attachments¶
-
Project.
attachments
()¶ Return the resource corresponding to all attachments.
-
Attachments.
delete
()¶ Delete this resource.
-
Attachments.
get
(page=None)¶ Fetch all resources.
Variables: page (int) – the page that will be return. If not indicated, first one is returned.
-
Attachments.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
CalendarEvent¶
-
Project.
calendar_event
(calendar_event_id)¶ Return the resource corresponding to a single calendar event.
Comments¶
-
CalendarEvent.
comments
() Return the resource corresponding to all comments.
-
Comments.
create
(obj) Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Comments.
delete
() Delete this resource.
-
Comments.
update
(obj) Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
CalendarEvent.
create
(obj) Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
CalendarEvent.
delete
() Delete this resource.
-
CalendarEvent.
get
() For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
CalendarEvent.
update
(obj) Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
CalendarEvents¶
-
Project.
calendar_events
()¶ Return the resource corresponding to all calendar events.
-
CalendarEvents.
create
(obj) Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
CalendarEvents.
delete
() Delete this resource.
-
CalendarEvents.
get
() For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
CalendarEvents.
past
()
-
CalendarEvents.
update
(obj) Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Comment¶
-
Project.
comment
(comment_id)¶ Return the resource corresponding to a single comment.
-
Comment.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Comment.
delete
()¶ Delete this resource.
Comments¶
-
Document.
comments
()¶ Return the resource corresponding to all comments.
-
Comments.
create
(obj) Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Comments.
delete
() Delete this resource.
-
Comments.
update
(obj) Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Document.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Document.
delete
()¶ Delete this resource.
-
Document.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
Document.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Documents¶
-
Project.
documents
()¶ Return the resource corresponding to all documents.
-
Documents.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Documents.
delete
()¶ Delete this resource.
-
Documents.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
Documents.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Events¶
-
Project.
events
()¶ Return the resource corresponding to all events.
-
Events.
delete
() Delete this resource.
-
Events.
get
(since, page=None) Fetch all events.
Variables: - since (str) – a datetime.
- page (int) – the page that will be return. If not indicated, first one is returned.
-
Events.
update
(obj) Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Comments¶
-
Message.
comments
()¶ Return the resource corresponding to all comments.
-
Comments.
create
(obj) Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Comments.
delete
() Delete this resource.
-
Comments.
update
(obj) Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Message.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Message.
delete
()¶ Delete this resource.
-
Message.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
Message.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Messages¶
-
Project.
messages
()¶ Return the resource corresponding to all project messages.
-
Messages.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Messages.
delete
()¶ Delete this resource.
-
Messages.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Comments¶
-
Todo.
comments
()¶ Return the resource corresponding to all comments.
-
Comments.
create
(obj) Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Comments.
delete
() Delete this resource.
-
Comments.
update
(obj) Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Todo.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Todo.
delete
()¶ Delete this resource.
-
Todo.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
Todo.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Todos¶
-
Todolist.
todos
()¶ Return the resource corresponding to all todos.
-
Todos.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Todos.
delete
()¶ Delete this resource.
-
Todos.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Todolist.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Todolist.
delete
()¶ Delete this resource.
-
Todolist.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
Todolist.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Todolists¶
-
Project.
todolists
()¶ Return the resource corresponding to all todolists.
-
Todolists.
completed
()¶
-
Todolists.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Todolists.
delete
()¶ Delete this resource.
-
Todolists.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
Todolists.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
ProjectTopics¶
-
Project.
topics
()¶ Return the resource corresponding to all project topics.
-
ProjectTopics.
delete
()¶ Delete this resource.
-
ProjectTopics.
get
(page=None)¶ Fetch all topics.
Variables: page (int) – the page that will be return. If not indicated, first one is returned.
-
ProjectTopics.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Comments¶
-
Upload.
comments
()¶ Return the resource corresponding to all comments.
-
Comments.
create
(obj) Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Comments.
delete
() Delete this resource.
-
Comments.
update
(obj) Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Upload.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Upload.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
Uploads¶
-
Project.
uploads
()¶ Return the resource corresponding to all uploads.
-
Uploads.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Uploads.
delete
()¶ Delete this resource.
-
Uploads.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Project.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Project.
delete
()¶ Delete this resource.
-
Project.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
Project.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Projects¶
-
Basecamp.
projects
()¶ Return the resource corresponding to all projects.
-
Projects.
archived
()¶
-
Projects.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Projects.
delete
()¶ Delete this resource.
-
Projects.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
Projects.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
GlobalTodolists¶
-
Basecamp.
todolists
()¶ Return the resource corresponding to all todolists.
-
GlobalTodolists.
completed
()¶
-
GlobalTodolists.
delete
()¶ Delete this resource.
-
GlobalTodolists.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
GlobalTodolists.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Topics¶
-
Basecamp.
topics
()¶ Return the resource corresponding to all topics.
-
Topics.
delete
()¶ Delete this resource.
-
Topics.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
Topics.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.