Minimum Success Criteria methods: update, delete
The Minimum Success Criteria Verbs update, delete as typed SDK methods, with inputs, result, refusals and an example.
Reference for Minimum Success Criteria, one group of Minimum Success Criteria methods.
MinimumSuccessCriteria.update
Changes the given properties of a Minimum Success Criteria. Verb page.
interface MinimumSuccessCriteriaVerbs {
update(input: MinimumSuccessCriteriaUpdateInput, options?: SB.CallOptions): SB.Call<MinimumSuccessCriteria>
}Emits MinimumSuccessCriteria.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Minimum Success Criteria. |
objective | text | The qualitative outcome. | |
horizon | string | One of day, week, quarter, year, or three-years. | |
metric | Metric | The Metric the number is measured in. | |
value | number | The number to reach. | |
by | date | The date it must be reached. | |
fermi | json | The Price, rates and volumes that show the number is reachable. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
minimumSuccessCriteria | Minimum Success Criteria | required | The Minimum Success Criteria. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
import { $ } from 'startup-builder'
const minimumSuccessCriteria = await $.MinimumSuccessCriteria.update({ id: 'msc_3UF8zdSOyQ', metric: 'metric_GXFHAlK100' })MinimumSuccessCriteria.delete
Deletes a Minimum Success Criteria: a soft delete that keeps its history, undone by Thing.restore. Verb page.
interface MinimumSuccessCriteriaVerbs {
delete(input: MinimumSuccessCriteriaDeleteInput, options?: SB.CallOptions): SB.Call<MinimumSuccessCriteria>
}Emits MinimumSuccessCriteria.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Minimum Success Criteria. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
minimumSuccessCriteria | Minimum Success Criteria | required | The Minimum Success Criteria. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
import { $ } from 'startup-builder'
const minimumSuccessCriteria = await $.MinimumSuccessCriteria.delete({ id: 'msc_3UF8zdSOyQ' })