Documents new location resource method. Adds forgotten reference to m…

…ethod on interface
coconutcalendar · Aug 19, 2019 · cd2b0f1 · cd2b0f1
1 parent 7235039
commit cd2b0f1
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -293,6 +293,10 @@ Send the API request using the pre-set filters.
 
 Set a filter which will tell the API to return locations that are specifically invite only.
 
+- `located(details: LocatableLocationParameters)`
+
+Set certain filters which will tell the API to return locations that match the locatable details you provide.
+
 - `on(page: number)`
 
 Set the page offset which you want to view.

diff --git a/src/resources/location.ts b/src/resources/location.ts
@@ -40,6 +40,8 @@ export interface LocationResource extends Pageable, ConditionalResource {
 
   invitable(): this;
 
+  located(details: LocatableLocationParameters): this;
+
   physical(): this;
 
   providing(services: number | number[] | string | string[]): this;