Skip to content

Commit

Permalink
Documents new visibility method with example usage
Browse files Browse the repository at this point in the history
  • Loading branch information
craigpaul committed Nov 22, 2019
1 parent aa2647f commit a123ee9
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -642,12 +642,16 @@ Set a filter which will tell the API to return time slots in the given timezone.

- `supporting(locales: string[])`

Set a filter which will tell the API to return time slots for users that support the given locales. _(not publically available yet)_
Set a filter which will tell the API to return time slots for users that support the given locales. _(not publicly available yet)_

- `visibility(visibility: number)`

Set a filter which will tell the API whether to return time slots belonging to all resources or just public resources. _(not publicly available yet)_

##### Example

```javascript
import { OpenApi } from 'coconut-open-api-js';
import { OpenApi, Visibilities } from 'coconut-open-api-js';

class TimeSlots {
constructor() {
Expand All @@ -663,6 +667,7 @@ class TimeSlots {
.between(start, end)
.in('America/Chicago')
.supporting(['en', 'fr', 'es'])
.visibility(Visibilities.ALL)
.get()
}
}
Expand Down

0 comments on commit a123ee9

Please sign in to comment.