Meeting Type methods: create, get, list
The Meeting Type Verbs create, get, list as typed SDK methods, with inputs, result, refusals and an example.
Reference for Meeting Type, one group of Meeting Type methods.
MeetingType.create
Creates a Meeting Type. Verb page.
interface MeetingTypeVerbs {
create(input: MeetingTypeCreateInput, options?: SB.CallOptions): SB.Call<MeetingType>
}Emits MeetingType.created.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
name | string | required | What the booking page calls it, such as Intro call. |
duration | integer | required | Minutes each Meeting runs. |
medium | string | required | How people meet: video, phone or inPerson. |
availability | Availability | required | The hours it books into. |
url | url | The booking link, served on the Startup’s Domain once published. | |
questions | string[] | What the booker answers before the time is held. | |
offer | Offer | The Offer a paid booking accepts first, with its deposit and no-show rule. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
meetingType | Meeting Type | required | The Meeting Type. |
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 meetingType = await $.MeetingType.create({ name: 'Problem interview', duration: 20, medium: 'video', availability: 'availability_8Zj0a7vvRl' })MeetingType.get
Returns one Meeting Type by id. Verb page.
interface MeetingTypeVerbs {
get(input: MeetingTypeGetInput, options?: SB.CallOptions): SB.Call<MeetingType>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Meeting Type. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
meetingType | Meeting Type | required | The Meeting Type. |
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 meetingType = await $.MeetingType.get({ id: 'mtgtype_qw2d5yGLVN' })MeetingType.list
Returns Meeting Types, newest first, one page at a time. Verb page.
interface MeetingTypeVerbs {
list(input?: MeetingTypeListInput, options?: SB.CallOptions): SB.ListCall<MeetingType>
}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 |
|---|---|---|---|
meetingTypes | list of Meeting Type | required | One page of Meeting Types. |
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 meetingTypes = await $.MeetingType.list({ limit: 20 })