Product Template methods: update, delete
The Product Template Verbs update, delete as typed SDK methods, with inputs, result, refusals and an example.
Reference for Product Template, one group of Product Template methods.
ProductTemplate.update
Changes the given properties of a Product Template. Verb page.
interface ProductTemplateVerbs {
update(input: ProductTemplateUpdateInput, options?: SB.CallOptions): SB.Call<ProductTemplate>
}Emits ProductTemplate.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Product Template. |
slug | string | The page path under /. | |
kind | string | The abstract Product: data, software, agent, or service. | |
supply | string | Who supplies the work: digital, which is unlimited, or human, which is recruited and credentialed. | |
worker | string | Who does the work: agents, humans, or agents-and-humans. | |
buyer | string | Who buys: human, agent, or human-or-agent. | |
earningModel | string | How it earns: subscription, usage, commerce, marketplace, or directory. | |
assurance | text | What the buyer can rely on, in one sentence. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
productTemplate | Product Template | required | The Product Template. |
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 productTemplate = await $.ProductTemplate.update({ id: 'ptpl_mLTPhHFQYD', slug: 'leaseline' })ProductTemplate.delete
Deletes a Product Template: a soft delete that keeps its history, undone by Thing.restore. Verb page.
interface ProductTemplateVerbs {
delete(input: ProductTemplateDeleteInput, options?: SB.CallOptions): SB.Call<ProductTemplate>
}Emits ProductTemplate.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Product Template. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
productTemplate | Product Template | required | The Product Template. |
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 productTemplate = await $.ProductTemplate.delete({ id: 'ptpl_mLTPhHFQYD' })