Constructor
new PeopleResource(client)
Create a new People 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) deletePeopleId() → {Promise.<person>}
Delete Person (destroy) Delete the Person record with the specified ID.
- Source:
Returns:
- Response with data and headers
- Type
- Promise.<person>
(async) deletePeopleId() → {Promise.<person>}
Delete Person (destroy) Delete the Person record with the specified ID.
- Source:
Returns:
- Response with data and headers
- Type
- Promise.<person>
(async) deletePeopleIdAssociationChildid(association, childid) → {Promise.<person>}
Remove from for Person Remove a foreign record from one of this Person record's collections.
Parameters:
| Name | Type | Description |
|---|---|---|
association |
string | Path parameter |
childid |
string | Path parameter |
- Source:
Returns:
- Response with data and headers
- Type
- Promise.<person>
(async) deletePeopleIdAssociationChildid(association, childid) → {Promise.<person>}
Remove from for Person Remove a foreign record from one of this Person record's collections.
Parameters:
| Name | Type | Description |
|---|---|---|
association |
string | Path parameter |
childid |
string | Path parameter |
- Source:
Returns:
- Response with data and headers
- Type
- Promise.<person>
(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) getPeople(queryopt) → {Promise.<Array.<person>>}
List Person (find where) Find a list of Person records that match the specified criteria.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
query |
Object |
<optional> |
Query parameters |
- Source:
Returns:
- Response with data and headers
- Type
- Promise.<Array.<person>>
(async) getPeople(queryopt) → {Promise.<Array.<person>>}
List Person (find where) Find a list of Person records that match the specified criteria.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
query |
Object |
<optional> |
Query parameters |
- Source:
Returns:
- Response with data and headers
- Type
- Promise.<Array.<person>>
(async) getPeopleCount(queryopt) → {Promise.<any>}
Count records Count the number of records that match the specified criteria.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
query |
Object |
<optional> |
Query parameters |
- Source:
Returns:
- Response with data and headers
- Type
- Promise.<any>
(async) getPeopleCount(queryopt) → {Promise.<any>}
Count records Count the number of records that match the specified criteria.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
query |
Object |
<optional> |
Query parameters |
- Source:
Returns:
- Response with data and headers
- Type
- Promise.<any>
(async) getPeopleId(queryopt) → {Promise.<person>}
Get Person (find one) Look up the Person record with the specified ID.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
query |
Object |
<optional> |
Query parameters |
- Source:
Returns:
- Response with data and headers
- Type
- Promise.<person>
(async) getPeopleId(queryopt) → {Promise.<person>}
Get Person (find one) Look up the Person record with the specified ID.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
query |
Object |
<optional> |
Query parameters |
- Source:
Returns:
- Response with data and headers
- Type
- Promise.<person>
(async) getPeopleIdAssociation(association, queryopt) → {Promise.<Array.<any>>}
Populate association for Person Populate and return foreign record(s) for the given association of this Person record.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
association |
string | Path parameter |
|
query |
Object |
<optional> |
Query parameters |
- Source:
Returns:
- Response with data and headers
- Type
- Promise.<Array.<any>>
(async) getPeopleIdAssociation(association, queryopt) → {Promise.<Array.<any>>}
Populate association for Person Populate and return foreign record(s) for the given association of this Person record.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
association |
string | Path parameter |
|
query |
Object |
<optional> |
Query parameters |
- Source:
Returns:
- Response with data and headers
- Type
- Promise.<Array.<any>>
(async) getPeopleSum(queryopt) → {Promise.<any>}
Sum field values Calculate the sum of a specified numeric field across filtered records.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
query |
Object |
<optional> |
Query parameters |
- Source:
Returns:
- Response with data and headers
- Type
- Promise.<any>
(async) getPeopleSum(queryopt) → {Promise.<any>}
Sum field values Calculate the sum of a specified numeric field across filtered records.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
query |
Object |
<optional> |
Query parameters |
- Source:
Returns:
- Response with data and headers
- Type
- Promise.<any>
(async) patchPeopleId(data) → {Promise.<person>}
Update Person Update an existing Person record.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | Request body |
- Source:
Returns:
- Response with data and headers
- Type
- Promise.<person>
(async) patchPeopleId(data) → {Promise.<person>}
Update Person Update an existing Person record.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | Request body |
- Source:
Returns:
- Response with data and headers
- Type
- Promise.<person>
(async) postPeople(data) → {Promise.<person>}
Create Person Create a new Person record.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | Request body |
- Source:
Returns:
- Response with data and headers
- Type
- Promise.<person>
(async) postPeople(data) → {Promise.<person>}
Create Person Create a new Person record.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | Request body |
- Source:
Returns:
- Response with data and headers
- Type
- Promise.<person>
(async) putPeopleIdAssociation(association, data) → {Promise.<person>}
Replace for Person Replace all of the child records in one of this Person record's associations.
Parameters:
| Name | Type | Description |
|---|---|---|
association |
string | Path parameter |
data |
Object | Request body |
- Source:
Returns:
- Response with data and headers
- Type
- Promise.<person>
(async) putPeopleIdAssociation(association, data) → {Promise.<person>}
Replace for Person Replace all of the child records in one of this Person record's associations.
Parameters:
| Name | Type | Description |
|---|---|---|
association |
string | Path parameter |
data |
Object | Request body |
- Source:
Returns:
- Response with data and headers
- Type
- Promise.<person>
(async) putPeopleIdAssociationChildid(association, childid) → {Promise.<person>}
Add to for Person Add a foreign record to one of this Person record's collections.
Parameters:
| Name | Type | Description |
|---|---|---|
association |
string | Path parameter |
childid |
string | Path parameter |
- Source:
Returns:
- Response with data and headers
- Type
- Promise.<person>
(async) putPeopleIdAssociationChildid(association, childid) → {Promise.<person>}
Add to for Person Add a foreign record to one of this Person record's collections.
Parameters:
| Name | Type | Description |
|---|---|---|
association |
string | Path parameter |
childid |
string | Path parameter |
- Source:
Returns:
- Response with data and headers
- Type
- Promise.<person>
(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>