Api / Features
Method | Description |
---|---|
🔹 advance() | Advance feature |
🔹 create() | Create feature |
🔹 delete() | Delete feature |
🔹 list() | List features |
🔹 read() | Fetch feature |
🔹 update() | Update feature |
Getting started
// Place your API Key 👇 here
$sdk = new \Kronup\Sdk();
// API Call
$sdk->api()->features();
advance()
Advance a feature
#️⃣ Execute example in terminal
Request
PUT
/teams/{teamId}/channels/{channelId}/features/{featureId}
Type signature
(new \Kronup\Sdk())->api()->features()->advance(
string $team_id,
string $channel_id,
string $feature_id
): \Kronup\Model\Feature
Parameters
Name | Type | Description |
---|---|---|
$team_id | string | Team ID |
$channel_id | string | Channel ID |
$feature_id | string | Feature ID |
Return type
create()
Add a feature to planning
#️⃣ Execute example in terminal
Request
POST
/teams/{teamId}/channels/{channelId}/features
Type signature
(new \Kronup\Sdk())->api()->features()->create(
string $team_id,
string $channel_id,
\Kronup\Model\PayloadFeatureCreate $payload_feature_create
): \Kronup\Model\Feature
Parameters
Name | Type | Description |
---|---|---|
$team_id | string | Team ID |
$channel_id | string | Channel ID |
$payload_feature_create | \Kronup\Model\PayloadFeatureCreate |
Return type
delete()
Delete a feature from the flow
#️⃣ Execute example in terminal
Request
DELETE
/teams/{teamId}/channels/{channelId}/features/{featureId}
Type signature
(new \Kronup\Sdk())->api()->features()->delete(
string $team_id,
string $channel_id,
string $feature_id
): bool
Parameters
Name | Type | Description |
---|---|---|
$team_id | string | Team ID |
$channel_id | string | Channel ID |
$feature_id | string | Feature ID |
Return type
bool
list()
Get a list of feature models
#️⃣ Execute example in terminal
Request
GET
/teams/{teamId}/channels/{channelId}/features
Type signature
(new \Kronup\Sdk())->api()->features()->list(
string $team_id,
string $channel_id,
[ string $stage, ]
[ int $page_number = 1, ]
[ int $page_size = 500 ]
): \Kronup\Model\FeaturesList
Parameters
Name | Type | Description |
---|---|---|
$team_id | string | Team ID |
$channel_id | string | Channel ID |
$stage | string | Feature stage |
$page_number | int | [default to 1] |
$page_size | int | [default to 500] |
Return type
read()
Retrieve feature model
#️⃣ Execute example in terminal
Request
GET
/teams/{teamId}/channels/{channelId}/features/{featureId}
Type signature
(new \Kronup\Sdk())->api()->features()->read(
string $team_id,
string $channel_id,
string $feature_id
): \Kronup\Model\Feature
Parameters
Name | Type | Description |
---|---|---|
$team_id | string | Team ID |
$channel_id | string | Channel ID |
$feature_id | string | Feature ID |
Return type
update()
Update feature details
#️⃣ Execute example in terminal
Request
POST
/teams/{teamId}/channels/{channelId}/features/{featureId}
Type signature
(new \Kronup\Sdk())->api()->features()->update(
string $team_id,
string $channel_id,
string $feature_id,
\Kronup\Model\PayloadFeatureUpdate $payload_feature_update
): \Kronup\Model\Feature
Parameters
Name | Type | Description |
---|---|---|
$team_id | string | Team ID |
$channel_id | string | Channel ID |
$feature_id | string | Feature ID |
$payload_feature_update | \Kronup\Model\PayloadFeatureUpdate |