Availability methods: create, get, list
The Availability Verbs create, get, list as typed SDK methods, with inputs, result, refusals and an example.
Reference for Availability, one group of Availability methods.
Availability.create
Creates an Availability. Verb page.
interface AvailabilityVerbs {
create(input: AvailabilityCreateInput, options?: SB.CallOptions): SB.Call<Availability>
}Emits Availability.created.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
worker | Worker | required | Who is booked: a Human, or an Agent that takes calls. |
hours | json | required | Open hours by weekday, in its time zone. |
timezone | string | required | An IANA time zone. |
calendars | string[] | Connected calendars whose busy times it subtracts. | |
buffer | integer | Minutes kept free before and after each Meeting. | |
notice | integer | The fewest hours ahead a Meeting can be booked. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
availability | Availability | required | The Availability. |
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 availability = await $.Availability.create({ worker: 'worker_whZFpOKWIV', hours: { mon: ['09:Availability.get
Returns one Availability by id. Verb page.
interface AvailabilityVerbs {
get(input: AvailabilityGetInput, options?: SB.CallOptions): SB.Call<Availability>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Availability. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
availability | Availability | required | The Availability. |
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 availability = await $.Availability.get({ id: 'availability_8Zj0a7vvRl' })Availability.list
Returns Availabilities, newest first, one page at a time. Verb page.
interface AvailabilityVerbs {
list(input?: AvailabilityListInput, options?: SB.CallOptions): SB.ListCall<Availability>
}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 |
|---|---|---|---|
availabilities | list of Availability | required | One page of Availabilities. |
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 availabilities = await $.Availability.list({ limit: 20 })