Skip to content

Commit

Permalink
Adds documentation for location details endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
coconutcraig committed Aug 21, 2019
1 parent a9173c1 commit db73fdc
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,10 @@ Set a filter which will tell the API to return locations that have public user a

Set a filter which will tell the API to return locations where the supplied user identifier is assigned.

- `details(identifier: string)`

Retrieve a given location's details based on the given identifier. _(not publicly available yet)_

- `get()`

Send the API request using the pre-set filters.
Expand Down Expand Up @@ -335,6 +339,10 @@ class Locations {
this.api = new OpenApi();
}

async details(identifier) {
return await this.api.details(identifier);
}

async get({ page, limit, services, sortable, user }) {
return await this.api
.locations()
Expand Down

0 comments on commit db73fdc

Please sign in to comment.