new module:api/CategoriesApi(apiClient)
Constructs a new CategoriesApi.
Parameters:
| Name | Type | Description |
|---|---|---|
apiClient |
module:ApiClient | Optional API client implementation to use, default to module:ApiClient#instance if unspecified. |
- Source:
Methods
getCategoriesByID(id, opts) → {Promise}
When you use the URL template below, the server returns a category identified by its id; by default, the server also returns the first level of subcategories, but you can specify another level by setting the levels parameter. The server only returns online categories.
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
id |
String | The id of the requested category. |
|||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with data of type module:models/Category
- Type
- Promise
getCategoriesByIDs(ids, opts) → {Promise}
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
ids |
Array.<String> | ||||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with data of type module:models/CategoryResult
- Type
- Promise
getCategoriesByIDsWithHttpInfo(ids, opts) → {Promise}
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
ids |
Array.<String> | ||||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with an object containing data of type module:models/CategoryResult and HTTP response
- Type
- Promise
getCategoriesByIDWithHttpInfo(id, opts) → {Promise}
When you use the URL template below, the server returns a category identified by its id; by default, the server also returns the first level of subcategories, but you can specify another level by setting the levels parameter. The server only returns online categories.
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
id |
String | The id of the requested category. |
|||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with an object containing data of type module:models/Category and HTTP response
- Type
- Promise