Download the PHP package mikkelson/clubhouse-php without Composer
On this page you can find all versions of the php package mikkelson/clubhouse-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package clubhouse-php
Clubhouse.io REST API php Wrapper
Warning Shortcut has re-branded and updated their API to version 3, as such this repo is no longer maintained. See the new Shortcut PHP repo here.
This is a lightweight php wrapper for the Clubhouse.io REST version 1 API.
Installation
To install with Composer:
After the package installation completes, use the autoloader provided by Composer.
Or, without Composer:
Download this repo and include Clubhouse.php
Usage & Setup
Load the package namespace.
Before making useful calls to Clubhouse, create an instance of Clubhouse
, providing your Clubhouse API token, which you can get here.
Epics
Get
Get Epic returns information about the selected Epic.
Update
Update Epic can be used to update numerous fields in the Epic. See complete list of available fields.
Delete
Deletes an Epic
List
List Epics returns a list of all Epics and their attributes.
Create
Create Epic allows you to create a new Epic in Clubhouse. See complete list of available fields.
Files
Get
Get File returns information about the selected File.
Update
Update File can used to update the properties of a file uploaded to Clubhouse. See complete list of available fields.
Delete
Delete File can be used to delete any previously attached File.
List
List Files returns a list of all Files and related attributes in your Clubhouse.
Labels
Create
Create Label allows you to create a new Label in Clubhouse.
Update
Update Label allows you to replace a Label name with another name. If you try to name a Label something that already exists, you will receive a 422 response.
Delete
Delete Label can be used to delete any Label.
List
List Labels returns a list of all Labels and their attributes.
Linked-Files
Get
Get File returns information about the selected Linked File.
Create
Create Linked File allows you to create a new Linked File in Clubhouse. See complete list of available fields
Update
Updated Linked File allows you to update properties of a previously attached Linked-File. See complete list of available fields
Delete
Delete Linked File can be used to delete any previously attached Linked-File.
List
List Linked Files returns a list of all Linked-Files and their attributes.
Projects
Get
Get Project returns information about the selected Project.
Create
Create Project is used to create a new Clubhouse Project. See complete list of available fields
Update
Update Project can be used to change properties of a Project. See complete list of available fields
Delete
Delete Project can be used to delete a Project. Projects can only be deleted if all associated Stories are moved or deleted. In the case that the Project cannot be deleted, you will receive a 422 response.
List
List Projects returns a list of all Projects and their attributes.
Story-Links
Create
Story links allow you create semantic relationships between two stories. Relationship types are relates to, blocks / blocked by, and duplicates / is duplicated by. The format is subject -> link -> object, or for example “story 5 blocks story 6”. See complete list of available fields
Get
Returns information about the selected Story Link.
Delete
Delete Story-Link can be used to delete any Story Link.
Stories
Search
Search Stories lets you search Stories based on desired parameters. While all parameters are optional, you must include at least one parameter in order to receive a response.
See complete list of available search parameters
Create
Create Story is used to add a new story to your Clubhouse. See complete list of available fields
Get
Get Story returns information about a chosen Story.
Update
Update Story can be used to change properties of a Story. See complete list of available fields
Delete
Deletes a Story.
Users
List
List Users returns information about users in the organization.
Get
Returns information about a User.
Workflows
List
List Workflows returns a list containing the single Workflow in the organization and its attributes.