A Python client library for Workstreams.ai
Project description
workstreams
A Workstreams Python Client Library
For an overview of the Workstream API, click here.
Requirements
- Python >= 3.6
- Requests >= 2.19.0
Getting started
pip install workstreams
workstreams
is very simple to use -- take a look at the below example:
from workstreams import WorkstreamsClient
workstreams = WorkstreamsClient('your token')
workstreams.tasks.create(team_id='T3T7BFHGV', channel_id='C3T7D66J1', ws_user_id='U3T716H3N', data={
'title': 'test task',
'labels': [
'init-labelid123'
],
'dueDate': '2018-03-07T11:46:17Z',
'assignee': 'U3T716H3N'
})
Tasks Resource
Note: ws_user_id
must always be provided for app tokens.
Available methods:
create(team_id, channel_id, data, ws_user_id=None)
- Creates a taskupdate(task_id, data, ws_user_id=None)
- Updates a taskfetch(task_id, ws_user_id=None)
- Fetch a single taskfetch_user_tasks(team_id, user_id, ws_user_id=None)
- Fetch tasks for a single userfetch_tasks_for_users(team_id, user_ids, ws_user_id=None)
- Fetch tasks for multiple users- Example:
fetch_tasks_for_users(team_id='T3T7BFHGV', user_ids=['U123456', 'U123457', 'U123458'], ws_user_id=None)
- Example:
fetch_tasks_for_channels(team_id, channel_ids)
- Fetch all tasks for multiple channels- Example:
fetch_tasks_for_channels(team_id='T3T7BFHGV', channel_ids=['C3T7D66J1', 'C3T7D66J2'], ws_user_id=None)
- Example:
fetch_changed_tasks_for_channels(team_id, channel_ids, timestamp, ws_user_id=None)
- Fetch all tasks for multiple channels which changed since given timestampfetch_archived_tasks_for_channels(team_id, channel_ids, ws_user_id=None)
- Fetch all archived tasks for multiple channelsarchive_tasks(task_ids, ws_user_id=None)
- Archive multiple tasksrestore_tasks(task_ids, ws_user_id=None)
- Restore multiple tasks
Contributions
TBD
Bug Reports
TBD
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
workstreams-1.0.4.tar.gz
(3.6 kB
view hashes)
Built Distribution
Close
Hashes for workstreams-1.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 47e5b670e86d9937d4dbba94b237eb9d9212453e552b2597603a0618f2e94bb9 |
|
MD5 | b486760b21f84264bddc0ebfcd4140ab |
|
BLAKE2b-256 | 3052ea4d5c067f97ea91c085c2936f578f6cb05234045aafb187a92eb3366d2d |