new CategoriesAPI(rest)
This class is used to interact with Categories in TidyHQ.
Parameters:
| Name | Type | Description |
|---|---|---|
rest | Rest | The rest instance to use for requests. |
- Source
Methods
(async) getCategories(optionsopt) → {Promise.<TidyAPI_V1_Categories>}
Get a list of all categories.
Parameters:
| Name | Type | Attributes | Default | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options | object | <optional> | {} | Properties
|
- Source
Returns:
- The list of categories.
- Type:
- Promise.<TidyAPI_V1_Categories>