Integration programs: list, update, delete

Integration.list

Returns Integrations, newest first, one page at a time. Verb page.

Text

do: return await $.Integration.list(input)

Reads only: it emits no Event.

Inputs

Input	Type	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
`integrations`	list of Integration	required	One page of Integrations.

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

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Integration.list({ limit: 20 })"
  }
}

Changes the given properties of an Integration. Verb page.

Text

do: return await $.Integration.update(input)

Emits Integration.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Integration.
`acquired`	`string`		One of `owned`, `wrapped`, or `recruited`.
`terms`	`text`		The terms the Startup holds the right to use and resell it under.
`scope`	`string`		One of `studio`, `startup`, or `customer`.
`sync`	`string`		Which side leads a sync connector: `platform` or `provider`.
`mode`	`string`		How records move: `mirror` writes db.sb out to the outside tool; `import` turns edits there into Changes. db.sb is the record in both.
`venue`	`string`		The id of the ad, social or app-store venue the account is on, when it is on one.
`account`	`string`		The outside account’s own id, such as an ad account, a workspace or a repository.
`grants`	`string[]`		The outside permissions the account holder approved: the narrowest set its Verbs need.
`connectedBy`	Party		Who approved the connection; a Human’s own account is used only under that Human’s Mandate.
`environment`	`string`		A `test` Integration reaches only the upstream’s test account, as a Stripe test account does.
`expiresAt`	`datetime`		When access lapses unless refreshed.
`refreshedAt`	`datetime`		When the platform last renewed the outside token.
`lastError`	`string`		The error slug of the last failed call or refresh, cleared by the next success.
`cursor`	`string`		Where the last sync run stopped, so the next run reads only what changed.

Returns

Output	Type	Required	Description
`integration`	Integration	required	The Integration.

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

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Integration.update({ id: 'integration_alVwjQcmRy', scope: 'studio' })"
  }
}

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

Text

do: return await $.Integration.delete(input)

Emits Integration.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`integration`	Integration	required	The Integration.

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

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Integration.delete({ id: 'integration_alVwjQcmRy' })"
  }
}