Availability methods: set
The Availability Verbs set as typed SDK methods, with inputs, result, refusals and an example.
Reference for Availability, one group of Availability methods.
Availability.set
Set records the weekly hours a Worker can be booked in and the calendars whose busy times it subtracts. Verb page.
interface AvailabilityVerbs {
set(input: AvailabilitySetInput, options?: SB.CallOptions): SB.Call<Availability>
}Emits Availability.set.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
worker | Worker | required | Who is booked. |
hours | json | required | Open hours by weekday. |
timezone | string | required | An IANA time zone. |
calendars | string[] | Connected calendars to subtract busy times from. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
availability | Availability | required | The Availability, replacing the Worker’s last one. |
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.set({ worker: 'worker_whZFpOKWIV', hours: { tue: ['09: