u
This commit is contained in:
40
API.categoryattributevalue.md
Normal file
40
API.categoryattributevalue.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# categoryattributevalue
|
||||
|
||||
This document is auto-generated from the JSDoc comments in `src/store` by running `npm run api-doc`.
|
||||
|
||||
## `categoryattributevalue.listByCategoryId`
|
||||
|
||||
*Source: `src/store/categoryattributevalue/listByCategoryId.js`*
|
||||
|
||||
Lists the attribute values assigned to a category by its ID.
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| `googleAuthId` | `number` | The id of the Google auth user. |
|
||||
| `categoryId` | `number` | The category ID. |
|
||||
| `[tx]` | `object` | Optional transaction. |
|
||||
|
||||
**Returns**
|
||||
|
||||
`Promise<Array<{id: number, categoryId: number, attributeId: number, attributeName: string, exclusive: boolean, attributeValueId: number, value: string, sort: number}>>`
|
||||
|
||||
## `categoryattributevalue.setByCategoryId`
|
||||
|
||||
*Source: `src/store/categoryattributevalue/setByCategoryId.js`*
|
||||
|
||||
Replaces all attribute values for a category by its ID. Validates company ownership and enforces the `exclusive` flag on attributes.
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| `googleAuthId` | `number` | The id of the Google auth user. |
|
||||
| `categoryId` | `number` | The category ID. |
|
||||
| `values` | `Array<number|{attributeValueId: number, sort?: number}>` | Attribute value IDs or items. |
|
||||
| `[tx]` | `object` | Optional transaction. |
|
||||
|
||||
**Returns**
|
||||
|
||||
`Promise<Array<{id: number, categoryId: number, attributeId: number, attributeName: string, exclusive: boolean, attributeValueId: number, value: string, sort: number}>>`
|
||||
Reference in New Issue
Block a user