Constructor
new UsersResource(client)
Create a new Users resource
Parameters:
| Name | Type | Description |
|---|---|---|
client |
ApiClient | API client instance |
- Source:
Classes
Methods
(async) create(data) → {Promise.<Object>}
Create a new record
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | Record data |
- Source:
Returns:
- Created record with data and headers
- Type
- Promise.<Object>
(async) create(data) → {Promise.<Object>}
Create a new record
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | Record data |
- Source:
Returns:
- Created record with data and headers
- Type
- Promise.<Object>
(async) destroy(id) → {Promise.<Object>}
Delete a record by id
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | number | Record id |
- Source:
Returns:
- Deletion result with data and headers
- Type
- Promise.<Object>
(async) destroy(id) → {Promise.<Object>}
Delete a record by id
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | number | Record id |
- Source:
Returns:
- Deletion result with data and headers
- Type
- Promise.<Object>
find(criteria) → {QueryChain}
Starts a new query chain with the given criteria
Parameters:
| Name | Type | Description |
|---|---|---|
criteria |
Object | Filter criteria |
- Source:
Returns:
- Query chain for further operations
- Type
- QueryChain
find(criteria) → {QueryChain}
Starts a new query chain with the given criteria
Parameters:
| Name | Type | Description |
|---|---|---|
criteria |
Object | Filter criteria |
- Source:
Returns:
- Query chain for further operations
- Type
- QueryChain
findOne(id, populateopt) → {QueryChain|Promise.<Object>}
Find a single record by id
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
string | number | Record id |
|
populate |
string | Array.<string> |
<optional> |
Fields to populate |
- Source:
Returns:
- Query chain for further operations or found record with data and headers
- Type
- QueryChain | Promise.<Object>
findOne(id, populateopt) → {QueryChain|Promise.<Object>}
Find a single record by id
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
string | number | Record id |
|
populate |
string | Array.<string> |
<optional> |
Fields to populate |
- Source:
Returns:
- Query chain for further operations or found record with data and headers
- Type
- QueryChain | Promise.<Object>
(async) getUsersMe() → {Promise.<any>}
Get current user Return the details of the currently logged in user.
- Source:
Returns:
- Response with data and headers
- Type
- Promise.<any>
(async) getUsersMe() → {Promise.<any>}
Get current user Return the details of the currently logged in user.
- Source:
Returns:
- Response with data and headers
- Type
- Promise.<any>
(async) update(id, data) → {Promise.<Object>}
Update a record by id
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | number | Record id |
data |
Object | Update data |
- Source:
Returns:
- Updated record with data and headers
- Type
- Promise.<Object>
(async) update(id, data) → {Promise.<Object>}
Update a record by id
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | number | Record id |
data |
Object | Update data |
- Source:
Returns:
- Updated record with data and headers
- Type
- Promise.<Object>