Relationship methods: update, delete

Relationship.update

Changes the given properties of a Relationship. Verb page.

TypeScript

interface RelationshipVerbs {
  update(input: RelationshipUpdateInput, options?: SB.CallOptions): SB.Call<Relationship>
}

Emits Relationship.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Relationship.
`predicate`	`string`		The name read from the source, such as `makes`.
`inverse`	`string`		The name read from the target, such as `madeBy`.
`provenance`	`string`		Who asserted it: `Stated`, `Ratified`, `Inferred`, or `Observed`.

Returns

Output	Type	Required	Description
`relationship`	Relationship	required	The Relationship.

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

TypeScript

import { $ } from 'startup-builder'

const relationship = await $.Relationship.update({ id: 'relationship_iUVcHztTJh', provenance: 'Stated' })

Deletes a Relationship: a soft delete that keeps its history, undone by Thing.restore. Verb page.

TypeScript

interface RelationshipVerbs {
  delete(input: RelationshipDeleteInput, options?: SB.CallOptions): SB.Call<Relationship>
}

Emits Relationship.deleted.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Relationship.

Returns

Output	Type	Required	Description
`relationship`	Relationship	required	The Relationship.

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

TypeScript

import { $ } from 'startup-builder'

const relationship = await $.Relationship.delete({ id: 'relationship_iUVcHztTJh' })