Skill methods
Every Skill Verb as a typed SDK method, with its inputs, result, refusals and an example.
Reference for Skill.
| Noun | System | Run by |
|---|---|---|
| Skill | Workforce | People Lead |
Skill.create
Creates a Skill. Verb page.
interface SkillVerbs {
create(input?: SkillCreateInput, options?: SB.CallOptions): SB.Call<Skill>
}Emits Skill.created.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
level | integer | How well the Worker performs it. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
skill | Skill | required | The Skill. |
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 skill = await $.Skill.create({ level: 1 })Skill.get
Returns one Skill by id. Verb page.
interface SkillVerbs {
get(input: SkillGetInput, options?: SB.CallOptions): SB.Call<Skill>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Skill. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
skill | Skill | required | The Skill. |
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 skill = await $.Skill.get({ id: 'skill_xBqG4zTxBA' })Skill.list
Returns Skills, newest first, one page at a time. Verb page.
interface SkillVerbs {
list(input?: SkillListInput, options?: SB.CallOptions): SB.ListCall<Skill>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
limit | integer | At most this many records, up to 100. The default is 20. | |
after | string | The cursor from the previous page. | |
where | string | A filter over the properties, such as paidAt = null and total.amount > 500. | |
sort | string | Properties to sort by, comma-separated; a leading minus sorts descending. | |
total | boolean | True adds the match count as meta.total, exact up to 10,000 matches and estimated above. | |
facets | string | Properties to count by value, comma-separated, returned as meta.facets. | |
fields | string | Properties to return on each record, comma-separated; $id and $type always return. | |
include | string | Related records to embed in place of their URLs, comma-separated. | |
depth | integer | How many levels of related records to embed. The default is 1. | |
q | string | Words to match across the text properties, ranked by relevance. | |
match | string | Ranks the search by words, or meaning; words is the default. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
skills | list of Skill | required | One page of Skills. |
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 skills = await $.Skill.list({ limit: 20 })Skill.update
Changes the given properties of a Skill. Verb page.
interface SkillVerbs {
update(input: SkillUpdateInput, options?: SB.CallOptions): SB.Call<Skill>
}Emits Skill.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Skill. |
level | integer | How well the Worker performs it. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
skill | Skill | required | The Skill. |
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 skill = await $.Skill.update({ id: 'skill_xBqG4zTxBA', level: 1 })Skill.delete
Deletes a Skill: a soft delete that keeps its history, undone by Thing.restore. Verb page.
interface SkillVerbs {
delete(input: SkillDeleteInput, options?: SB.CallOptions): SB.Call<Skill>
}Emits Skill.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Skill. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
skill | Skill | required | The Skill. |
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 skill = await $.Skill.delete({ id: 'skill_xBqG4zTxBA' })