Enrollment methods: create, get, list

Reference for Enrollment, one group of Enrollment methods.

Enrollment.create

Creates an Enrollment. Verb page.

TypeScript

interface EnrollmentVerbs {
  create(input: EnrollmentCreateInput, options?: SB.CallOptions): SB.Call<Enrollment>
}

Emits Enrollment.created.

Inputs

Input	Type	Required	Description
`step`	`string`	required	The Sequence step the person is on.
`nextAt`	`datetime`		When the next step fires; empty while paused or exited.
`branches`	`string[]`		The branches taken so far, in order.
`exitReason`	`string`		Why the run ended.
`contact`	Contact		The Contact this run belongs to; pausing one Contact’s nurture pauses this Enrollment.
`sequence`	Sequence		The Sequence whose steps this Enrollment walks, one step at a time.

Returns

Output	Type	Required	Description
`enrollment`	Enrollment	required	The Enrollment.

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 enrollment = await $.Enrollment.create({ step: 'Example step' })

Returns one Enrollment by id. Verb page.

TypeScript

interface EnrollmentVerbs {
  get(input: EnrollmentGetInput, options?: SB.CallOptions): SB.Call<Enrollment>
}

Reads only: it emits no Event.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Enrollment.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Returns

Output	Type	Required	Description
`enrollment`	Enrollment	required	The Enrollment.

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 enrollment = await $.Enrollment.get({ id: 'enrollment_t2LKaLorKn' })

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

TypeScript

interface EnrollmentVerbs {
  list(input?: EnrollmentListInput, options?: SB.CallOptions): SB.ListCall<Enrollment>
}

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
`enrollments`	list of Enrollment	required	One page of Enrollments.

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 enrollments = await $.Enrollment.list({ limit: 20 })