feat: manage files via manifestattachment with auth and cascade trigger, format API.md method signatures
This commit is contained in:
seb
116
API.md
116
API.md
@@ -7,23 +7,139 @@ The store is exposed as a `LibDashStore` instance (see `src/index.js`). Each met
|
||||
## Table of Contents
|
||||
|
||||
- [companyuser](API.companyuser.md)
|
||||
- `add(companyId: number, googleAuthId: number): Promise<number>`
|
||||
- `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}>`
|
||||
- `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}>`
|
||||
- [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>`
|
||||
- `deleteImage(googleAuthId: number, categoryId: number): Promise<{id: number, thumbW: null, thumbH: null, thumbHash: null}>`
|
||||
- `ensureByPath(input: object, 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}>`
|
||||
- [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}>`
|
||||
- `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>}>`
|
||||
- `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>}>`
|
||||
- `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>`
|
||||
- [lang](API.lang.md)
|
||||
- `create(iso639: string, tx?: object): Promise<number>`
|
||||
- `delete(id: number): Promise<void>`
|
||||
- `ensure(iso639: string, tx?: object): Promise<number>`
|
||||
- `getByIso639(iso639: string, tx?: object): Promise<{id: number, iso639: string}>`
|
||||
- `list(): Promise<Array<{id: number, iso639: string}>>`
|
||||
- [tax](API.tax.md)
|
||||
- `create(rate: number, tx?: object): Promise<number>`
|
||||
- `ensure(rate: number, tx?: object): Promise<number>`
|
||||
- `getByRate(rate: number, tx?: object): Promise<{id: number, rate: number}>`
|
||||
- `list(): Promise<Array<{id: number, rate: number}>>`
|
||||
- [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}>`
|
||||
- [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}>`
|
||||
- [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}>`
|
||||
- [customergroup](API.customergroup.md)
|
||||
- `create(googleAuthId: number, input: object): 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}>`
|
||||
- [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}>`
|
||||
- `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}>>`
|
||||
- `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}>`
|
||||
- [entityaddress](API.entityaddress.md)
|
||||
- `create(googleAuthId: number, entityId: number, input: object): Promise<object>`
|
||||
- `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>`
|
||||
- [entitycontact](API.entitycontact.md)
|
||||
- `create(googleAuthId: number, entityId: number, input: object): 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}>`
|
||||
- `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}>`
|
||||
- [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>}>`
|
||||
- `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>}>`
|
||||
- `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>}>`
|
||||
- [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>}>`
|
||||
- `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>}>`
|
||||
- `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>}>`
|
||||
- [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>}>`
|
||||
- `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>}>`
|
||||
- `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>}>`
|
||||
- [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>>`
|
||||
- `remove(googleAuthId: number, manifestId: number, id: number): Promise<void>`
|
||||
- [posterminal](API.posterminal.md)
|
||||
- `delete(googleAuthId: number, id: number): Promise<void>`
|
||||
- `list(googleAuthId: number): Promise<Array<{id: number, name: string, token: string, pairingpin: string}>>`
|
||||
- `setOff(googleAuthId: number, posterminalId: number, categoryId: number): Promise<{id: number, categoryIds: Array<number>}>`
|
||||
- `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}>`
|
||||
- [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>`
|
||||
- `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}>`
|
||||
|
||||
Reference in New Issue
Block a user