docs: expand input and output object types in API signatures
This commit is contained in:
seb
@@ -17,11 +17,11 @@ Creates a new delivery for the user's selected company with its lines. The deliv
|
||||
| `body.date` | `string` | The delivery date. |
|
||||
| `body.supplierId` | `number` | The id of the supplier. |
|
||||
| `[body.externalNumber]` | `string` | An external (supplier) reference number. |
|
||||
| `[body.lines]` | `Array<object>` | The delivery lines. |
|
||||
| `[body.lines]` | `Array<{sku?: string, name?: string, pu?: number, amount: number, net: number, rebate?: number, tax: number, comment?: string|null}>` | The delivery lines. |
|
||||
|
||||
**Returns**
|
||||
|
||||
`Promise<{id: number, number: string, type: string, entityId: number, externalNumber: string|null, date: string, lines: Array<object>}>` — The created delivery.
|
||||
`Promise<{id: number, number: string, type: string, entityId: number, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>` — The created delivery.
|
||||
|
||||
**Throws**
|
||||
|
||||
@@ -76,7 +76,7 @@ Returns a single delivery by its id within the user's selected company.
|
||||
|
||||
**Returns**
|
||||
|
||||
`Promise<{id: number, number: string, type: string, entityId: number, externalNumber: string|null, date: string, lines: Array<object>}>` — The delivery.
|
||||
`Promise<{id: number, number: string, type: string, entityId: number, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>` — The delivery.
|
||||
|
||||
**Throws**
|
||||
|
||||
@@ -129,11 +129,11 @@ Updates a delivery's header and/or lines.
|
||||
| `[patch.date]` | `string` | The new delivery date. |
|
||||
| `[patch.supplierId]` | `number` | The new supplier id. |
|
||||
| `[patch.externalNumber]` | `string` | The new external (supplier) reference number. |
|
||||
| `[patch.lines]` | `Array<object>` | The new delivery lines. |
|
||||
| `[patch.lines]` | `Array<{sku?: string, name?: string, pu?: number, amount: number, net: number, rebate?: number, tax: number, comment?: string|null}>` | The new delivery lines. |
|
||||
|
||||
**Returns**
|
||||
|
||||
`Promise<{id: number, number: string, type: string, entityId: number, externalNumber: string|null, date: string, lines: Array<object>}>` — The updated delivery.
|
||||
`Promise<{id: number, number: string, type: string, entityId: number, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>` — The updated delivery.
|
||||
|
||||
**Throws**
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@ Creates a new address for an entity.
|
||||
|
||||
**Returns**
|
||||
|
||||
`Promise<object>` — The created address.
|
||||
`Promise<{id: number, entityId: number, firstName: string|null, name: string|null, street: string|null, streetNumber: string|null, zip: string|null, city: string|null, county: string|null, addressType: string, sort: number}>` — The created address.
|
||||
|
||||
**Throws**
|
||||
|
||||
@@ -83,7 +83,7 @@ Lists the addresses of an entity.
|
||||
|
||||
**Returns**
|
||||
|
||||
`Promise<Array<object>>` — The addresses.
|
||||
`Promise<Array<{id: number, entityId: number, firstName: string|null, name: string|null, street: string|null, streetNumber: string|null, zip: string|null, city: string|null, county: string|null, addressType: string, sort: number}>>` — The addresses.
|
||||
|
||||
**Example**
|
||||
|
||||
@@ -106,10 +106,19 @@ Updates an address of an entity.
|
||||
| `entityId` | `number` | The id of the entity. |
|
||||
| `id` | `number` | The id of the address to update. |
|
||||
| `patch` | `object` | The update patch (any subset of address fields). |
|
||||
| `[patch.addressType]` | `string` | The address type. |
|
||||
| `[patch.firstName]` | `string` | The first name. |
|
||||
| `[patch.name]` | `string` | The name. |
|
||||
| `[patch.street]` | `string` | The street. |
|
||||
| `[patch.streetNumber]` | `string` | The street number. |
|
||||
| `[patch.zip]` | `string` | The zip code. |
|
||||
| `[patch.city]` | `string` | The city. |
|
||||
| `[patch.county]` | `string` | The county. |
|
||||
| `[patch.sort]` | `number` | The sort order. |
|
||||
|
||||
**Returns**
|
||||
|
||||
`Promise<object>` — The updated address.
|
||||
`Promise<{id: number, entityId: number, firstName: string|null, name: string|null, street: string|null, streetNumber: string|null, zip: string|null, city: string|null, county: string|null, addressType: string, sort: number}>` — The updated address.
|
||||
|
||||
**Throws**
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@ Attaches a file to an existing manifest.
|
||||
|
||||
**Returns**
|
||||
|
||||
`Promise<object>` — The created attachment record.
|
||||
`Promise<{id: number, manifestId: number, fileId: number, mimetype: string, name: string}>` — The created attachment record.
|
||||
|
||||
**Throws**
|
||||
|
||||
@@ -54,7 +54,7 @@ Gets an attachment for a manifest by its attachment ID or file ID, including ful
|
||||
|
||||
**Returns**
|
||||
|
||||
`Promise<object>` — The attachment record with binary content.
|
||||
`Promise<{id: number, manifestId: number, fileId: number, mimetype: string, name: string, content: Buffer}>` — The attachment record with binary content.
|
||||
|
||||
**Throws**
|
||||
|
||||
@@ -82,7 +82,7 @@ Lists all attachments for a given manifest, without loading their full binary co
|
||||
|
||||
**Returns**
|
||||
|
||||
`Promise<Array<object>>` — A list of attachment metadata objects.
|
||||
`Promise<Array<{id: number, manifestId: number, fileId: number, mimetype: string, name: string, size: number}>>` — A list of attachment metadata objects.
|
||||
|
||||
**Throws**
|
||||
|
||||
|
||||
90
API.md
90
API.md
@@ -11,41 +11,41 @@ The store is exposed as a `LibDashStore` instance (see `src/index.js`). Each met
|
||||
- `delete(id: number): Promise<void>`
|
||||
- `getByEmail(email: string): Promise<Array<number>>`
|
||||
- [company](API.company.md)
|
||||
- `create(input: object): Promise<{id: number, rootCategoryId: number, languageId: number, taxrateId: number, reducedtaxrateId: number, taxfreerateId: number, posCustomerGroupId: number}>`
|
||||
- `create(input: {iso639: string, name: string, taxrate: number, reducedtaxrate: number, googleAuthId: number}): Promise<{id: number, rootCategoryId: number, languageId: number, taxrateId: number, reducedtaxrateId: number, taxfreerateId: number, posCustomerGroupId: number}>`
|
||||
- `delete(companyId: number): Promise<void>`
|
||||
- `getById(id: number, tx?: object): Promise<object|undefined>`
|
||||
- `getByName(name: string, tx?: object): Promise<object|undefined>`
|
||||
- `list(googleAuthId: number): Promise<Array<object>>`
|
||||
- `update(id: number, input: object): Promise<{id: number, rootCategoryId: number, languageId: number, taxrateId: number, reducedtaxrateId: number, taxfreerateId: number}>`
|
||||
- `update(id: number, input: {iso639: string, name: string, taxrate: number, reducedtaxrate: number}): Promise<{id: number, rootCategoryId: number, languageId: number, taxrateId: number, reducedtaxrateId: number, taxfreerateId: number}>`
|
||||
- [category](API.category.md)
|
||||
- `addImage(googleAuthId: number, categoryId: number, image: Buffer): Promise<{id: number, fullHash: string, thumbW: number, thumbH: number, thumbHash: string}>`
|
||||
- `createUnderParent(input: object): Promise<{id: number, parentId: number, sort: number, name: string, slug: string}>`
|
||||
- `delete(input: object): Promise<void>`
|
||||
- `createUnderParent(input: {googleAuthId: number, parentId: number, name: string}): Promise<{id: number, parentId: number, sort: number, name: string, slug: string}>`
|
||||
- `delete(input: {googleAuthId: number, id: number}): Promise<void>`
|
||||
- `deleteImage(googleAuthId: number, categoryId: number): Promise<{id: number, thumbW: null, thumbH: null, thumbHash: null}>`
|
||||
- `ensureByPath(input: object, tx?: object): Promise<number>`
|
||||
- `ensureByPath(input: {googleAuthId: number, parentId: number, path: string}, tx?: object): Promise<number>`
|
||||
- `getCategoryArticles(googleAuthId: number, categoryId: number): Promise<Array<object>>`
|
||||
- `getTreeForCompany(googleAuthId: number): Promise<{languageId: number, tree: Array<object>, articles: Array<object>}>`
|
||||
- `move(input: object): Promise<{id: number, parentId: number, sort: number}>`
|
||||
- `order(input: object): Promise<{categoryIds: Array<number>}>`
|
||||
- `rename(input: object): Promise<{id: number, name: string, slug: string}>`
|
||||
- `move(input: {googleAuthId: number, id: number, parentId: number}): Promise<{id: number, parentId: number, sort: number}>`
|
||||
- `order(input: {googleAuthId: number, parentId: number, categoryIds: Array<number>}): Promise<{categoryIds: Array<number>}>`
|
||||
- `rename(input: {googleAuthId: number, id: number, name: string}): Promise<{id: number, name: string, slug: string}>`
|
||||
- [article](API.article.md)
|
||||
- `addImage(googleAuthId: number, sku: string, image: Buffer): Promise<{picId: number, sort: number, full: {w: number, h: number, size: number}, thumb: {w: number, h: number}, fullHash: string, thumbHash: string}>`
|
||||
- `createUnderParent(input: object): Promise<{id: number, parentId: number, name: string, sku: string}>`
|
||||
- `createUnderParent(input: {googleAuthId: number, parentId: number, name: string}): Promise<{id: number, parentId: number, name: string, sku: string}>`
|
||||
- `delete(googleAuthId: number, sku: string): Promise<void>`
|
||||
- `deleteImage(googleAuthId: number, sku: string, fullHash: string): Promise<void>`
|
||||
- `getBySku(googleAuthId: number, sku: string): Promise<{article: object}>`
|
||||
- `getHistoryBySku(googleAuthId: number, sku: string): Promise<Array<{id: number, companyuserId: number|null, date: string, text: string}>>`
|
||||
- `importRows(input: object): Promise<{imported: Array<object>, skipped: Array<object>, errors: Array<object>}>`
|
||||
- `importRows(input: {googleAuthId: number, rows: Array<object>}): Promise<{imported: Array<object>, skipped: Array<object>, errors: Array<object>}>`
|
||||
- `listExport(googleAuthId: number, categoryId?: number|null): Promise<Array<object>>`
|
||||
- `listSearchIndex(googleAuthId: number): Promise<Array<{id: number, sku: string, name: string, eans: Array<string>, categoryIds: Array<number>}>>`
|
||||
- `orderImages(googleAuthId: number, sku: string, input: object): Promise<{fullHashes: Array<string>}>`
|
||||
- `orderImages(googleAuthId: number, sku: string, input: {fullHashes: Array<string>}): Promise<{fullHashes: Array<string>}>`
|
||||
- `setBrandIdBySku(googleAuthId: number, sku: string, brandId: number|null): Promise<object>`
|
||||
- `setCategoryIdsBySku(googleAuthId: number, sku: string, categoryIds: Array<number>): Promise<object>`
|
||||
- `setEansBySku(googleAuthId: number, sku: string, eans: Array<string>): Promise<object>`
|
||||
- `setFatherBySku(googleAuthId: number, sku: string, fatherSku: string|null): Promise<object>`
|
||||
- `setPricesBySku(googleAuthId: number, sku: string, prices: Array<{price: number, tax: number, minmultiplier?: number}>): Promise<object>`
|
||||
- `setWeightBySku(googleAuthId: number, sku: string, weight: number): Promise<object>`
|
||||
- `updateBySku(googleAuthId: number, sku: string, patch: object): Promise<object>`
|
||||
- `updateBySku(googleAuthId: number, sku: string, patch: {name?: string, unitSi?: string, unitamount?: number}): Promise<object>`
|
||||
- [lang](API.lang.md)
|
||||
- `create(iso639: string, tx?: object): Promise<number>`
|
||||
- `delete(id: number): Promise<void>`
|
||||
@@ -60,66 +60,66 @@ The store is exposed as a `LibDashStore` instance (see `src/index.js`). Each met
|
||||
- [unit](API.unit.md)
|
||||
- `delete(googleAuthId: number, si: string): Promise<void>`
|
||||
- `list(googleAuthId: number): Promise<Array<{id: number, si: string, basesi: string, basesifactor: number, symbol: string, name: string}>>`
|
||||
- `upsert(googleAuthId: number, input: object): Promise<{id: number, si: string, basesi: string, basesifactor: number, symbol: string, name: string}>`
|
||||
- `upsert(googleAuthId: number, input: {si: string, basesi: string, basesifactor: number, symbol: string, name: string}): Promise<{id: number, si: string, basesi: string, basesifactor: number, symbol: string, name: string}>`
|
||||
- [companysetting](API.companysetting.md)
|
||||
- `get(googleAuthId: number, key: string, options?: object): Promise<{key: string, value: string, frontend: boolean, writeonly: boolean}|undefined>`
|
||||
- `list(googleAuthId: number, options?: object): Promise<Array<{key: string, value: string, frontend: boolean, writeonly: boolean}>>`
|
||||
- `set(googleAuthId: number, input: object): Promise<{key: string, value: string, frontend: boolean, writeonly: boolean}>`
|
||||
- `get(googleAuthId: number, key: string, options?: {frontendOnly?: boolean, maskWriteonly?: boolean}): Promise<{key: string, value: string, frontend: boolean, writeonly: boolean}|undefined>`
|
||||
- `list(googleAuthId: number, options?: {frontendOnly?: boolean, maskWriteonly?: boolean}): Promise<Array<{key: string, value: string, frontend: boolean, writeonly: boolean}>>`
|
||||
- `set(googleAuthId: number, input: {key: string, value: string, frontend?: boolean, writeonly?: boolean}): Promise<{key: string, value: string, frontend: boolean, writeonly: boolean}>`
|
||||
- [brand](API.brand.md)
|
||||
- `delete(googleAuthId: number, id: number): Promise<void>`
|
||||
- `list(googleAuthId: number): Promise<Array<{id: number, name: string, gsprpinfo: string|null}>>`
|
||||
- `upsert(googleAuthId: number, input: object): Promise<{id: number, name: string, gsprpinfo: string|null}>`
|
||||
- `upsert(googleAuthId: number, input: {name: string, gsprpinfo?: string}): Promise<{id: number, name: string, gsprpinfo: string|null}>`
|
||||
- [customergroup](API.customergroup.md)
|
||||
- `create(googleAuthId: number, input: object): Promise<{id: number, name: string, sort: number}>`
|
||||
- `create(googleAuthId: number, input: {name: string}): Promise<{id: number, name: string, sort: number}>`
|
||||
- `delete(googleAuthId: number, id: number): Promise<void>`
|
||||
- `list(googleAuthId: number): Promise<Array<{id: number, name: string, sort: number}>>`
|
||||
- `order(googleAuthId: number, input: object): Promise<{customergroupIds: Array<number>}>`
|
||||
- `update(googleAuthId: number, id: number, input: object): Promise<{id: number, name: string, sort: number}>`
|
||||
- `order(googleAuthId: number, input: {customergroupIds: Array<number>}): Promise<{customergroupIds: Array<number>}>`
|
||||
- `update(googleAuthId: number, id: number, input: {name: string}): Promise<{id: number, name: string, sort: number}>`
|
||||
- [entity](API.entity.md)
|
||||
- `create(googleAuthId: number, input: object): Promise<{id: number, customergroupId: number, firstName: string|null, name: string, number: string, createdAt: string, updatedAt: string}>`
|
||||
- `create(googleAuthId: number, input: {customergroupId: number, name: string, firstName?: string, number?: string}): Promise<{id: number, customergroupId: number, firstName: string|null, name: string, number: string, createdAt: string, updatedAt: string}>`
|
||||
- `delete(googleAuthId: number, id: number): Promise<void>`
|
||||
- `getById(googleAuthId: number, id: number): Promise<{id: number, customergroupId: number, firstName: string|null, name: string, number: string, createdAt: string, updatedAt: string}>`
|
||||
- `isNumberFree(googleAuthId: number, number: string, options?: object): Promise<boolean>`
|
||||
- `list(googleAuthId: number, options?: object): Promise<Array<{id: number, customergroupId: number, firstName: string|null, name: string, number: string, createdAt: string, updatedAt: string}>>`
|
||||
- `isNumberFree(googleAuthId: number, number: string, options?: {excludeEntityId?: number}): Promise<boolean>`
|
||||
- `list(googleAuthId: number, options?: {customergroupId?: number, role?: string}): Promise<Array<{id: number, customergroupId: number, firstName: string|null, name: string, number: string, createdAt: string, updatedAt: string}>>`
|
||||
- `peekNextNumber(googleAuthId: number): Promise<string>`
|
||||
- `update(googleAuthId: number, id: number, patch: object): Promise<{id: number, customergroupId: number, firstName: string|null, name: string, number: string, createdAt: string, updatedAt: string}>`
|
||||
- `update(googleAuthId: number, id: number, patch: {name?: string, firstName?: string, number?: string}): Promise<{id: number, customergroupId: number, firstName: string|null, name: string, number: string, createdAt: string, updatedAt: string}>`
|
||||
- [entityaddress](API.entityaddress.md)
|
||||
- `create(googleAuthId: number, entityId: number, input: object): Promise<object>`
|
||||
- `create(googleAuthId: number, entityId: number, input: {addressType: string, firstName?: string, name?: string, street?: string, streetNumber?: string, zip?: string, city?: string, county?: string, sort?: number}): Promise<{id: number, entityId: number, firstName: string|null, name: string|null, street: string|null, streetNumber: string|null, zip: string|null, city: string|null, county: string|null, addressType: string, sort: number}>`
|
||||
- `delete(googleAuthId: number, entityId: number, id: number): Promise<void>`
|
||||
- `list(googleAuthId: number, entityId: number): Promise<Array<object>>`
|
||||
- `update(googleAuthId: number, entityId: number, id: number, patch: object): Promise<object>`
|
||||
- `list(googleAuthId: number, entityId: number): Promise<Array<{id: number, entityId: number, firstName: string|null, name: string|null, street: string|null, streetNumber: string|null, zip: string|null, city: string|null, county: string|null, addressType: string, sort: number}>>`
|
||||
- `update(googleAuthId: number, entityId: number, id: number, patch: {addressType?: string, firstName?: string, name?: string, street?: string, streetNumber?: string, zip?: string, city?: string, county?: string, sort?: number}): Promise<{id: number, entityId: number, firstName: string|null, name: string|null, street: string|null, streetNumber: string|null, zip: string|null, city: string|null, county: string|null, addressType: string, sort: number}>`
|
||||
- [entitycontact](API.entitycontact.md)
|
||||
- `create(googleAuthId: number, entityId: number, input: object): Promise<{id: number, entityId: number, contactType: string, contact: string, sort: number}>`
|
||||
- `create(googleAuthId: number, entityId: number, input: {contactType: string, contact: string, sort?: number}): Promise<{id: number, entityId: number, contactType: string, contact: string, sort: number}>`
|
||||
- `delete(googleAuthId: number, entityId: number, id: number): Promise<void>`
|
||||
- `list(googleAuthId: number, entityId: number): Promise<Array<{id: number, entityId: number, contactType: string, contact: string, sort: number}>>`
|
||||
- `update(googleAuthId: number, entityId: number, id: number, patch: object): Promise<{id: number, entityId: number, contactType: string, contact: string, sort: number}>`
|
||||
- [supplier](API.supplier.md)
|
||||
- `create(googleAuthId: number, input: object): Promise<{id: number, name: string, createdAt: string, updatedAt: string}>`
|
||||
- `create(googleAuthId: number, input: {name: string}): Promise<{id: number, name: string, createdAt: string, updatedAt: string}>`
|
||||
- `delete(googleAuthId: number, id: number): Promise<void>`
|
||||
- `list(googleAuthId: number): Promise<Array<{id: number, name: string, createdAt: string, updatedAt: string}>>`
|
||||
- `update(googleAuthId: number, id: number, input: object): Promise<{id: number, name: string, createdAt: string, updatedAt: string}>`
|
||||
- `update(googleAuthId: number, id: number, input: {name: string}): Promise<{id: number, name: string, createdAt: string, updatedAt: string}>`
|
||||
- [delivery](API.delivery.md)
|
||||
- `create(googleAuthId: number, body: object): Promise<{id: number, number: string, type: string, entityId: number, externalNumber: string|null, date: string, lines: Array<object>}>`
|
||||
- `create(googleAuthId: number, body: {date: string, supplierId: number, externalNumber?: string, lines?: Array<{sku?: string, name?: string, pu?: number, amount: number, net: number, rebate?: number, tax: number, comment?: string|null}>}): Promise<{id: number, number: string, type: string, entityId: number, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>`
|
||||
- `delete(googleAuthId: number, id: number): Promise<void>`
|
||||
- `getById(googleAuthId: number, id: number): Promise<{id: number, number: string, type: string, entityId: number, externalNumber: string|null, date: string, lines: Array<object>}>`
|
||||
- `getById(googleAuthId: number, id: number): Promise<{id: number, number: string, type: string, entityId: number, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>`
|
||||
- `list(googleAuthId: number): Promise<Array<{id: number, number: string, type: string, entityId: number, externalNumber: string|null, date: string}>>`
|
||||
- `update(googleAuthId: number, id: number, patch: object): Promise<{id: number, number: string, type: string, entityId: number, externalNumber: string|null, date: string, lines: Array<object>}>`
|
||||
- `update(googleAuthId: number, id: number, patch: {number?: string, date?: string, supplierId?: number, externalNumber?: string, lines?: Array<{sku?: string, name?: string, pu?: number, amount: number, net: number, rebate?: number, tax: number, comment?: string|null}>}): Promise<{id: number, number: string, type: string, entityId: number, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>`
|
||||
- [quote](API.quote.md)
|
||||
- `create(googleAuthId: number, body: object): Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<object>}>`
|
||||
- `create(googleAuthId: number, body: {number: string, date: string, entityId?: number, externalNumber?: string, lines?: Array<{sku?: string, name?: string, pu?: number, amount: number, net: number, rebate?: number, tax: number, comment?: string|null}>}): Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>`
|
||||
- `delete(googleAuthId: number, id: number): Promise<void>`
|
||||
- `getById(googleAuthId: number, id: number): Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<object>}>`
|
||||
- `getById(googleAuthId: number, id: number): Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>`
|
||||
- `list(googleAuthId: number): Promise<Array<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string}>>`
|
||||
- `update(googleAuthId: number, id: number, patch: object): Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<object>}>`
|
||||
- `update(googleAuthId: number, id: number, patch: {number?: string, date?: string, entityId?: number, externalNumber?: string, lines?: Array<{sku?: string, name?: string, pu?: number, amount: number, net: number, rebate?: number, tax: number, comment?: string|null}>}): Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>`
|
||||
- [order](API.order.md)
|
||||
- `create(googleAuthId: number, body: object): Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<object>}>`
|
||||
- `create(googleAuthId: number, body: {number: string, date: string, entityId?: number, externalNumber?: string, lines?: Array<{sku?: string, name?: string, pu?: number, amount: number, net: number, rebate?: number, tax: number, comment?: string|null}>}): Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>`
|
||||
- `delete(googleAuthId: number, id: number): Promise<void>`
|
||||
- `getById(googleAuthId: number, id: number): Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<object>}>`
|
||||
- `getById(googleAuthId: number, id: number): Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>`
|
||||
- `list(googleAuthId: number): Promise<Array<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string}>>`
|
||||
- `update(googleAuthId: number, id: number, patch: object): Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<object>}>`
|
||||
- `update(googleAuthId: number, id: number, patch: {number?: string, date?: string, entityId?: number, externalNumber?: string, lines?: Array<{sku?: string, name?: string, pu?: number, amount: number, net: number, rebate?: number, tax: number, comment?: string|null}>}): Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>`
|
||||
- [manifestattachment](API.manifestattachment.md)
|
||||
- `add(googleAuthId: number, manifestId: number, input: object): Promise<object>`
|
||||
- `getById(googleAuthId: number, manifestId: number, id: number): Promise<object>`
|
||||
- `listByManifestId(googleAuthId: number, manifestId: number): Promise<Array<object>>`
|
||||
- `add(googleAuthId: number, manifestId: number, input: {mimetype: string, name: string, content: Buffer}): Promise<{id: number, manifestId: number, fileId: number, mimetype: string, name: string}>`
|
||||
- `getById(googleAuthId: number, manifestId: number, id: number): Promise<{id: number, manifestId: number, fileId: number, mimetype: string, name: string, content: Buffer}>`
|
||||
- `listByManifestId(googleAuthId: number, manifestId: number): Promise<Array<{id: number, manifestId: number, fileId: number, mimetype: string, name: string, size: number}>>`
|
||||
- `remove(googleAuthId: number, manifestId: number, id: number): Promise<void>`
|
||||
- [posterminal](API.posterminal.md)
|
||||
- `delete(googleAuthId: number, id: number): Promise<void>`
|
||||
@@ -128,18 +128,18 @@ The store is exposed as a `LibDashStore` instance (see `src/index.js`). Each met
|
||||
- `setOffAll(googleAuthId: number, posterminalId: number): Promise<{id: number, categoryIds: Array<number>}>`
|
||||
- `setOn(googleAuthId: number, posterminalId: number, categoryId: number): Promise<{id: number, categoryIds: Array<number>}>`
|
||||
- `setOnAll(googleAuthId: number, posterminalId: number): Promise<{id: number, categoryIds: Array<number>}>`
|
||||
- `upsert(googleAuthId: number, input: object): Promise<{id: number, name: string, token: string, pairingpin: string}>`
|
||||
- `upsert(googleAuthId: number, input: {name: string, pairingpin: string, token?: string, id?: number}): Promise<{id: number, name: string, token: string, pairingpin: string}>`
|
||||
- [google_auth](API.google_auth.md)
|
||||
- `add(email: string): Promise<number>`
|
||||
- `getByEmail(email: string): Promise<object|undefined>`
|
||||
- `getById(googleAuthId: number): Promise<object|undefined>`
|
||||
- `listAllowedEmails(): Promise<Array<{id: number, email: string}>>`
|
||||
- `removeAllowedEmail(email: string): Promise<void>`
|
||||
- `setProfile(googleAuthId: number, input: object): Promise<void>`
|
||||
- `setProfile(googleAuthId: number, input: {picture?: string, pictureBinary?: Buffer, sub?: string}): Promise<void>`
|
||||
- `setSelectedCompany(googleAuthId: number, companyId: number): Promise<void>`
|
||||
- [pic](API.pic.md)
|
||||
- `getImageByHash(googleAuthId: number, fullHash: string): Promise<{buffer: Buffer, w: number, h: number, size: number, contentType: string}>`
|
||||
- `getThumbByHash(googleAuthId: number, fullHash: string): Promise<{buffer: Buffer, w: number, h: number, contentType: string}>`
|
||||
- [numbers](API.numbers.md)
|
||||
- `list(googleAuthId: number): Promise<Array<{id: number, type: string, prefix: string, padding: number, next: number}>>`
|
||||
- `update(googleAuthId: number, id: number, input: object): Promise<{id: number, type: string, prefix: string, padding: number, next: number}>`
|
||||
- `update(googleAuthId: number, id: number, input: {prefix?: string, padding?: number, next?: number}): Promise<{id: number, type: string, prefix: string, padding: number, next: number}>`
|
||||
|
||||
10
API.order.md
10
API.order.md
@@ -18,11 +18,11 @@ Creates a new order for the user's selected company with its lines.
|
||||
| `body.date` | `string` | The order date. |
|
||||
| `[body.entityId]` | `number` | The id of the customer entity. |
|
||||
| `[body.externalNumber]` | `string` | An external (customer) reference number. |
|
||||
| `[body.lines]` | `Array<object>` | The order lines. |
|
||||
| `[body.lines]` | `Array<{sku?: string, name?: string, pu?: number, amount: number, net: number, rebate?: number, tax: number, comment?: string|null}>` | The order lines. |
|
||||
|
||||
**Returns**
|
||||
|
||||
`Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<object>}>` — The created order.
|
||||
`Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>` — The created order.
|
||||
|
||||
**Throws**
|
||||
|
||||
@@ -77,7 +77,7 @@ Returns a single order by its id within the user's selected company.
|
||||
|
||||
**Returns**
|
||||
|
||||
`Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<object>}>` — The order with its lines.
|
||||
`Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>` — The order with its lines.
|
||||
|
||||
**Throws**
|
||||
|
||||
@@ -130,11 +130,11 @@ Updates an order's header and/or lines.
|
||||
| `[patch.date]` | `string` | The new order date. |
|
||||
| `[patch.entityId]` | `number` | The new customer entity id. |
|
||||
| `[patch.externalNumber]` | `string` | The new external (customer) reference number. |
|
||||
| `[patch.lines]` | `Array<object>` | The new order lines. |
|
||||
| `[patch.lines]` | `Array<{sku?: string, name?: string, pu?: number, amount: number, net: number, rebate?: number, tax: number, comment?: string|null}>` | The new order lines. |
|
||||
|
||||
**Returns**
|
||||
|
||||
`Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<object>}>` — The updated order.
|
||||
`Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>` — The updated order.
|
||||
|
||||
**Throws**
|
||||
|
||||
|
||||
10
API.quote.md
10
API.quote.md
@@ -18,11 +18,11 @@ Creates a new quote for the user's selected company with its lines.
|
||||
| `body.date` | `string` | The quote date. |
|
||||
| `[body.entityId]` | `number` | The id of the customer entity. |
|
||||
| `[body.externalNumber]` | `string` | An external (customer) reference number. |
|
||||
| `[body.lines]` | `Array<object>` | The quote lines. |
|
||||
| `[body.lines]` | `Array<{sku?: string, name?: string, pu?: number, amount: number, net: number, rebate?: number, tax: number, comment?: string|null}>` | The quote lines. |
|
||||
|
||||
**Returns**
|
||||
|
||||
`Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<object>}>` — The created quote.
|
||||
`Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>` — The created quote.
|
||||
|
||||
**Throws**
|
||||
|
||||
@@ -77,7 +77,7 @@ Returns a single quote by its id within the user's selected company.
|
||||
|
||||
**Returns**
|
||||
|
||||
`Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<object>}>` — The quote with its lines.
|
||||
`Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>` — The quote with its lines.
|
||||
|
||||
**Throws**
|
||||
|
||||
@@ -130,11 +130,11 @@ Updates a quote's header and/or lines.
|
||||
| `[patch.date]` | `string` | The new quote date. |
|
||||
| `[patch.entityId]` | `number` | The new customer entity id. |
|
||||
| `[patch.externalNumber]` | `string` | The new external (customer) reference number. |
|
||||
| `[patch.lines]` | `Array<object>` | The new quote lines. |
|
||||
| `[patch.lines]` | `Array<{sku?: string, name?: string, pu?: number, amount: number, net: number, rebate?: number, tax: number, comment?: string|null}>` | The new quote lines. |
|
||||
|
||||
**Returns**
|
||||
|
||||
`Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<object>}>` — The updated quote.
|
||||
`Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>` — The updated quote.
|
||||
|
||||
**Throws**
|
||||
|
||||
|
||||
@@ -255,14 +255,35 @@ function renderSection(moduleName, entries) {
|
||||
return lines.join('\n');
|
||||
}
|
||||
|
||||
function formatParamType(param, allParams) {
|
||||
const cleanName = param.name.replace(/^\[|\]$/g, '').split('=')[0].trim();
|
||||
const prefix = cleanName + '.';
|
||||
const childParams = allParams.filter((p) => {
|
||||
const pClean = p.name.replace(/^\[|\]$/g, '').split('=')[0].trim();
|
||||
return pClean.startsWith(prefix) && !pClean.slice(prefix.length).includes('.');
|
||||
});
|
||||
|
||||
if (childParams.length > 0) {
|
||||
const props = childParams.map((cp) => {
|
||||
const isOpt = cp.name.startsWith('[');
|
||||
const propName = cp.name.replace(/^\[|\]$/g, '').split('=')[0].trim().slice(prefix.length);
|
||||
const propType = formatParamType(cp, allParams);
|
||||
return `${propName}${isOpt ? '?' : ''}: ${propType}`;
|
||||
});
|
||||
return `{${props.join(', ')}}`;
|
||||
}
|
||||
|
||||
return param.type || 'any';
|
||||
}
|
||||
|
||||
function formatMethodSignature(entry) {
|
||||
const topLevelParams = (entry.params || []).filter((p) => !p.name.includes('.'));
|
||||
const paramsStr = topLevelParams
|
||||
.map((p) => {
|
||||
const isOptional = p.name.startsWith('[');
|
||||
const cleanName = p.name.replace(/^\[|\]$/g, '').split('=')[0].trim();
|
||||
const typeStr = p.type ? `: ${p.type}` : '';
|
||||
return `${cleanName}${isOptional ? '?' : ''}${typeStr}`;
|
||||
const typeStr = formatParamType(p, entry.params || []);
|
||||
return `${cleanName}${isOptional ? '?' : ''}: ${typeStr}`;
|
||||
})
|
||||
.join(', ');
|
||||
|
||||
|
||||
@@ -22,8 +22,8 @@ export default function create(pool) {
|
||||
* @param {string} body.date - The delivery date.
|
||||
* @param {number} body.supplierId - The id of the supplier.
|
||||
* @param {string} [body.externalNumber] - An external (supplier) reference number.
|
||||
* @param {Array<object>} [body.lines] - The delivery lines.
|
||||
* @returns {Promise<{id: number, number: string, type: string, entityId: number, externalNumber: string|null, date: string, lines: Array<object>}>} The created delivery.
|
||||
* @param {Array<{sku?: string, name?: string, pu?: number, amount: number, net: number, rebate?: number, tax: number, comment?: string|null}>} [body.lines] - The delivery lines.
|
||||
* @returns {Promise<{id: number, number: string, type: string, entityId: number, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>} The created delivery.
|
||||
* @throws {Error} If the delivery is invalid.
|
||||
*
|
||||
* @example
|
||||
|
||||
@@ -9,7 +9,7 @@ export default function getById(pool) {
|
||||
*
|
||||
* @param {number} googleAuthId - The id of the Google auth user.
|
||||
* @param {number} id - The id of the delivery.
|
||||
* @returns {Promise<{id: number, number: string, type: string, entityId: number, externalNumber: string|null, date: string, lines: Array<object>}>} The delivery.
|
||||
* @returns {Promise<{id: number, number: string, type: string, entityId: number, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>} The delivery.
|
||||
* @throws {Error} If the delivery is not found.
|
||||
*
|
||||
* @example
|
||||
|
||||
@@ -25,8 +25,8 @@ export default function update(pool) {
|
||||
* @param {string} [patch.date] - The new delivery date.
|
||||
* @param {number} [patch.supplierId] - The new supplier id.
|
||||
* @param {string} [patch.externalNumber] - The new external (supplier) reference number.
|
||||
* @param {Array<object>} [patch.lines] - The new delivery lines.
|
||||
* @returns {Promise<{id: number, number: string, type: string, entityId: number, externalNumber: string|null, date: string, lines: Array<object>}>} The updated delivery.
|
||||
* @param {Array<{sku?: string, name?: string, pu?: number, amount: number, net: number, rebate?: number, tax: number, comment?: string|null}>} [patch.lines] - The new delivery lines.
|
||||
* @returns {Promise<{id: number, number: string, type: string, entityId: number, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>} The updated delivery.
|
||||
* @throws {Error} If the delivery is not found.
|
||||
*
|
||||
* @example
|
||||
|
||||
@@ -43,7 +43,7 @@ export default function create(pool) {
|
||||
* @param {string} [input.city] - The city.
|
||||
* @param {string} [input.county] - The county.
|
||||
* @param {number} [input.sort] - Optional sort order.
|
||||
* @returns {Promise<object>} The created address.
|
||||
* @returns {Promise<{id: number, entityId: number, firstName: string|null, name: string|null, street: string|null, streetNumber: string|null, zip: string|null, city: string|null, county: string|null, addressType: string, sort: number}>} The created address.
|
||||
* @throws {Error} If the address type is missing.
|
||||
*
|
||||
* @example
|
||||
|
||||
@@ -27,7 +27,7 @@ export default function list(pool) {
|
||||
*
|
||||
* @param {number} googleAuthId - The id of the Google auth user.
|
||||
* @param {number} entityId - The id of the entity.
|
||||
* @returns {Promise<Array<object>>} The addresses.
|
||||
* @returns {Promise<Array<{id: number, entityId: number, firstName: string|null, name: string|null, street: string|null, streetNumber: string|null, zip: string|null, city: string|null, county: string|null, addressType: string, sort: number}>>} The addresses.
|
||||
*
|
||||
* @example
|
||||
* const addresses = await store.entityaddress.list(42, 5);
|
||||
|
||||
@@ -35,7 +35,16 @@ export default function update(pool) {
|
||||
* @param {number} entityId - The id of the entity.
|
||||
* @param {number} id - The id of the address to update.
|
||||
* @param {object} patch - The update patch (any subset of address fields).
|
||||
* @returns {Promise<object>} The updated address.
|
||||
* @param {string} [patch.addressType] - The address type.
|
||||
* @param {string} [patch.firstName] - The first name.
|
||||
* @param {string} [patch.name] - The name.
|
||||
* @param {string} [patch.street] - The street.
|
||||
* @param {string} [patch.streetNumber] - The street number.
|
||||
* @param {string} [patch.zip] - The zip code.
|
||||
* @param {string} [patch.city] - The city.
|
||||
* @param {string} [patch.county] - The county.
|
||||
* @param {number} [patch.sort] - The sort order.
|
||||
* @returns {Promise<{id: number, entityId: number, firstName: string|null, name: string|null, street: string|null, streetNumber: string|null, zip: string|null, city: string|null, county: string|null, addressType: string, sort: number}>} The updated address.
|
||||
* @throws {Error} If the address is not found.
|
||||
*
|
||||
* @example
|
||||
|
||||
@@ -16,7 +16,7 @@ export default function add(pool) {
|
||||
* @param {string} input.mimetype - The MIME type of the file (e.g. `'application/pdf'`).
|
||||
* @param {string} input.name - The file name.
|
||||
* @param {Buffer} input.content - The file content.
|
||||
* @returns {Promise<object>} The created attachment record.
|
||||
* @returns {Promise<{id: number, manifestId: number, fileId: number, mimetype: string, name: string}>} The created attachment record.
|
||||
* @throws {Error} If the manifest is not found or file input is invalid.
|
||||
*
|
||||
* @example
|
||||
|
||||
@@ -13,7 +13,7 @@ export default function getById(pool) {
|
||||
* @param {number} googleAuthId - The id of the Google auth user.
|
||||
* @param {number} manifestId - The manifest ID.
|
||||
* @param {number} id - The attachment ID or file ID.
|
||||
* @returns {Promise<object>} The attachment record with binary content.
|
||||
* @returns {Promise<{id: number, manifestId: number, fileId: number, mimetype: string, name: string, content: Buffer}>} The attachment record with binary content.
|
||||
* @throws {Error} If the manifest or attachment is not found, or user is not authorized.
|
||||
*
|
||||
* @example
|
||||
|
||||
@@ -23,7 +23,7 @@ export default function listByManifestId(pool) {
|
||||
*
|
||||
* @param {number} googleAuthId - The id of the Google auth user.
|
||||
* @param {number} manifestId - The manifest ID.
|
||||
* @returns {Promise<Array<object>>} A list of attachment metadata objects.
|
||||
* @returns {Promise<Array<{id: number, manifestId: number, fileId: number, mimetype: string, name: string, size: number}>>} A list of attachment metadata objects.
|
||||
* @throws {Error} If the manifest is not found or the user is not authorized.
|
||||
*
|
||||
* @example
|
||||
|
||||
@@ -18,8 +18,8 @@ export default function create(pool) {
|
||||
* @param {string} body.date - The order date.
|
||||
* @param {number} [body.entityId] - The id of the customer entity.
|
||||
* @param {string} [body.externalNumber] - An external (customer) reference number.
|
||||
* @param {Array<object>} [body.lines] - The order lines.
|
||||
* @returns {Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<object>}>} The created order.
|
||||
* @param {Array<{sku?: string, name?: string, pu?: number, amount: number, net: number, rebate?: number, tax: number, comment?: string|null}>} [body.lines] - The order lines.
|
||||
* @returns {Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>} The created order.
|
||||
* @throws {Error} If the order is invalid.
|
||||
*
|
||||
* @example
|
||||
|
||||
@@ -10,7 +10,7 @@ export default function getById(pool) {
|
||||
*
|
||||
* @param {number} googleAuthId - The id of the Google auth user.
|
||||
* @param {number} id - The id of the order.
|
||||
* @returns {Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<object>}>} The order with its lines.
|
||||
* @returns {Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>} The order with its lines.
|
||||
* @throws {Error} If the order is not found.
|
||||
*
|
||||
* @example
|
||||
|
||||
@@ -24,8 +24,8 @@ export default function update(pool) {
|
||||
* @param {string} [patch.date] - The new order date.
|
||||
* @param {number} [patch.entityId] - The new customer entity id.
|
||||
* @param {string} [patch.externalNumber] - The new external (customer) reference number.
|
||||
* @param {Array<object>} [patch.lines] - The new order lines.
|
||||
* @returns {Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<object>}>} The updated order.
|
||||
* @param {Array<{sku?: string, name?: string, pu?: number, amount: number, net: number, rebate?: number, tax: number, comment?: string|null}>} [patch.lines] - The new order lines.
|
||||
* @returns {Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>} The updated order.
|
||||
* @throws {Error} If the order is not found.
|
||||
*
|
||||
* @example
|
||||
|
||||
@@ -18,8 +18,8 @@ export default function create(pool) {
|
||||
* @param {string} body.date - The quote date.
|
||||
* @param {number} [body.entityId] - The id of the customer entity.
|
||||
* @param {string} [body.externalNumber] - An external (customer) reference number.
|
||||
* @param {Array<object>} [body.lines] - The quote lines.
|
||||
* @returns {Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<object>}>} The created quote.
|
||||
* @param {Array<{sku?: string, name?: string, pu?: number, amount: number, net: number, rebate?: number, tax: number, comment?: string|null}>} [body.lines] - The quote lines.
|
||||
* @returns {Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>} The created quote.
|
||||
* @throws {Error} If the quote is invalid.
|
||||
*
|
||||
* @example
|
||||
|
||||
@@ -10,7 +10,7 @@ export default function getById(pool) {
|
||||
*
|
||||
* @param {number} googleAuthId - The id of the Google auth user.
|
||||
* @param {number} id - The id of the quote.
|
||||
* @returns {Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<object>}>} The quote with its lines.
|
||||
* @returns {Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>} The quote with its lines.
|
||||
* @throws {Error} If the quote is not found.
|
||||
*
|
||||
* @example
|
||||
|
||||
@@ -24,8 +24,8 @@ export default function update(pool) {
|
||||
* @param {string} [patch.date] - The new quote date.
|
||||
* @param {number} [patch.entityId] - The new customer entity id.
|
||||
* @param {string} [patch.externalNumber] - The new external (customer) reference number.
|
||||
* @param {Array<object>} [patch.lines] - The new quote lines.
|
||||
* @returns {Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<object>}>} The updated quote.
|
||||
* @param {Array<{sku?: string, name?: string, pu?: number, amount: number, net: number, rebate?: number, tax: number, comment?: string|null}>} [patch.lines] - The new quote lines.
|
||||
* @returns {Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, tax: number, comment: string|null}>}>} The updated quote.
|
||||
* @throws {Error} If the quote is not found.
|
||||
*
|
||||
* @example
|
||||
|
||||
Reference in New Issue
Block a user