u

API.articleproperty.md

@@ -0,0 +1,59 @@
+# articleproperty
+
+This document is auto-generated from the JSDoc comments in `src/store` by running `npm run api-doc`.
+
+## `articleproperty.delete`
+
+*Source: `src/store/articleproperty/delete.js`*
+
+Deletes a property from an article by SKU and propertyId.
+
+**Parameters**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| `googleAuthId` | `number` | The id of the Google auth user. |
+| `sku` | `string` | The article SKU. |
+| `propertyId` | `number` | The property id. |
+| `[tx]` | `object` | Optional transaction. |
+
+**Returns**
+
+`Promise<void>`
+
+## `articleproperty.listByArticleSku`
+
+*Source: `src/store/articleproperty/listByArticleSku.js`*
+
+Lists the properties of an article by its SKU.
+
+**Parameters**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| `googleAuthId` | `number` | The id of the Google auth user. |
+| `sku` | `string` | The article SKU. |
+| `[tx]` | `object` | Optional transaction. |
+
+**Returns**
+
+`Promise<Array<{id: number, articleId: number, propertyId: number, name: string, value: string, sort: number}>>`
+
+## `articleproperty.setByArticleSku`
+
+*Source: `src/store/articleproperty/setByArticleSku.js`*
+
+Replaces all properties for an article by its SKU.
+
+**Parameters**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| `googleAuthId` | `number` | The id of the Google auth user. |
+| `sku` | `string` | The article SKU. |
+| `properties` | `Array<{propertyId: number, value: string, sort?: number}>` | The properties to set. |
+| `[tx]` | `object` | Optional transaction. |
+
+**Returns**
+
+`Promise<Array<{id: number, articleId: number, propertyId: number, name: string, value: string, sort: number}>>`