diff --git a/docs/api/README.md b/docs/api/README.md index 6f6a18b..ae6545a 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -238,6 +238,11 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route | [`routes/printeragent.put.md`](routes/printeragent.put.md) | `PUT /printeragent` | | [`routes/printeragent/_id.delete.md`](routes/printeragent/_id.delete.md) | `DELETE /printeragent/{id}` | | [`routes/printeragent/_id.patch.md`](routes/printeragent/_id.patch.md) | `PATCH /printeragent/{id}` | +| [`routes/printerjob.get.md`](routes/printerjob.get.md) | `GET /printerjob` | +| [`routes/printerjob.post.md`](routes/printerjob.post.md) | `POST /printerjob` | +| [`routes/printerjob/_id.delete.md`](routes/printerjob/_id.delete.md) | `DELETE /printerjob/{id}` | +| [`routes/printerjob/_id.get.md`](routes/printerjob/_id.get.md) | `GET /printerjob/{id}` | +| [`routes/printerjob/_id/cancel.md`](routes/printerjob/_id/cancel.md) | `POST /printerjob/{id}/cancel` | | [`routes/propertyname.get.md`](routes/propertyname.get.md) | `GET /propertyname` | | [`routes/propertyname.post.md`](routes/propertyname.post.md) | `POST /propertyname` | | [`routes/propertyname/order.md`](routes/propertyname/order.md) | `PUT /propertyname/order` | @@ -331,6 +336,7 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route | [`routes/warehouse/get.md`](routes/warehouse/get.md) | `GET /warehouse/{id}` | | [`routes/warehouse/update.md`](routes/warehouse/update.md) | `PATCH /warehouse/{id}` | | [`routes/warehouse/_id.put.md`](routes/warehouse/_id.put.md) | `PUT /warehouse/{id}` | +| [`routes/zpljob.md`](routes/zpljob.md) | `POST /zpljob` | Route overview: [`routes.md`](routes.md) | All routes: [`routes-all.md`](routes-all.md). @@ -355,6 +361,7 @@ Clients subscribe via [`GET /events`](routes/events.md) (`text/event-stream`). A | `modelconversation-` | `POST /modelconversation/{id}/message` | | `order` | `DELETE /order/{id}/file/{fileId}`, `POST /order/{id}/pdf`, `DELETE /shipment/{id}`, `PATCH /shipment/{id}`, `DELETE /shipment/{id}/file/{fileId}` | | `printer` | `POST /printer`, `PUT /printer/order`, `DELETE /printer/{id}`, `PATCH /printer/{id}`, `PUT /printer/{id}` | +| `printerjob` | `POST /printerjob`, `DELETE /printerjob/{id}`, `POST /printerjob/{id}/cancel`, `POST /zpljob` | | `propertyname` | `POST /propertyname`, `PUT /propertyname/order`, `DELETE /propertyname/{id}`, `PATCH /propertyname/{id}` | | `quote` | `DELETE /quote/{id}/file/{fileId}`, `POST /quote/{id}/pdf` | | `shipment` | `DELETE /shipment/{id}`, `PATCH /shipment/{id}`, `DELETE /shipment/{id}/file/{fileId}`, `POST /shipment/{id}/pdf` | diff --git a/docs/api/routes-all.md b/docs/api/routes-all.md index 2d764a8..579af93 100644 --- a/docs/api/routes-all.md +++ b/docs/api/routes-all.md @@ -1,6 +1,6 @@ # Dash API Routes Overview (All) -Overview of all 299 API endpoints across all modules. +Overview of all 305 API endpoints across all modules. ### Notation @@ -9,46 +9,47 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). ### Reusable types -- `T1` = `{ id: int, number: str, type: str, entityId: int, date: str, lines: T19[], externalNumber?: str|null, createdAt?: str, shipping?: T21|null, shippings?: T21[], payment?: T31|null, payments?: T31[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T2[], files?: T10[] }` -- `T2` = `{ id: int, number: str, type: str, date: str, lines: T19[], shippings: T21[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T10[], state?: str }` -- `T3` = `{ id: int, number: str, type: str, date: str, lines: T19[], entityId?: int|null, externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T10[] }` -- `T4` = `{ id: int, number: str, type: str, supplierId: int, date: str, lines: T22[], files: T10[], externalNumber?: str|null, createdAt?: str, ledger?: T38 }` +- `T1` = `{ id: int, number: str, type: str, entityId: int, date: str, lines: T20[], externalNumber?: str|null, createdAt?: str, shipping?: T23|null, shippings?: T23[], payment?: T32|null, payments?: T32[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T2[], files?: T10[] }` +- `T2` = `{ id: int, number: str, type: str, date: str, lines: T20[], shippings: T23[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T10[], state?: str }` +- `T3` = `{ id: int, number: str, type: str, date: str, lines: T20[], entityId?: int|null, externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T10[] }` +- `T4` = `{ id: int, number: str, type: str, supplierId: int, date: str, lines: T24[], files: T10[], externalNumber?: str|null, createdAt?: str, ledger?: T39 }` - `T5` = `{ name: str, path: str, totalSizeBytes: int, timestamp: str|null, manifest?: T6|null }` - `T6` = `{ id: str, timestamp: str, dateKey: str, monthKey: str, dbProvider: str, files: T11, totalSizeBytes: int, durationMs: int }` - `T7` = `{ id: int, name: str, pairingpin?: str|null, token?: str|null, pairedAt?: str|null, clientserial?: str|null, rootCategoryId?: int|null, syncRootArticles?: bool, sort?: int, enabled?: bool, clientversion?: str|null, lastseenAt?: str|null, updatedAt?: str|null, categoryIds?: int[] }` -- `T8` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T40|null, incoming?: { date: str, amount: num }[] }` -- `T9` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: { objects: T23[] }, thumb?: str|null }` +- `T8` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T41|null, incoming?: { date: str, amount: num }[] }` +- `T9` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: { objects: T25[] }, thumb?: str|null }` - `T10` = `{ id: int, manifestId: int, fileId: int, sort: int, hash: str, mimetype: str, name: str, size: int, created?: str, modified?: str, skeledash?: str|null, thumbx?: int|null, thumby?: int|null, meta?: { [k]: str }|null }` -- `T11` = `{ vfs: T39, storage: T39, database: T33 }` +- `T11` = `{ vfs: T40, storage: T40, database: T34 }` - `T12` = `{ id: int, name: str, companyId?: int, token?: str|null, pairingpin?: str|null, pairedAt?: str|null, agentversion?: str|null, lastseenAt?: str|null, updatedAt?: str, sort?: int, enabled?: bool }` -- `T13` = `{ id: int, entityId: int, addressType: str, firstName?: str|null, name?: str|null, street?: str|null, streetNumber?: str|null, zip?: str|null, city?: str|null, county?: str|null }` -- `T14` = `{ id: int, company_id: int, prompt: str, max_itr: int, cron: str, created_at: str, desc?: str|null, skills?: str|null, lastagentnote?: str|null, lastrun_at?: str|null }` -- `T15` = `{ id: int, manifestarticle_id: int, transaction_type: str, amount: num, transaction_text: str, hash_version: int, prev_hash?: str, sku?: str|null, created_at?: str }` -- `T16` = `{ id: int, name: str, sort: int, exclusive: bool, values: T29[], articleCount?: int }` -- `T17` = `{ id: int, companyuser_id: int, provider: str, model: str, created_at: str, updated_at: str, state: str, started_by?: int|null, first_message?: str|null }` -- `T18` = `{ id: int, name: str, rootCategoryId: int|null, languageId: int|null, iso639: str|null, taxrate: num, reducedtaxrate: num, taxfreerate: num }` -- `T19` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null, shippable: bool }` -- `T20` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null, shippable?: bool }` -- `T21` = `{ id: int, manifestId: int, number: str, carrierId: int, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` -- `T22` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }` -- `T23` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` -- `T24` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }` -- `T25` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` -- `T26` = `{ id: int, printeragentId: int, type: str, enabled: bool, sort: int, model?: str|null, serial?: str|null }` -- `T27` = `{ name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }` -- `T28` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` -- `T29` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` -- `T30` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` -- `T31` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` -- `T32` = `{ id: int, name: str, sort: int, hasPackages: bool, isReverse: bool }` -- `T33` = `{ name: str|null, sizeBytes: int, backedUp: bool, reason?: str|null }` -- `T34` = `{ id: int, email: str, selectedCompanyId: int|null, picture?: str }` -- `T35` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` -- `T36` = `{ id: int, entityId: int, contactType: str, contact: str }` -- `T37` = `{ id: int, name: str, createdAt: str, updatedAt: str }` -- `T38` = `{ totalPositions: int, completelyOnLedgerPositions: int }` -- `T39` = `{ name: str, sizeBytes: int, sourceExists: bool }` -- `T40` = `{ net: num, taxId: int, taxRate?: num|null }` +- `T13` = `{ id: int, printeragentId: int, type: str, enabled: bool, sort: int, model?: str|null, serial?: str|null, open?: bool, pause?: bool, error?: bool, online?: bool, labelLength?: int|null }` +- `T14` = `{ id: int, entityId: int, addressType: str, firstName?: str|null, name?: str|null, street?: str|null, streetNumber?: str|null, zip?: str|null, city?: str|null, county?: str|null }` +- `T15` = `{ id: int, company_id: int, prompt: str, max_itr: int, cron: str, created_at: str, desc?: str|null, skills?: str|null, lastagentnote?: str|null, lastrun_at?: str|null }` +- `T16` = `{ id: int, manifestarticle_id: int, transaction_type: str, amount: num, transaction_text: str, hash_version: int, prev_hash?: str, sku?: str|null, created_at?: str }` +- `T17` = `{ id: int, name: str, sort: int, exclusive: bool, values: T30[], articleCount?: int }` +- `T18` = `{ id: int, companyuser_id: int, provider: str, model: str, created_at: str, updated_at: str, state: str, started_by?: int|null, first_message?: str|null }` +- `T19` = `{ id: int, name: str, rootCategoryId: int|null, languageId: int|null, iso639: str|null, taxrate: num, reducedtaxrate: num, taxfreerate: num }` +- `T20` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null, shippable: bool }` +- `T21` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null, shippable?: bool }` +- `T22` = `{ id: int, agentprinterId: int, type: str, state: str, data: str, createdAt: str, printeragentId?: int|null, completedAt?: str|null }` +- `T23` = `{ id: int, manifestId: int, number: str, carrierId: int, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` +- `T24` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }` +- `T25` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` +- `T26` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }` +- `T27` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` +- `T28` = `{ name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }` +- `T29` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` +- `T30` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` +- `T31` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` +- `T32` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` +- `T33` = `{ id: int, name: str, sort: int, hasPackages: bool, isReverse: bool }` +- `T34` = `{ name: str|null, sizeBytes: int, backedUp: bool, reason?: str|null }` +- `T35` = `{ id: int, email: str, selectedCompanyId: int|null, picture?: str }` +- `T36` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` +- `T37` = `{ id: int, entityId: int, contactType: str, contact: str }` +- `T38` = `{ id: int, name: str, createdAt: str, updatedAt: str }` +- `T39` = `{ totalPositions: int, completelyOnLedgerPositions: int }` +- `T40` = `{ name: str, sizeBytes: int, sourceExists: bool }` +- `T41` = `{ net: num, taxId: int, taxRate?: num|null }` ### Routes @@ -93,7 +94,7 @@ _none_ #### List agent printers — `GET /agentprinter` - Params: `query: printeragentId?: int` -- Returns: `200 { agentprinters: T26[] }` +- Returns: `200 { agentprinters: T13[] }` #### Reorder agent printers — `PUT /agentprinter/order` - Params: `body: { printeragentId: int, agentprinterIds: int[] }` - Returns: `200 { agentprinterIds: int[] }` @@ -102,10 +103,10 @@ _none_ - Returns: `204 void` #### Get agent printer — `GET /agentprinter/{id}` - Params: `id: int` -- Returns: `200 { agentprinter: T26 }` +- Returns: `200 { agentprinter: T13 }` #### Update agent printer — `PATCH /agentprinter/{id}` - Params: `id: int, body: { enabled?: bool, sort?: int }` -- Returns: `200 { agentprinter: T26 }` +- Returns: `200 { agentprinter: T13 }` ### Section: /article @@ -123,7 +124,7 @@ _none_ - Returns: `204 void` #### Get article by SKU — `GET /article/{sku}` - Params: `sku: str` -- Returns: `200 { article: { id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T28, brand: T27|null, categoryIds: int[], photos: { sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }[], eans: str[], prices: { minmultiplier: num, net: num, taxRate: num, customergroupId: int }[], suppliers: T8[], undeliveredOrders: { orderId: int, orderNumber: str, date: str, amount: num, customerName?: str|null }[] } }` +- Returns: `200 { article: { id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T29, brand: T28|null, categoryIds: int[], photos: { sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }[], eans: str[], prices: { minmultiplier: num, net: num, taxRate: num, customergroupId: int }[], suppliers: T8[], undeliveredOrders: { orderId: int, orderNumber: str, date: str, amount: num, customerName?: str|null }[] } }` #### Update article by SKU — `PATCH /article/{sku}` - Params: `sku: str, body: { name?: str, desc?: str, seo?: str, unitamount?: num, unitSi?: str, track_stock?: bool }` - Returns: `204 void` @@ -222,19 +223,19 @@ _none_ #### List attribute names — `GET /attributename` _none_ -- Returns: `200 { attributenames: T16[] }` +- Returns: `200 { attributenames: T17[] }` #### Create attribute name — `POST /attributename` - Params: `body: { name: str, sort?: int, exclusive?: bool }` -- Returns: `201 { attributename: T16 }` +- Returns: `201 { attributename: T17 }` #### Reorder attribute names — `PUT /attributename/order` - Params: `body: { attributenameIds: int[] }` - Returns: `200 { ok: bool }` #### List values for an attribute — `GET /attributename/{attributeId}/value` - Params: `attributeId: int` -- Returns: `200 { values: T29[] }` +- Returns: `200 { values: T30[] }` #### Create value for an attribute — `POST /attributename/{attributeId}/value` - Params: `attributeId: int, body: { value: str, sort?: int }` -- Returns: `201 { attributevalue: T29 }` +- Returns: `201 { attributevalue: T30 }` #### Reorder values of an attribute — `PUT /attributename/{attributeId}/value/order` - Params: `attributeId: int, body: { attributevalueIds: int[] }` - Returns: `200 { ok: bool }` @@ -243,7 +244,7 @@ _none_ - Returns: `200 { ok: bool }` #### Update attribute name — `PATCH /attributename/{id}` - Params: `id: int, body: { name?: str, sort?: int, exclusive?: bool }` -- Returns: `200 { attributename: T16 }` +- Returns: `200 { attributename: T17 }` ### Section: /attributevalue @@ -252,28 +253,28 @@ _none_ - Returns: `200 { ok: bool }` #### Update attribute value — `PATCH /attributevalue/{id}` - Params: `id: int, body: { value?: str, sort?: int }` -- Returns: `200 { attributevalue: T29 }` +- Returns: `200 { attributevalue: T30 }` #### Delete attribute value image — `DELETE /attributevalue/{id}/image` - Params: `id: int` -- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T35[] } }` +- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T36[] } }` #### Add or replace attribute value image — `POST /attributevalue/{id}/image` - Params: `id: int, image/avif` -- Returns: `201 { attributevalue: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T35[] } }` +- Returns: `201 { attributevalue: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T36[] } }` ### Section: /auth #### Login with Google ID token — `POST /auth/login` - Params: `body: { idToken: str }` -- Returns: `200 { message: str, user: T34 }` +- Returns: `200 { message: str, user: T35 }` #### Logout — `POST /auth/logout` _none_ - Returns: `200 { message: str }` #### Current user — `GET /auth/me` _none_ -- Returns: `200 { user: T34, googleClientId: str, schemaVersion: int, vhost: bool, vhostSettings: str }` +- Returns: `200 { user: T35, googleClientId: str, schemaVersion: int, vhost: bool, vhostSettings: str }` #### Set selected company — `PUT /auth/selected-company` - Params: `body: { companyId: int }` -- Returns: `200 { user: T34 }` +- Returns: `200 { user: T35 }` ### Section: /backup @@ -294,7 +295,7 @@ _none_ - Returns: `200 { brands: { id: int, name: str, articleCount: int, pics: { fullHash: str, thumbW: int, thumbH: int, thumbHash: str, smallThumbW?: int|null, smallThumbH?: int|null, smallThumbBinary?: str|null }[], gsprpinfo?: str|null }[], total: int, offset: int, limit: int }` #### Create brand — `POST /brand` - Params: `body: { name: str, gsprpinfo?: str }` -- Returns: `201 { brand: { id: int, name: str, pics: T35[], gsprpinfo?: str|null } }` +- Returns: `201 { brand: { id: int, name: str, pics: T36[], gsprpinfo?: str|null } }` #### Delete brand — `DELETE /brand/{id}` - Params: `id: int` - Returns: `204 void` @@ -303,19 +304,19 @@ _none_ - Returns: `200 { brand: { id: int, name: str, touchedArticleCount: int, gsprpinfo?: str|null } }` #### Delete brand image — `DELETE /brand/{id}/image` - Params: `id: int` -- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T35[] } }` +- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T36[] } }` #### Add or replace brand image — `POST /brand/{id}/image` - Params: `id: int, image/avif` -- Returns: `201 { brand: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T35[] } }` +- Returns: `201 { brand: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T36[] } }` ### Section: /carrier #### List carriers — `GET /carrier` _none_ -- Returns: `200 { carriers: T32[] }` +- Returns: `200 { carriers: T33[] }` #### Create carrier — `POST /carrier` - Params: `body: { name: str, sort?: int, hasPackages?: bool, isReverse?: bool }` -- Returns: `201 { carrier: T32 }` +- Returns: `201 { carrier: T33 }` #### Reorder carriers — `PUT /carrier/order` - Params: `body: { carrierIds: int[] }` - Returns: `200 { carrierIds: int[] }` @@ -324,10 +325,10 @@ _none_ - Returns: `204 void` #### Get carrier by ID — `GET /carrier/{id}` - Params: `id: int` -- Returns: `200 { carrier: T32 }` +- Returns: `200 { carrier: T33 }` #### Update carrier — `PATCH /carrier/{id}` - Params: `id: int, body: { name?: str, sort?: int, hasPackages?: bool, isReverse?: bool }` -- Returns: `200 { carrier: T32 }` +- Returns: `200 { carrier: T33 }` ### Section: /category @@ -351,7 +352,7 @@ _none_ - Returns: `200 { category: { id: int, name: str, slug: str, parentId: int, sort: int } }` #### Articles in category — `GET /category/{id}/articles` - Params: `id: int, query: includeChildren?: bool` -- Returns: `200 { articles: { id: int, sku: str, name: str, slug: str, track_stock: bool, optionsCount: int, articleListCount: int, childCount: int, net?: num|null, taxRate?: num|null, parentArticleId?: int|null, parentSku?: str|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null, smallThumbW?: int|null, smallThumbH?: int|null, smallThumbBinary?: str|null, brand?: T27|null, articlewarehousesummary?: { id: int, articleId: int, warehouseId: int, stock: num, article_id?: int, warehouse_id?: int, warehouseName?: str|null }[], warehouses?: { id: int, name: str, stock: num }[] }[] }` +- Returns: `200 { articles: { id: int, sku: str, name: str, slug: str, track_stock: bool, optionsCount: int, articleListCount: int, childCount: int, net?: num|null, taxRate?: num|null, parentArticleId?: int|null, parentSku?: str|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null, smallThumbW?: int|null, smallThumbH?: int|null, smallThumbBinary?: str|null, brand?: T28|null, articlewarehousesummary?: { id: int, articleId: int, warehouseId: int, stock: num, article_id?: int, warehouse_id?: int, warehouseName?: str|null }[], warehouses?: { id: int, name: str, stock: num }[] }[] }` #### List category attribute values — `GET /category/{id}/attributevalue` - Params: `id: int` - Returns: `200 { attributevalues: { id: int, attributeId: int, attributeName: str, attributeValueId: int, value: str, sort: int, categoryId?: int, exclusive?: bool }[] }` @@ -381,10 +382,10 @@ _none_ #### List companies — `GET /company` _none_ -- Returns: `200 { companies: T18[] }` +- Returns: `200 { companies: T19[] }` #### Create company — `POST /company` - Params: `body: { iso639: str, name: str, taxrate: num, reducedtaxrate: num }` -- Returns: `201 { company: T18, user: T34 }` +- Returns: `201 { company: T19, user: T35 }` #### Export company catalog as zip archive (SSE) — `GET /company/export` - Params: `query: stream?: str` - Returns: `200 SSE` @@ -414,7 +415,7 @@ _none_ - Returns: `204 void` #### Update company — `PUT /company/{id}` - Params: `id: int, body: { iso639: str, name: str, taxrate: num, reducedtaxrate: num }` -- Returns: `200 { company: T18 }` +- Returns: `200 { company: T19 }` ### Section: /customergroup @@ -438,7 +439,7 @@ _none_ #### List deliveries — `GET /delivery` - Params: `query: offset?: int, limit?: int, search?: str, onlyUnbooked?: bool, supplierId?: int, seekMonths?: int` -- Returns: `200 { deliveries: { id: int, number: str, type: str, supplierId: int, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T38 }[], total: int, unfilteredTotal: int, offset: int, limit: int }` +- Returns: `200 { deliveries: { id: int, number: str, type: str, supplierId: int, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T39 }[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create delivery — `POST /delivery` - Params: `body: { externalNumber: str, date: str, supplierId: int, lines: { amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` - Returns: `201 { delivery: T4 }` @@ -465,46 +466,46 @@ _none_ #### List entities — `GET /entity` - Params: `query: customergroupId?: int, role?: str` -- Returns: `200 { entities: T25[] }` +- Returns: `200 { entities: T27[] }` #### Create entity — `POST /entity` - Params: `body: { customergroupId: int, name: str, firstName?: str|null, number?: str }` -- Returns: `201 { entity: T25 }` +- Returns: `201 { entity: T27 }` #### Peek next customer number — `GET /entity/next-number` _none_ - Returns: `200 { number: str }` #### List entity addresses — `GET /entity/{entityId}/address` - Params: `entityId: int` -- Returns: `200 { addresses: T13[] }` +- Returns: `200 { addresses: T14[] }` #### Create entity address — `POST /entity/{entityId}/address` - Params: `entityId: int, body: { addressType: str, firstName?: str|null, name?: str|null, street?: str|null, streetNumber?: str|null, zip?: str|null, city?: str|null, county?: str|null }` -- Returns: `201 { address: T13 }` +- Returns: `201 { address: T14 }` #### Delete entity address — `DELETE /entity/{entityId}/address/{id}` - Params: `entityId: int, id: int` - Returns: `204 void` #### Update entity address — `PATCH /entity/{entityId}/address/{id}` - Params: `entityId: int, id: int, body: { addressType?: str, firstName?: str|null, name?: str|null, street?: str|null, streetNumber?: str|null, zip?: str|null, city?: str|null, county?: str|null }` -- Returns: `200 { address: T13 }` +- Returns: `200 { address: T14 }` #### List entity contacts — `GET /entity/{entityId}/contact` - Params: `entityId: int` -- Returns: `200 { contacts: T36[] }` +- Returns: `200 { contacts: T37[] }` #### Create entity contact — `POST /entity/{entityId}/contact` - Params: `entityId: int, body: { contactType: str, contact: str }` -- Returns: `201 { contact: T36 }` +- Returns: `201 { contact: T37 }` #### Delete entity contact — `DELETE /entity/{entityId}/contact/{id}` - Params: `entityId: int, id: int` - Returns: `204 void` #### Update entity contact — `PATCH /entity/{entityId}/contact/{id}` - Params: `entityId: int, id: int, body: { contactType?: str, contact?: str }` -- Returns: `200 { contact: T36 }` +- Returns: `200 { contact: T37 }` #### Delete entity — `DELETE /entity/{id}` - Params: `id: int` - Returns: `204 void` #### Get entity — `GET /entity/{id}` - Params: `id: int` -- Returns: `200 { entity: T25 }` +- Returns: `200 { entity: T27 }` #### Update entity — `PATCH /entity/{id}` - Params: `id: int, body: { name?: str, firstName?: str|null, number?: str|null }` -- Returns: `200 { entity: T25 }` +- Returns: `200 { entity: T27 }` ### Section: /events @@ -524,6 +525,9 @@ _none_ - `propertyname`: `{}` - `labeltemplate`: `{}` - `printer`: `{}` + - `printeragent`: `{}` + - `agentprinter`: `{ printers } or {}` + - `printerjob`: `{ job } or { jobId, state }` - `warehouse`: `{}` - `supplier`: `{}` - `vfs`: `{}` @@ -552,7 +556,7 @@ _none_ _none_ - Returns: `200 { labeltemplates: { id: int, name: str, width: num, height: num, dpi: int, type: str, thumb?: str|null }[] }` #### Create label template — `POST /labeltemplate` -- Params: `body: { name: str, width: num, height: num, dpi: int, type: str, content: { objects: T23[] } }` +- Params: `body: { name: str, width: num, height: num, dpi: int, type: str, content: { objects: T25[] } }` - Returns: `201 { labeltemplate: T9 }` #### Delete label template — `DELETE /labeltemplate/{id}` - Params: `id: int` @@ -561,26 +565,26 @@ _none_ - Params: `id: int` - Returns: `200 { labeltemplate: T9 }` #### Update label template (partial) — `PATCH /labeltemplate/{id}` -- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T23[] } }` +- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T25[] } }` - Returns: `200 { labeltemplate: T9 }` #### Update label template — `PUT /labeltemplate/{id}` -- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T23[] } }` +- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T25[] } }` - Returns: `200 { labeltemplate: T9 }` ### Section: /ledger #### Query ledger by manifest article ID or SKU — `GET /ledger` - Params: `query: manifestarticle_id?: int, sku?: str, transaction_type?: str` -- Returns: `200 { ledger: T15[] }` +- Returns: `200 { ledger: T16[] }` #### Query company-wide ledger history — `GET /ledger/history` - Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int` - Returns: `200 { ledger: { id: int, date: str, transaction_type: str, transaction_text: str, sku?: str|null, name?: str|null, amount?: num }[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Query ledger by manifest article ID — `GET /ledger/manifestarticle/{manifestarticleId}` - Params: `manifestarticleId: int, query: transaction_type?: str` -- Returns: `200 { ledger: T15[] }` +- Returns: `200 { ledger: T16[] }` #### Query ledger by article SKU — `GET /ledger/sku/{sku}` - Params: `sku: str, query: transaction_type?: str` -- Returns: `200 { ledger: T15[] }` +- Returns: `200 { ledger: T16[] }` ### Section: /mcp @@ -610,16 +614,16 @@ _none_ #### List conversations — `GET /modelconversation` _none_ -- Returns: `200 { conversations: T17[] }` +- Returns: `200 { conversations: T18[] }` #### Create conversation — `POST /modelconversation` - Params: `body: { provider: str, model: str }` -- Returns: `201 { conversation: T17 }` +- Returns: `201 { conversation: T18 }` #### Delete conversation — `DELETE /modelconversation/{id}` - Params: `id: int` - Returns: `204 void` #### Get conversation — `GET /modelconversation/{id}` - Params: `id: int` -- Returns: `200 { conversation: T17 }` +- Returns: `200 { conversation: T18 }` #### List conversation messages — `GET /modelconversation/{id}/message` - Params: `id: int` - Returns: `200 { messages: { id: int, conversation_id: int, created_at: str, role: str, message: str }[] }` @@ -660,7 +664,7 @@ _none_ - Params: `query: offset?: int, limit?: int, search?: str, onlyUnpaid?: bool, onlyUndelivered?: bool, seekMonths?: int` - Returns: `200 { orders: T1[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create order — `POST /order` -- Params: `body: { number: str, date: str, entityId: int, lines: T20[], externalNumber?: str|null }` +- Params: `body: { number: str, date: str, entityId: int, lines: T21[], externalNumber?: str|null }` - Returns: `201 { order: T1 }` #### Delete order — `DELETE /order/{id}` - Params: `id: int` @@ -669,7 +673,7 @@ _none_ - Params: `id: int` - Returns: `200 { order: T1 }` #### Update order — `PATCH /order/{id}` -- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T20[] }` +- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T21[] }` - Returns: `200 { order: T1 }` #### Delete order file attachment — `DELETE /order/{id}/file/{fileId}` - Params: `id: int, fileId: int` @@ -679,10 +683,10 @@ _none_ - Returns: `200 str` #### List payments of an order — `GET /order/{id}/payment` - Params: `id: int` -- Returns: `200 { payments: T31[] }` +- Returns: `200 { payments: T32[] }` #### Add payment to an order — `POST /order/{id}/payment` - Params: `id: int, body: { accountId: int, type: str, amount: num }` -- Returns: `201 { payment: T31 }` +- Returns: `201 { payment: T32 }` #### Generate and attach order PDF — `POST /order/{id}/pdf` - Params: `id: int` - Returns: `201 { attachment: T10, fileUrl: str }` @@ -694,10 +698,10 @@ _none_ - Returns: `201 { shipment: T2 }` #### List shippings of an order — `GET /order/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T21[] }` +- Returns: `200 { shippings: T23[] }` #### Create shipping for an order — `POST /order/{id}/shipping` - Params: `id: int, body: { carrierId: int, type: str, state: str, trackingCode?: str, warehouseId?: int }` -- Returns: `201 { shipping: T21 }` +- Returns: `201 { shipping: T23 }` ### Section: /package @@ -742,10 +746,10 @@ _none_ #### List printers — `GET /printer` _none_ -- Returns: `200 { printers: T24[] }` +- Returns: `200 { printers: T26[] }` #### Create printer — `POST /printer` - Params: `body: { address: str, type: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }` -- Returns: `201 { printer: T24 }` +- Returns: `201 { printer: T26 }` #### Reorder printers — `PUT /printer/order` - Params: `body: { printerIds: int[] }` - Returns: `200 { printerIds: int[] }` @@ -757,13 +761,13 @@ _none_ - Returns: `204 void` #### Get printer by ID — `GET /printer/{id}` - Params: `id: int` -- Returns: `200 { printer: T24 }` +- Returns: `200 { printer: T26 }` #### Update printer (partial) — `PATCH /printer/{id}` - Params: `id: int, body: { address?: str, type?: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }` -- Returns: `200 { printer: T24 }` +- Returns: `200 { printer: T26 }` #### Update printer — `PUT /printer/{id}` - Params: `id: int, body: { address?: str, type?: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }` -- Returns: `200 { printer: T24 }` +- Returns: `200 { printer: T26 }` #### Get live state for a printer — `GET /printer/{id}/state` - Params: `id: str` - Returns: `200 { printer: {} }` @@ -783,14 +787,32 @@ _none_ - Params: `id: int, body: { name?: str, sort?: int, enabled?: bool }` - Returns: `200 { printeragent: T12 }` +### Section: /printerjob + +#### List printer jobs — `GET /printerjob` +- Params: `query: agentprinterId?: int, state?: str` +- Returns: `200 { printerjobs: T22[] }` +#### Create print job — `POST /printerjob` +- Params: `body: { agentprinterId: int, data: str, type?: str }` +- Returns: `201 { printerjob: T22 }` +#### Cancel and delete printer job — `DELETE /printerjob/{id}` +- Params: `id: int` +- Returns: `200 { success: bool, deletedJob: T22 }` +#### Get printer job — `GET /printerjob/{id}` +- Params: `id: int` +- Returns: `200 { printerjob: T22 }` +#### Cancel printer job — `POST /printerjob/{id}/cancel` +- Params: `id: int` +- Returns: `200 { success: bool, printerjob: T22 }` + ### Section: /propertyname #### List property names — `GET /propertyname` _none_ -- Returns: `200 { propertynames: T30[] }` +- Returns: `200 { propertynames: T31[] }` #### Create property name — `POST /propertyname` - Params: `body: { name: str, sort?: int, exclusive?: bool }` -- Returns: `201 { propertyname: T30 }` +- Returns: `201 { propertyname: T31 }` #### Reorder property names — `PUT /propertyname/order` - Params: `body: { propertynameIds: int[] }` - Returns: `200 { ok: bool }` @@ -799,7 +821,7 @@ _none_ - Returns: `200 { ok: bool }` #### Update property name — `PATCH /propertyname/{id}` - Params: `id: int, body: { name?: str, sort?: int, exclusive?: bool }` -- Returns: `200 { propertyname: T30 }` +- Returns: `200 { propertyname: T31 }` ### Section: /public @@ -811,7 +833,7 @@ _none_ - Returns: `200 { articles: { id: int, sku: str, name: str, slug: str, net: num|null, taxRate: num|null, gross: num|null, trackStock: bool, brand: { id: int|null, name: str }, fullHash: str|null, thumbW: int|null, thumbH: int|null, thumbHash: str|null }[] }` #### Get public article detail — `GET /public/{companyId}/articles/{sku}` - Params: `companyId: int, sku: str` -- Returns: `200 { article: { id: int, sku: str, name: str, slug: str, description: str, unitamount: num|null, weight: num|null, trackStock: bool, unit: T28|null, brand: T27|null, price: { minmultiplier: num, net: num|null, taxRate: num|null, gross: num|null }, prices: { minmultiplier: num, net: num|null, taxRate: num|null, gross: num|null }[], categories: { id: int, name: str, slug: str }[], photos: { sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }[], eans: str[], isParent: bool, parentSku: str|null, variants: { id: int, sku: str, sort: int, name: str, slug: str, attributeValueId: int|null, attributeValue: str|null, unitamount: num|null, weight: num|null, trackStock: bool }[] } }` +- Returns: `200 { article: { id: int, sku: str, name: str, slug: str, description: str, unitamount: num|null, weight: num|null, trackStock: bool, unit: T29|null, brand: T28|null, price: { minmultiplier: num, net: num|null, taxRate: num|null, gross: num|null }, prices: { minmultiplier: num, net: num|null, taxRate: num|null, gross: num|null }[], categories: { id: int, name: str, slug: str }[], photos: { sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }[], eans: str[], isParent: bool, parentSku: str|null, variants: { id: int, sku: str, sort: int, name: str, slug: str, attributeValueId: int|null, attributeValue: str|null, unitamount: num|null, weight: num|null, trackStock: bool }[] } }` #### List public categories — `GET /public/{companyId}/categories` - Params: `companyId: int` - Returns: `200 { categories: { id: int, parentId: int|null, sort: int, name: str, slug: str, fullHash: str|null, thumbW: int|null, thumbH: int|null, thumbHash: str|null }[] }` @@ -822,7 +844,7 @@ _none_ - Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int` - Returns: `200 { quotes: T3[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create quote — `POST /quote` -- Params: `body: { number: str, date: str, lines: T20[], entityId?: int|null, externalNumber?: str|null }` +- Params: `body: { number: str, date: str, lines: T21[], entityId?: int|null, externalNumber?: str|null }` - Returns: `201 { quote: T3 }` #### Delete quote — `DELETE /quote/{id}` - Params: `id: int` @@ -831,7 +853,7 @@ _none_ - Params: `id: int` - Returns: `200 { quote: T3 }` #### Update quote — `PATCH /quote/{id}` -- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T20[] }` +- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T21[] }` - Returns: `200 { quote: T3 }` #### Delete quote file attachment — `DELETE /quote/{id}/file/{fileId}` - Params: `id: int, fileId: int` @@ -840,7 +862,7 @@ _none_ - Params: `id: int, fileId: int, query: download?: bool` - Returns: `200 str` #### Create order from quote — `POST /quote/{id}/order` -- Params: `id: int, body?: { number?: str, date?: str, createdAt?: str, entityId?: int|null, externalNumber?: str|null, lines?: T20[] }` +- Params: `id: int, body?: { number?: str, date?: str, createdAt?: str, entityId?: int|null, externalNumber?: str|null, lines?: T21[] }` - Returns: `201 { order: T1 }` #### Generate and attach quote PDF — `POST /quote/{id}/pdf` - Params: `id: int` @@ -934,10 +956,10 @@ _none_ - Returns: `201 { attachment: T10, fileUrl: str }` #### List packages of a shipment — `GET /shipment/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T21[] }` +- Returns: `200 { shippings: T23[] }` #### Create package for a shipment — `POST /shipment/{id}/shipping` - Params: `id: int, body: { carrierId: int, type: str, state: str, trackingCode?: str, warehouseId?: int }` -- Returns: `201 { shipping: T21 }` +- Returns: `201 { shipping: T23 }` ### Section: /shipping @@ -946,7 +968,7 @@ _none_ - Returns: `204 void` #### Update shipping — `PATCH /shipping/{id}` - Params: `id: int, body: { type?: str, state?: str, trackingCode?: str, carrierId?: int, warehouseId?: int }` -- Returns: `200 { shipping: T21 }` +- Returns: `200 { shipping: T23 }` #### List packages of a shipping — `GET /shipping/{id}/package` - Params: `id: int` - Returns: `200 { packages: { id: int, shippingId: int, entityaddressId: int, number: str, type: str, state: str, details?: str|null }[] }` @@ -967,7 +989,7 @@ _none_ - Returns: `200` #### Adjust stock manually — `POST /stock/adjust` - Params: `body: { sku?: str, warehouseId?: int, amount?: num, text?: str|null, lines?: { sku: str, amount: num, warehouseId?: int, text?: str }[] }` -- Returns: `201 { manifest: { id: int, number: str, type: str, date: str, createdAt: str }, lines: { manifestarticle_id: int, sku: str, name: str, warehouse_id: int, amount: num, text: str }[], ledger: T15[] }` +- Returns: `201 { manifest: { id: int, number: str, type: str, date: str, createdAt: str }, lines: { manifestarticle_id: int, sku: str, name: str, warehouse_id: int, amount: num, text: str }[], ledger: T16[] }` #### Ship shipment manifest item(s) — `POST /stock/ship` - Params: `body: { manifestarticleId?: int, warehouseId?: int, items?: { manifestarticleId: int, warehouseId?: int }[] }` - Returns: `200` @@ -976,40 +998,40 @@ _none_ #### List subagent schedules — `GET /subagentschedule` _none_ -- Returns: `200 { schedules: T14[] }` +- Returns: `200 { schedules: T15[] }` #### Create subagent schedule — `POST /subagentschedule` - Params: `body: { prompt: str, cron: str, desc?: str|null, skills?: str|null, lastagentnote?: str|null, max_itr?: int }` -- Returns: `201 { schedule: T14 }` +- Returns: `201 { schedule: T15 }` #### Delete subagent schedule — `DELETE /subagentschedule/{id}` - Params: `id: int` - Returns: `204 void` #### Get subagent schedule by ID — `GET /subagentschedule/{id}` - Params: `id: int` -- Returns: `200 { schedule: T14 }` +- Returns: `200 { schedule: T15 }` #### Update subagent schedule — `PUT /subagentschedule/{id}` - Params: `id: int, body: { prompt?: str, cron?: str, desc?: str|null, skills?: str|null, lastagentnote?: str|null, max_itr?: int, lastrun_at?: str|null }` -- Returns: `200 { schedule: T14 }` +- Returns: `200 { schedule: T15 }` ### Section: /supplier #### List suppliers — `GET /supplier` _none_ -- Returns: `200 { suppliers: T37[] }` +- Returns: `200 { suppliers: T38[] }` #### Create supplier — `POST /supplier` - Params: `body: { name: str }` -- Returns: `201 { supplier: T37 }` +- Returns: `201 { supplier: T38 }` #### Delete supplier — `DELETE /supplier/{id}` - Params: `id: int` - Returns: `204 void` #### Update supplier — `PATCH /supplier/{id}` - Params: `id: int, body: { name: str }` -- Returns: `200 { supplier: T37 }` +- Returns: `200 { supplier: T38 }` #### List supplier articles by SKUs — `GET /supplier/{id}/articles` - Params: `id: int, query: skus?: str` -- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T40|null, incoming?: { date: str, amount: num }[] }[] }` +- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T41|null, incoming?: { date: str, amount: num }[] }[] }` #### Query supplier articles by SKUs (bulk) — `POST /supplier/{id}/articles` - Params: `id: int, body?: { skus?: str[] }` -- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T40|null, incoming?: { date: str, amount: num }[] }[] }` +- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T41|null, incoming?: { date: str, amount: num }[] }[] }` ### Section: /thumb @@ -1024,10 +1046,10 @@ _none_ - Returns: `204 void` #### List units — `GET /unit` _none_ -- Returns: `200 { units: T28[] }` +- Returns: `200 { units: T29[] }` #### Upsert unit — `PUT /unit` - Params: `body: { si: str, basesi: str, basesifactor: num, symbol: str, name: str }` -- Returns: `200 { unit: T28 }` +- Returns: `200 { unit: T29 }` ### Section: /v1 @@ -1118,3 +1140,9 @@ _none_ #### Update warehouse — `PUT /warehouse/{id}` - Params: `id: int, body: { name?: str, sort?: int }` - Returns: `200 { warehouse: { id: int, name: str, sort: int } }` + +### Section: /zpljob + +#### Create ZPL print job — `POST /zpljob` +- Params: `body: { agentprinterId: int, data: str, copiescount?: int }` +- Returns: `201 { printerjob: T22 }` diff --git a/docs/api/routes.md b/docs/api/routes.md index 9a6f559..26c305a 100644 --- a/docs/api/routes.md +++ b/docs/api/routes.md @@ -1,6 +1,6 @@ # Dash API Routes Overview -Overview of all 219 API endpoints across all modules. +Overview of all 225 API endpoints across all modules. ### Notation @@ -9,36 +9,37 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). ### Reusable types -- `T1` = `{ id: int, number: str, type: str, entityId: int, date: str, lines: T13[], externalNumber?: str|null, createdAt?: str, shipping?: T15|null, shippings?: T15[], payment?: T24|null, payments?: T24[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T2[], files?: T7[] }` -- `T2` = `{ id: int, number: str, type: str, date: str, lines: T13[], shippings: T15[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T7[], state?: str }` -- `T3` = `{ id: int, number: str, type: str, date: str, lines: T13[], entityId?: int|null, externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T7[] }` -- `T4` = `{ id: int, number: str, type: str, supplierId: int, date: str, lines: T16[], files: T7[], externalNumber?: str|null, createdAt?: str, ledger?: T29 }` -- `T5` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T30|null, incoming?: { date: str, amount: num }[] }` -- `T6` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: { objects: T17[] }, thumb?: str|null }` +- `T1` = `{ id: int, number: str, type: str, entityId: int, date: str, lines: T14[], externalNumber?: str|null, createdAt?: str, shipping?: T17|null, shippings?: T17[], payment?: T25|null, payments?: T25[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T2[], files?: T7[] }` +- `T2` = `{ id: int, number: str, type: str, date: str, lines: T14[], shippings: T17[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T7[], state?: str }` +- `T3` = `{ id: int, number: str, type: str, date: str, lines: T14[], entityId?: int|null, externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T7[] }` +- `T4` = `{ id: int, number: str, type: str, supplierId: int, date: str, lines: T18[], files: T7[], externalNumber?: str|null, createdAt?: str, ledger?: T30 }` +- `T5` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T31|null, incoming?: { date: str, amount: num }[] }` +- `T6` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: { objects: T19[] }, thumb?: str|null }` - `T7` = `{ id: int, manifestId: int, fileId: int, sort: int, hash: str, mimetype: str, name: str, size: int, created?: str, modified?: str, skeledash?: str|null, thumbx?: int|null, thumby?: int|null, meta?: { [k]: str }|null }` - `T8` = `{ id: int, name: str, companyId?: int, token?: str|null, pairingpin?: str|null, pairedAt?: str|null, agentversion?: str|null, lastseenAt?: str|null, updatedAt?: str, sort?: int, enabled?: bool }` -- `T9` = `{ id: int, entityId: int, addressType: str, firstName?: str|null, name?: str|null, street?: str|null, streetNumber?: str|null, zip?: str|null, city?: str|null, county?: str|null }` -- `T10` = `{ id: int, company_id: int, prompt: str, max_itr: int, cron: str, created_at: str, desc?: str|null, skills?: str|null, lastagentnote?: str|null, lastrun_at?: str|null }` -- `T11` = `{ id: int, manifestarticle_id: int, transaction_type: str, amount: num, transaction_text: str, hash_version: int, prev_hash?: str, sku?: str|null, created_at?: str }` -- `T12` = `{ id: int, name: str, sort: int, exclusive: bool, values: T22[], articleCount?: int }` -- `T13` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null, shippable: bool }` -- `T14` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null, shippable?: bool }` -- `T15` = `{ id: int, manifestId: int, number: str, carrierId: int, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` -- `T16` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }` -- `T17` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` -- `T18` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }` -- `T19` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` -- `T20` = `{ id: int, printeragentId: int, type: str, enabled: bool, sort: int, model?: str|null, serial?: str|null }` -- `T21` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` -- `T22` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` -- `T23` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` -- `T24` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` -- `T25` = `{ id: int, name: str, sort: int, hasPackages: bool, isReverse: bool }` -- `T26` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` -- `T27` = `{ id: int, entityId: int, contactType: str, contact: str }` -- `T28` = `{ id: int, name: str, createdAt: str, updatedAt: str }` -- `T29` = `{ totalPositions: int, completelyOnLedgerPositions: int }` -- `T30` = `{ net: num, taxId: int, taxRate?: num|null }` +- `T9` = `{ id: int, printeragentId: int, type: str, enabled: bool, sort: int, model?: str|null, serial?: str|null, open?: bool, pause?: bool, error?: bool, online?: bool, labelLength?: int|null }` +- `T10` = `{ id: int, entityId: int, addressType: str, firstName?: str|null, name?: str|null, street?: str|null, streetNumber?: str|null, zip?: str|null, city?: str|null, county?: str|null }` +- `T11` = `{ id: int, company_id: int, prompt: str, max_itr: int, cron: str, created_at: str, desc?: str|null, skills?: str|null, lastagentnote?: str|null, lastrun_at?: str|null }` +- `T12` = `{ id: int, manifestarticle_id: int, transaction_type: str, amount: num, transaction_text: str, hash_version: int, prev_hash?: str, sku?: str|null, created_at?: str }` +- `T13` = `{ id: int, name: str, sort: int, exclusive: bool, values: T23[], articleCount?: int }` +- `T14` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null, shippable: bool }` +- `T15` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null, shippable?: bool }` +- `T16` = `{ id: int, agentprinterId: int, type: str, state: str, data: str, createdAt: str, printeragentId?: int|null, completedAt?: str|null }` +- `T17` = `{ id: int, manifestId: int, number: str, carrierId: int, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` +- `T18` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }` +- `T19` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` +- `T20` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }` +- `T21` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` +- `T22` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` +- `T23` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` +- `T24` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` +- `T25` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` +- `T26` = `{ id: int, name: str, sort: int, hasPackages: bool, isReverse: bool }` +- `T27` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` +- `T28` = `{ id: int, entityId: int, contactType: str, contact: str }` +- `T29` = `{ id: int, name: str, createdAt: str, updatedAt: str }` +- `T30` = `{ totalPositions: int, completelyOnLedgerPositions: int }` +- `T31` = `{ net: num, taxId: int, taxRate?: num|null }` ### Routes @@ -62,7 +63,7 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). #### List agent printers — `GET /agentprinter` - Params: `query: printeragentId?: int` -- Returns: `200 { agentprinters: T20[] }` +- Returns: `200 { agentprinters: T9[] }` #### Reorder agent printers — `PUT /agentprinter/order` - Params: `body: { printeragentId: int, agentprinterIds: int[] }` - Returns: `200 { agentprinterIds: int[] }` @@ -71,10 +72,10 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). - Returns: `204 void` #### Get agent printer — `GET /agentprinter/{id}` - Params: `id: int` -- Returns: `200 { agentprinter: T20 }` +- Returns: `200 { agentprinter: T9 }` #### Update agent printer — `PATCH /agentprinter/{id}` - Params: `id: int, body: { enabled?: bool, sort?: int }` -- Returns: `200 { agentprinter: T20 }` +- Returns: `200 { agentprinter: T9 }` ### Section: /article @@ -89,7 +90,7 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). - Returns: `204 void` #### Get article by SKU — `GET /article/{sku}` - Params: `sku: str` -- Returns: `200 { article: { id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T21, brand: { name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }, categoryIds: int[], photos: { sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }[], eans: str[], prices: { minmultiplier: num, net: num, taxRate: num, customergroupId: int }[], suppliers: T5[], undeliveredOrders: { orderId: int, orderNumber: str, date: str, amount: num, customerName?: str|null }[] } }` +- Returns: `200 { article: { id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T22, brand: { name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }, categoryIds: int[], photos: { sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }[], eans: str[], prices: { minmultiplier: num, net: num, taxRate: num, customergroupId: int }[], suppliers: T5[], undeliveredOrders: { orderId: int, orderNumber: str, date: str, amount: num, customerName?: str|null }[] } }` #### Update article by SKU — `PATCH /article/{sku}` - Params: `sku: str, body: { name?: str, desc?: str, seo?: str, unitamount?: num, unitSi?: str, track_stock?: bool }` - Returns: `204 void` @@ -185,19 +186,19 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). #### List attribute names — `GET /attributename` _none_ -- Returns: `200 { attributenames: T12[] }` +- Returns: `200 { attributenames: T13[] }` #### Create attribute name — `POST /attributename` - Params: `body: { name: str, sort?: int, exclusive?: bool }` -- Returns: `201 { attributename: T12 }` +- Returns: `201 { attributename: T13 }` #### Reorder attribute names — `PUT /attributename/order` - Params: `body: { attributenameIds: int[] }` - Returns: `200 { ok: bool }` #### List values for an attribute — `GET /attributename/{attributeId}/value` - Params: `attributeId: int` -- Returns: `200 { values: T22[] }` +- Returns: `200 { values: T23[] }` #### Create value for an attribute — `POST /attributename/{attributeId}/value` - Params: `attributeId: int, body: { value: str, sort?: int }` -- Returns: `201 { attributevalue: T22 }` +- Returns: `201 { attributevalue: T23 }` #### Reorder values of an attribute — `PUT /attributename/{attributeId}/value/order` - Params: `attributeId: int, body: { attributevalueIds: int[] }` - Returns: `200 { ok: bool }` @@ -206,7 +207,7 @@ _none_ - Returns: `200 { ok: bool }` #### Update attribute name — `PATCH /attributename/{id}` - Params: `id: int, body: { name?: str, sort?: int, exclusive?: bool }` -- Returns: `200 { attributename: T12 }` +- Returns: `200 { attributename: T13 }` ### Section: /attributevalue @@ -215,10 +216,10 @@ _none_ - Returns: `200 { ok: bool }` #### Update attribute value — `PATCH /attributevalue/{id}` - Params: `id: int, body: { value?: str, sort?: int }` -- Returns: `200 { attributevalue: T22 }` +- Returns: `200 { attributevalue: T23 }` #### Delete attribute value image — `DELETE /attributevalue/{id}/image` - Params: `id: int` -- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T26[] } }` +- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T27[] } }` ### Section: /brand @@ -227,7 +228,7 @@ _none_ - Returns: `200 { brands: { id: int, name: str, articleCount: int, pics: { fullHash: str, thumbW: int, thumbH: int, thumbHash: str, smallThumbW?: int|null, smallThumbH?: int|null, smallThumbBinary?: str|null }[], gsprpinfo?: str|null }[], total: int, offset: int, limit: int }` #### Create brand — `POST /brand` - Params: `body: { name: str, gsprpinfo?: str }` -- Returns: `201 { brand: { id: int, name: str, pics: T26[], gsprpinfo?: str|null } }` +- Returns: `201 { brand: { id: int, name: str, pics: T27[], gsprpinfo?: str|null } }` #### Delete brand — `DELETE /brand/{id}` - Params: `id: int` - Returns: `204 void` @@ -236,16 +237,16 @@ _none_ - Returns: `200 { brand: { id: int, name: str, touchedArticleCount: int, gsprpinfo?: str|null } }` #### Delete brand image — `DELETE /brand/{id}/image` - Params: `id: int` -- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T26[] } }` +- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T27[] } }` ### Section: /carrier #### List carriers — `GET /carrier` _none_ -- Returns: `200 { carriers: T25[] }` +- Returns: `200 { carriers: T26[] }` #### Create carrier — `POST /carrier` - Params: `body: { name: str, sort?: int, hasPackages?: bool, isReverse?: bool }` -- Returns: `201 { carrier: T25 }` +- Returns: `201 { carrier: T26 }` #### Reorder carriers — `PUT /carrier/order` - Params: `body: { carrierIds: int[] }` - Returns: `200 { carrierIds: int[] }` @@ -254,10 +255,10 @@ _none_ - Returns: `204 void` #### Get carrier by ID — `GET /carrier/{id}` - Params: `id: int` -- Returns: `200 { carrier: T25 }` +- Returns: `200 { carrier: T26 }` #### Update carrier — `PATCH /carrier/{id}` - Params: `id: int, body: { name?: str, sort?: int, hasPackages?: bool, isReverse?: bool }` -- Returns: `200 { carrier: T25 }` +- Returns: `200 { carrier: T26 }` ### Section: /category @@ -350,7 +351,7 @@ _none_ #### List deliveries — `GET /delivery` - Params: `query: offset?: int, limit?: int, search?: str, onlyUnbooked?: bool, supplierId?: int, seekMonths?: int` -- Returns: `200 { deliveries: { id: int, number: str, type: str, supplierId: int, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T29 }[], total: int, unfilteredTotal: int, offset: int, limit: int }` +- Returns: `200 { deliveries: { id: int, number: str, type: str, supplierId: int, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T30 }[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create delivery — `POST /delivery` - Params: `body: { externalNumber: str, date: str, supplierId: int, lines: { amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` - Returns: `201 { delivery: T4 }` @@ -374,46 +375,46 @@ _none_ #### List entities — `GET /entity` - Params: `query: customergroupId?: int, role?: str` -- Returns: `200 { entities: T19[] }` +- Returns: `200 { entities: T21[] }` #### Create entity — `POST /entity` - Params: `body: { customergroupId: int, name: str, firstName?: str|null, number?: str }` -- Returns: `201 { entity: T19 }` +- Returns: `201 { entity: T21 }` #### Peek next customer number — `GET /entity/next-number` _none_ - Returns: `200 { number: str }` #### List entity addresses — `GET /entity/{entityId}/address` - Params: `entityId: int` -- Returns: `200 { addresses: T9[] }` +- Returns: `200 { addresses: T10[] }` #### Create entity address — `POST /entity/{entityId}/address` - Params: `entityId: int, body: { addressType: str, firstName?: str|null, name?: str|null, street?: str|null, streetNumber?: str|null, zip?: str|null, city?: str|null, county?: str|null }` -- Returns: `201 { address: T9 }` +- Returns: `201 { address: T10 }` #### Delete entity address — `DELETE /entity/{entityId}/address/{id}` - Params: `entityId: int, id: int` - Returns: `204 void` #### Update entity address — `PATCH /entity/{entityId}/address/{id}` - Params: `entityId: int, id: int, body: { addressType?: str, firstName?: str|null, name?: str|null, street?: str|null, streetNumber?: str|null, zip?: str|null, city?: str|null, county?: str|null }` -- Returns: `200 { address: T9 }` +- Returns: `200 { address: T10 }` #### List entity contacts — `GET /entity/{entityId}/contact` - Params: `entityId: int` -- Returns: `200 { contacts: T27[] }` +- Returns: `200 { contacts: T28[] }` #### Create entity contact — `POST /entity/{entityId}/contact` - Params: `entityId: int, body: { contactType: str, contact: str }` -- Returns: `201 { contact: T27 }` +- Returns: `201 { contact: T28 }` #### Delete entity contact — `DELETE /entity/{entityId}/contact/{id}` - Params: `entityId: int, id: int` - Returns: `204 void` #### Update entity contact — `PATCH /entity/{entityId}/contact/{id}` - Params: `entityId: int, id: int, body: { contactType?: str, contact?: str }` -- Returns: `200 { contact: T27 }` +- Returns: `200 { contact: T28 }` #### Delete entity — `DELETE /entity/{id}` - Params: `id: int` - Returns: `204 void` #### Get entity — `GET /entity/{id}` - Params: `id: int` -- Returns: `200 { entity: T19 }` +- Returns: `200 { entity: T21 }` #### Update entity — `PATCH /entity/{id}` - Params: `id: int, body: { name?: str, firstName?: str|null, number?: str|null }` -- Returns: `200 { entity: T19 }` +- Returns: `200 { entity: T21 }` ### Section: /health @@ -427,7 +428,7 @@ _none_ _none_ - Returns: `200 { labeltemplates: { id: int, name: str, width: num, height: num, dpi: int, type: str, thumb?: str|null }[] }` #### Create label template — `POST /labeltemplate` -- Params: `body: { name: str, width: num, height: num, dpi: int, type: str, content: { objects: T17[] } }` +- Params: `body: { name: str, width: num, height: num, dpi: int, type: str, content: { objects: T19[] } }` - Returns: `201 { labeltemplate: T6 }` #### Delete label template — `DELETE /labeltemplate/{id}` - Params: `id: int` @@ -436,26 +437,26 @@ _none_ - Params: `id: int` - Returns: `200 { labeltemplate: T6 }` #### Update label template (partial) — `PATCH /labeltemplate/{id}` -- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T17[] } }` +- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T19[] } }` - Returns: `200 { labeltemplate: T6 }` #### Update label template — `PUT /labeltemplate/{id}` -- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T17[] } }` +- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T19[] } }` - Returns: `200 { labeltemplate: T6 }` ### Section: /ledger #### Query ledger by manifest article ID or SKU — `GET /ledger` - Params: `query: manifestarticle_id?: int, sku?: str, transaction_type?: str` -- Returns: `200 { ledger: T11[] }` +- Returns: `200 { ledger: T12[] }` #### Query company-wide ledger history — `GET /ledger/history` - Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int` - Returns: `200 { ledger: { id: int, date: str, transaction_type: str, transaction_text: str, sku?: str|null, name?: str|null, amount?: num }[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Query ledger by manifest article ID — `GET /ledger/manifestarticle/{manifestarticleId}` - Params: `manifestarticleId: int, query: transaction_type?: str` -- Returns: `200 { ledger: T11[] }` +- Returns: `200 { ledger: T12[] }` #### Query ledger by article SKU — `GET /ledger/sku/{sku}` - Params: `sku: str, query: transaction_type?: str` -- Returns: `200 { ledger: T11[] }` +- Returns: `200 { ledger: T12[] }` ### Section: /number @@ -472,7 +473,7 @@ _none_ - Params: `query: offset?: int, limit?: int, search?: str, onlyUnpaid?: bool, onlyUndelivered?: bool, seekMonths?: int` - Returns: `200 { orders: T1[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create order — `POST /order` -- Params: `body: { number: str, date: str, entityId: int, lines: T14[], externalNumber?: str|null }` +- Params: `body: { number: str, date: str, entityId: int, lines: T15[], externalNumber?: str|null }` - Returns: `201 { order: T1 }` #### Delete order — `DELETE /order/{id}` - Params: `id: int` @@ -481,17 +482,17 @@ _none_ - Params: `id: int` - Returns: `200 { order: T1 }` #### Update order — `PATCH /order/{id}` -- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T14[] }` +- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T15[] }` - Returns: `200 { order: T1 }` #### Delete order file attachment — `DELETE /order/{id}/file/{fileId}` - Params: `id: int, fileId: int` - Returns: `204 void` #### List payments of an order — `GET /order/{id}/payment` - Params: `id: int` -- Returns: `200 { payments: T24[] }` +- Returns: `200 { payments: T25[] }` #### Add payment to an order — `POST /order/{id}/payment` - Params: `id: int, body: { accountId: int, type: str, amount: num }` -- Returns: `201 { payment: T24 }` +- Returns: `201 { payment: T25 }` #### Generate and attach order PDF — `POST /order/{id}/pdf` - Params: `id: int` - Returns: `201 { attachment: T7, fileUrl: str }` @@ -503,10 +504,10 @@ _none_ - Returns: `201 { shipment: T2 }` #### List shippings of an order — `GET /order/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T15[] }` +- Returns: `200 { shippings: T17[] }` #### Create shipping for an order — `POST /order/{id}/shipping` - Params: `id: int, body: { carrierId: int, type: str, state: str, trackingCode?: str, warehouseId?: int }` -- Returns: `201 { shipping: T15 }` +- Returns: `201 { shipping: T17 }` ### Section: /package @@ -524,10 +525,10 @@ _none_ #### List printers — `GET /printer` _none_ -- Returns: `200 { printers: T18[] }` +- Returns: `200 { printers: T20[] }` #### Create printer — `POST /printer` - Params: `body: { address: str, type: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }` -- Returns: `201 { printer: T18 }` +- Returns: `201 { printer: T20 }` #### Reorder printers — `PUT /printer/order` - Params: `body: { printerIds: int[] }` - Returns: `200 { printerIds: int[] }` @@ -539,13 +540,13 @@ _none_ - Returns: `204 void` #### Get printer by ID — `GET /printer/{id}` - Params: `id: int` -- Returns: `200 { printer: T18 }` +- Returns: `200 { printer: T20 }` #### Update printer (partial) — `PATCH /printer/{id}` - Params: `id: int, body: { address?: str, type?: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }` -- Returns: `200 { printer: T18 }` +- Returns: `200 { printer: T20 }` #### Update printer — `PUT /printer/{id}` - Params: `id: int, body: { address?: str, type?: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }` -- Returns: `200 { printer: T18 }` +- Returns: `200 { printer: T20 }` #### Get live state for a printer — `GET /printer/{id}/state` - Params: `id: str` - Returns: `200 { printer: {} }` @@ -565,14 +566,32 @@ _none_ - Params: `id: int, body: { name?: str, sort?: int, enabled?: bool }` - Returns: `200 { printeragent: T8 }` +### Section: /printerjob + +#### List printer jobs — `GET /printerjob` +- Params: `query: agentprinterId?: int, state?: str` +- Returns: `200 { printerjobs: T16[] }` +#### Create print job — `POST /printerjob` +- Params: `body: { agentprinterId: int, data: str, type?: str }` +- Returns: `201 { printerjob: T16 }` +#### Cancel and delete printer job — `DELETE /printerjob/{id}` +- Params: `id: int` +- Returns: `200 { success: bool, deletedJob: T16 }` +#### Get printer job — `GET /printerjob/{id}` +- Params: `id: int` +- Returns: `200 { printerjob: T16 }` +#### Cancel printer job — `POST /printerjob/{id}/cancel` +- Params: `id: int` +- Returns: `200 { success: bool, printerjob: T16 }` + ### Section: /propertyname #### List property names — `GET /propertyname` _none_ -- Returns: `200 { propertynames: T23[] }` +- Returns: `200 { propertynames: T24[] }` #### Create property name — `POST /propertyname` - Params: `body: { name: str, sort?: int, exclusive?: bool }` -- Returns: `201 { propertyname: T23 }` +- Returns: `201 { propertyname: T24 }` #### Reorder property names — `PUT /propertyname/order` - Params: `body: { propertynameIds: int[] }` - Returns: `200 { ok: bool }` @@ -581,7 +600,7 @@ _none_ - Returns: `200 { ok: bool }` #### Update property name — `PATCH /propertyname/{id}` - Params: `id: int, body: { name?: str, sort?: int, exclusive?: bool }` -- Returns: `200 { propertyname: T23 }` +- Returns: `200 { propertyname: T24 }` ### Section: /quote @@ -589,7 +608,7 @@ _none_ - Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int` - Returns: `200 { quotes: T3[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create quote — `POST /quote` -- Params: `body: { number: str, date: str, lines: T14[], entityId?: int|null, externalNumber?: str|null }` +- Params: `body: { number: str, date: str, lines: T15[], entityId?: int|null, externalNumber?: str|null }` - Returns: `201 { quote: T3 }` #### Delete quote — `DELETE /quote/{id}` - Params: `id: int` @@ -598,13 +617,13 @@ _none_ - Params: `id: int` - Returns: `200 { quote: T3 }` #### Update quote — `PATCH /quote/{id}` -- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T14[] }` +- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T15[] }` - Returns: `200 { quote: T3 }` #### Delete quote file attachment — `DELETE /quote/{id}/file/{fileId}` - Params: `id: int, fileId: int` - Returns: `204 void` #### Create order from quote — `POST /quote/{id}/order` -- Params: `id: int, body?: { number?: str, date?: str, createdAt?: str, entityId?: int|null, externalNumber?: str|null, lines?: T14[] }` +- Params: `id: int, body?: { number?: str, date?: str, createdAt?: str, entityId?: int|null, externalNumber?: str|null, lines?: T15[] }` - Returns: `201 { order: T1 }` #### Generate and attach quote PDF — `POST /quote/{id}/pdf` - Params: `id: int` @@ -680,10 +699,10 @@ _none_ - Returns: `201 { attachment: T7, fileUrl: str }` #### List packages of a shipment — `GET /shipment/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T15[] }` +- Returns: `200 { shippings: T17[] }` #### Create package for a shipment — `POST /shipment/{id}/shipping` - Params: `id: int, body: { carrierId: int, type: str, state: str, trackingCode?: str, warehouseId?: int }` -- Returns: `201 { shipping: T15 }` +- Returns: `201 { shipping: T17 }` ### Section: /shipping @@ -692,7 +711,7 @@ _none_ - Returns: `204 void` #### Update shipping — `PATCH /shipping/{id}` - Params: `id: int, body: { type?: str, state?: str, trackingCode?: str, carrierId?: int, warehouseId?: int }` -- Returns: `200 { shipping: T15 }` +- Returns: `200 { shipping: T17 }` #### List packages of a shipping — `GET /shipping/{id}/package` - Params: `id: int` - Returns: `200 { packages: { id: int, shippingId: int, entityaddressId: int, number: str, type: str, state: str, details?: str|null }[] }` @@ -713,7 +732,7 @@ _none_ - Returns: `200` #### Adjust stock manually — `POST /stock/adjust` - Params: `body: { sku?: str, warehouseId?: int, amount?: num, text?: str|null, lines?: { sku: str, amount: num, warehouseId?: int, text?: str }[] }` -- Returns: `201 { manifest: { id: int, number: str, type: str, date: str, createdAt: str }, lines: { manifestarticle_id: int, sku: str, name: str, warehouse_id: int, amount: num, text: str }[], ledger: T11[] }` +- Returns: `201 { manifest: { id: int, number: str, type: str, date: str, createdAt: str }, lines: { manifestarticle_id: int, sku: str, name: str, warehouse_id: int, amount: num, text: str }[], ledger: T12[] }` #### Ship shipment manifest item(s) — `POST /stock/ship` - Params: `body: { manifestarticleId?: int, warehouseId?: int, items?: { manifestarticleId: int, warehouseId?: int }[] }` - Returns: `200` @@ -722,40 +741,40 @@ _none_ #### List subagent schedules — `GET /subagentschedule` _none_ -- Returns: `200 { schedules: T10[] }` +- Returns: `200 { schedules: T11[] }` #### Create subagent schedule — `POST /subagentschedule` - Params: `body: { prompt: str, cron: str, desc?: str|null, skills?: str|null, lastagentnote?: str|null, max_itr?: int }` -- Returns: `201 { schedule: T10 }` +- Returns: `201 { schedule: T11 }` #### Delete subagent schedule — `DELETE /subagentschedule/{id}` - Params: `id: int` - Returns: `204 void` #### Get subagent schedule by ID — `GET /subagentschedule/{id}` - Params: `id: int` -- Returns: `200 { schedule: T10 }` +- Returns: `200 { schedule: T11 }` #### Update subagent schedule — `PUT /subagentschedule/{id}` - Params: `id: int, body: { prompt?: str, cron?: str, desc?: str|null, skills?: str|null, lastagentnote?: str|null, max_itr?: int, lastrun_at?: str|null }` -- Returns: `200 { schedule: T10 }` +- Returns: `200 { schedule: T11 }` ### Section: /supplier #### List suppliers — `GET /supplier` _none_ -- Returns: `200 { suppliers: T28[] }` +- Returns: `200 { suppliers: T29[] }` #### Create supplier — `POST /supplier` - Params: `body: { name: str }` -- Returns: `201 { supplier: T28 }` +- Returns: `201 { supplier: T29 }` #### Delete supplier — `DELETE /supplier/{id}` - Params: `id: int` - Returns: `204 void` #### Update supplier — `PATCH /supplier/{id}` - Params: `id: int, body: { name: str }` -- Returns: `200 { supplier: T28 }` +- Returns: `200 { supplier: T29 }` #### List supplier articles by SKUs — `GET /supplier/{id}/articles` - Params: `id: int, query: skus?: str` -- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T30|null, incoming?: { date: str, amount: num }[] }[] }` +- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T31|null, incoming?: { date: str, amount: num }[] }[] }` #### Query supplier articles by SKUs (bulk) — `POST /supplier/{id}/articles` - Params: `id: int, body?: { skus?: str[] }` -- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T30|null, incoming?: { date: str, amount: num }[] }[] }` +- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T31|null, incoming?: { date: str, amount: num }[] }[] }` ### Section: /unit @@ -764,10 +783,10 @@ _none_ - Returns: `204 void` #### List units — `GET /unit` _none_ -- Returns: `200 { units: T21[] }` +- Returns: `200 { units: T22[] }` #### Upsert unit — `PUT /unit` - Params: `body: { si: str, basesi: str, basesifactor: num, symbol: str, name: str }` -- Returns: `200 { unit: T21 }` +- Returns: `200 { unit: T22 }` ### Section: /v1 @@ -801,6 +820,12 @@ _none_ #### Update warehouse — `PUT /warehouse/{id}` - Params: `id: int, body: { name?: str, sort?: int }` - Returns: `200 { warehouse: { id: int, name: str, sort: int } }` + +### Section: /zpljob + +#### Create ZPL print job — `POST /zpljob` +- Params: `body: { agentprinterId: int, data: str, copiescount?: int }` +- Returns: `201 { printerjob: T16 }` ### Binary & streaming routes (reachable only via `fetch()` in javascript_execute) These routes are NOT in the table above because their payloads (binary request body or binary response) or long-lived streams cannot be handled usefully by the `dashback_request` tool. They ARE reachable from inside `javascript_execute` with `fetch("/route")`: diff --git a/docs/api/routes/agentprinter.md b/docs/api/routes/agentprinter.md index ac4d2c2..8101382 100644 --- a/docs/api/routes/agentprinter.md +++ b/docs/api/routes/agentprinter.md @@ -28,7 +28,12 @@ List of agent printers "model": "…", "serial": "…", "enabled": true, - "sort": 1 + "sort": 1, + "open": true, + "pause": true, + "error": true, + "online": true, + "labelLength": 1 } ] } diff --git a/docs/api/routes/agentprinter/_id.get.md b/docs/api/routes/agentprinter/_id.get.md index 495584e..08aca1a 100644 --- a/docs/api/routes/agentprinter/_id.get.md +++ b/docs/api/routes/agentprinter/_id.get.md @@ -25,7 +25,12 @@ Agent printer details "model": "…", "serial": "…", "enabled": true, - "sort": 1 + "sort": 1, + "open": true, + "pause": true, + "error": true, + "online": true, + "labelLength": 1 } } ``` diff --git a/docs/api/routes/agentprinter/_id.patch.md b/docs/api/routes/agentprinter/_id.patch.md index 670f5f3..47f9fe4 100644 --- a/docs/api/routes/agentprinter/_id.patch.md +++ b/docs/api/routes/agentprinter/_id.patch.md @@ -44,7 +44,12 @@ Updated agent printer "model": "…", "serial": "…", "enabled": true, - "sort": 1 + "sort": 1, + "open": true, + "pause": true, + "error": true, + "online": true, + "labelLength": 1 } } ``` diff --git a/docs/api/routes/events.md b/docs/api/routes/events.md index d818dba..f41ac6e 100644 --- a/docs/api/routes/events.md +++ b/docs/api/routes/events.md @@ -48,6 +48,7 @@ emits `{ sender, brandId }`. | `printer` | `{}` | `POST /printer`, `PUT /printer/{id}`, `PATCH /printer/{id}`, `DELETE /printer/{id}` | | `printeragent` | `{}` | `PUT /printeragent`, `PATCH /printeragent/{id}`, `DELETE /printeragent/{id}`, printer agent connect/disconnect/state | | `agentprinter` | `{ printers }` or `{}` | `PATCH /agentprinter/{id}`, `PUT /agentprinter/order`, `DELETE /agentprinter/{id}`, agent state updates / printer discovery | +| `printerjob` | `{ job }` or `{ jobId, state }` | `POST /zpljob`, `POST /printerjob`, `POST /printerjob/{id}/cancel`, `DELETE /printerjob/{id}`, agent job state updates | | `warehouse` | `{}` | `POST /warehouse`, `PUT /warehouse/{id}`, `PATCH /warehouse/{id}`, `DELETE /warehouse/{id}` | | `supplier` | `{}` | `POST /supplier`, `PATCH /supplier/{id}`, `DELETE /supplier/{id}` | | `vfs` | `{}` | VFS uploads and filesystem mutations such as `POST /vfs/upload`, `POST /vfs/mkdir`, `POST /vfs/rename`, `PUT /vfs/{*path}`, `DELETE /vfs/{*path}` | diff --git a/docs/api/routes/printerjob.get.md b/docs/api/routes/printerjob.get.md new file mode 100644 index 0000000..dc8f968 --- /dev/null +++ b/docs/api/routes/printerjob.get.md @@ -0,0 +1,46 @@ +# `GET /printerjob` + +Protected. Requires a valid session cookie (`credentials: 'include'`). + +List printer jobs + +Lists printer jobs for the selected company, optionally filtered by agent printer or state. + +## Query parameters + +| Param | Required | Type | Description | +|-------|----------|------|-------------| +| `agentprinterId` | no | integer | Optional agent printer ID filter | +| `state` | no | string | Optional job state filter | + +## Response `200` + +List of printer jobs + +```json +{ + "printerjobs": [ + { + "id": 1, + "agentprinterId": 1, + "printeragentId": 1, + "type": "zpl", + "state": "pending", + "data": "…", + "createdAt": "2026-08-10T00:00:00.000Z", + "completedAt": "2026-08-10T00:00:00.000Z" + } + ] +} +``` + +## Errors + +| Status | Description | +|--------|-------------| +| 400 | No company selected — `{"error":"…"}` | +| 401 | Unauthorized — `{"error":"…"}` | + +--- + +_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._ diff --git a/docs/api/routes/printerjob.post.md b/docs/api/routes/printerjob.post.md new file mode 100644 index 0000000..44c5f53 --- /dev/null +++ b/docs/api/routes/printerjob.post.md @@ -0,0 +1,50 @@ +# `POST /printerjob` + +Protected. Requires a valid session cookie (`credentials: 'include'`). + +Create print job + +Creates a new print job for an agent printer. Notifies the agent in real time. + +## Body (JSON) + +| Field | Required | Type | Description | +|-------|----------|------|-------------| +| `agentprinterId` | yes | integer | | +| `type` | no | string | | +| `data` | yes | string | | + +```json +{ + "agentprinterId": 1, + "type": "zpl", + "data": "…" +} +``` + +## Signals + +On success, emits SSE signal: `printerjob` (see [`GET /events`](../events.md)). + +## Response `201` + +Printer job created + +```json +{ + "printerjob": { + "id": 1, + "agentprinterId": 1, + "printeragentId": 1, + "type": "zpl", + "state": "pending", + "data": "…", + "createdAt": "2026-08-10T00:00:00.000Z", + "completedAt": "2026-08-10T00:00:00.000Z" + } +} +``` + +--- + +_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._ diff --git a/docs/api/routes/printerjob/_id.delete.md b/docs/api/routes/printerjob/_id.delete.md new file mode 100644 index 0000000..bdf6273 --- /dev/null +++ b/docs/api/routes/printerjob/_id.delete.md @@ -0,0 +1,43 @@ +# `DELETE /printerjob/{id}` + +Protected. Requires a valid session cookie (`credentials: 'include'`). + +Cancel and delete printer job + +Cancels and deletes a print job. If the job was pending or processing, sends a cancellation +event to the connected printer agent before deletion. + + +## Path parameters + +| Param | Required | Type | Description | +|-------|----------|------|-------------| +| `id` | yes | integer | | + +## Signals + +On success, emits SSE signal: `printerjob` (see [`GET /events`](../events.md)). + +## Response `200` + +Job cancelled and deleted + +```json +{ + "success": true, + "deletedJob": { + "id": 1, + "agentprinterId": 1, + "printeragentId": 1, + "type": "zpl", + "state": "pending", + "data": "…", + "createdAt": "2026-08-10T00:00:00.000Z", + "completedAt": "2026-08-10T00:00:00.000Z" + } +} +``` + +--- + +_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._ diff --git a/docs/api/routes/printerjob/_id.get.md b/docs/api/routes/printerjob/_id.get.md new file mode 100644 index 0000000..22eadb0 --- /dev/null +++ b/docs/api/routes/printerjob/_id.get.md @@ -0,0 +1,44 @@ +# `GET /printerjob/{id}` + +Protected. Requires a valid session cookie (`credentials: 'include'`). + +Get printer job + +Retrieves details of a specific printer job by ID. + +## Path parameters + +| Param | Required | Type | Description | +|-------|----------|------|-------------| +| `id` | yes | integer | | + +## Response `200` + +Printer job details + +```json +{ + "printerjob": { + "id": 1, + "agentprinterId": 1, + "printeragentId": 1, + "type": "zpl", + "state": "pending", + "data": "…", + "createdAt": "2026-08-10T00:00:00.000Z", + "completedAt": "2026-08-10T00:00:00.000Z" + } +} +``` + +## Errors + +| Status | Description | +|--------|-------------| +| 400 | Invalid ID or no company selected — `{"error":"…"}` | +| 401 | Unauthorized — `{"error":"…"}` | +| 404 | Printer job not found — `{"error":"…"}` | + +--- + +_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._ diff --git a/docs/api/routes/printerjob/_id/cancel.md b/docs/api/routes/printerjob/_id/cancel.md new file mode 100644 index 0000000..dbafbca --- /dev/null +++ b/docs/api/routes/printerjob/_id/cancel.md @@ -0,0 +1,41 @@ +# `POST /printerjob/{id}/cancel` + +Protected. Requires a valid session cookie (`credentials: 'include'`). + +Cancel printer job + +Marks a print job as cancelled and notifies the connected agent in real time. + +## Path parameters + +| Param | Required | Type | Description | +|-------|----------|------|-------------| +| `id` | yes | integer | | + +## Signals + +On success, emits SSE signal: `printerjob` (see [`GET /events`](../events.md)). + +## Response `200` + +Printer job cancelled + +```json +{ + "success": true, + "printerjob": { + "id": 1, + "agentprinterId": 1, + "printeragentId": 1, + "type": "zpl", + "state": "pending", + "data": "…", + "createdAt": "2026-08-10T00:00:00.000Z", + "completedAt": "2026-08-10T00:00:00.000Z" + } +} +``` + +--- + +_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._ diff --git a/docs/api/routes/zpljob.md b/docs/api/routes/zpljob.md new file mode 100644 index 0000000..b7b992b --- /dev/null +++ b/docs/api/routes/zpljob.md @@ -0,0 +1,60 @@ +# `POST /zpljob` + +Protected. Requires a valid session cookie (`credentials: 'include'`). + +Create ZPL print job + +Issues a new ZPL print job to an agent printer. If copiescount > 1, the ZPL quantity command (^PQ) +is automatically applied. The connected printer agent receives an immediate real-time event. + + +## Body (JSON) + +| Field | Required | Type | Description | +|-------|----------|------|-------------| +| `agentprinterId` | yes | integer | Target agent printer ID | +| `copiescount` | no | integer | Optional copy count (defaults to 1) | +| `data` | yes | string | Raw ZPL string | + +```json +{ + "agentprinterId": 1, + "copiescount": 2, + "data": "^XA^FO50,50^ADN,36,20^FDHello Zebra^FS^XZ" +} +``` + +## Signals + +On success, emits SSE signal: `printerjob` (see [`GET /events`](../events.md)). + +## Response `201` + +Print job created + +```json +{ + "printerjob": { + "id": 1, + "agentprinterId": 1, + "printeragentId": 1, + "type": "zpl", + "state": "pending", + "data": "…", + "createdAt": "2026-08-10T00:00:00.000Z", + "completedAt": "2026-08-10T00:00:00.000Z" + } +} +``` + +## Errors + +| Status | Description | +|--------|-------------| +| 400 | Invalid input or missing fields — `{"error":"…"}` | +| 401 | Unauthorized — `{"error":"…"}` | +| 404 | Agent printer not found — `{"error":"…"}` | + +--- + +_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._ diff --git a/src/api/agent/index.js b/src/api/agent/index.js index 8a2fb9b..06cb62f 100644 --- a/src/api/agent/index.js +++ b/src/api/agent/index.js @@ -2,6 +2,7 @@ import express from 'express'; import crypto from 'node:crypto'; import * as db from '../../db/printeragent.js'; import * as agentprinterDb from '../../db/agentprinter.js'; +import * as printerjobDb from '../../db/printerjob.js'; import { agentAuthMiddleware, extractAgentVersion } from '../middleware/agentAuth.js'; import { emit } from '../sse.js'; import { createLogger } from '../../util/logger.js'; @@ -202,6 +203,36 @@ async function handlePair(req, res) { agentRouter.post('/pair', handlePair); agentRouter.get('/pair', handlePair); +const activeAgentEvents = new Map(); + +/** + * Notifies a connected agent of a new or cancelled printer job. + * @param {number} agentId + * @param {'created'|'cancelled'} action + * @param {object} job + * @returns {boolean} True if delivered to at least one active agent connection. + */ +export function notifyAgentJob(agentId, action, job) { + const aId = Number(agentId); + const conns = activeAgentEvents.get(aId); + if (!conns || conns.size === 0) return false; + const payload = JSON.stringify({ + action, + jobId: job.id, + agentprinterId: job.agentprinterId, + type: job.type, + state: job.state, + createdAt: job.createdAt, + }); + for (const clientRes of conns) { + if (!clientRes.writableEnded) { + clientRes.write(`event: job\ndata: ${payload}\n\n`); + clientRes.write(`event: printerjob\ndata: ${payload}\n\n`); + } + } + return true; +} + /** * @openapi * /agent/events: @@ -256,6 +287,12 @@ agentRouter.get('/events', agentAuthMiddleware, async (req, res) => { setAgentState(req.agent.id, 'online'); } + const aId = Number(req.agent.id); + if (!activeAgentEvents.has(aId)) { + activeAgentEvents.set(aId, new Set()); + } + activeAgentEvents.get(aId).add(res); + res.write(`event: connected\ndata: ${JSON.stringify({ agentId: req.agent.id, name: req.agent.name })}\n\n`); const keepAlive = setInterval(() => { @@ -269,6 +306,13 @@ agentRouter.get('/events', agentAuthMiddleware, async (req, res) => { if (closed) return; closed = true; clearInterval(keepAlive); + + const conns = activeAgentEvents.get(aId); + if (conns) { + conns.delete(res); + if (conns.size === 0) activeAgentEvents.delete(aId); + } + log.info(`Agent disconnected: id=${req.agent.id} ("${agentName}")`); setAgentState(req.agent.id, 'offline'); if (req.agent?.companyId) { @@ -393,3 +437,78 @@ agentRouter.get('/state', agentAuthMiddleware, (req, res) => { }); }); +// #region Agent Jobs + +agentRouter.get('/jobs', agentAuthMiddleware, async (req, res) => { + try { + const jobs = await printerjobDb.list({ agentId: req.agent.id }, req.query); + res.status(200).json({ jobs }); + } catch (err) { + log.error('Agent get jobs failed:', err); + res.status(500).json({ error: 'Internal server error' }); + } +}); + +agentRouter.get('/jobs/:id', agentAuthMiddleware, async (req, res) => { + try { + const job = await printerjobDb.getById({ agentId: req.agent.id }, req.params.id); + if (!job) { + return res.status(404).json({ error: 'Printerjob not found' }); + } + res.status(200).json({ job }); + } catch (err) { + log.error('Agent get job failed:', err); + res.status(500).json({ error: 'Internal server error' }); + } +}); + +agentRouter.post('/jobs/:id/processing', agentAuthMiddleware, async (req, res) => { + try { + const job = await printerjobDb.updateState({ agentId: req.agent.id }, req.params.id, 'processing'); + if (req.agent?.companyId) { + emit('printerjob', { companyId: req.agent.companyId, data: { job } }); + } + res.status(200).json({ success: true, job }); + } catch (err) { + if (err.message === 'Printerjob not found') return res.status(404).json({ error: err.message }); + log.error('Agent set job processing failed:', err); + res.status(500).json({ error: 'Internal server error' }); + } +}); + +agentRouter.post('/jobs/:id/completed', agentAuthMiddleware, async (req, res) => { + try { + const job = await printerjobDb.updateState({ agentId: req.agent.id }, req.params.id, 'completed'); + if (req.agent?.companyId) { + emit('printerjob', { companyId: req.agent.companyId, data: { job } }); + } + res.status(200).json({ success: true, job }); + } catch (err) { + if (err.message === 'Printerjob not found') return res.status(404).json({ error: err.message }); + log.error('Agent set job completed failed:', err); + res.status(500).json({ error: 'Internal server error' }); + } +}); + +agentRouter.patch('/jobs/:id', agentAuthMiddleware, async (req, res) => { + const state = req.body?.state; + if (!state) { + return res.status(400).json({ error: 'state is required' }); + } + try { + const job = await printerjobDb.updateState({ agentId: req.agent.id }, req.params.id, state); + if (req.agent?.companyId) { + emit('printerjob', { companyId: req.agent.companyId, data: { job } }); + } + res.status(200).json({ success: true, job }); + } catch (err) { + if (err.message === 'Printerjob not found') return res.status(404).json({ error: err.message }); + if (err.message?.startsWith('Invalid printerjob state')) return res.status(400).json({ error: err.message }); + log.error('Agent patch job failed:', err); + res.status(500).json({ error: 'Internal server error' }); + } +}); + +// #endregion + + diff --git a/src/api/middleware/auth.js b/src/api/middleware/auth.js index 658e881..22e1215 100644 --- a/src/api/middleware/auth.js +++ b/src/api/middleware/auth.js @@ -63,7 +63,7 @@ export const authMiddleware = async (req, res, next) => { return next(); } - if (req.path.startsWith('/api/agent')) { + if (req.path === '/api/agent' || req.path.startsWith('/api/agent/')) { return next(); } diff --git a/src/api/openapi.js b/src/api/openapi.js index c5ad55c..0b34644 100644 --- a/src/api/openapi.js +++ b/src/api/openapi.js @@ -1774,6 +1774,59 @@ * type: integer * description: Display order (ascending) * default: 0 + * open: + * type: boolean + * description: Whether the printer head/cover is open + * default: false + * pause: + * type: boolean + * description: Whether the printer is paused + * default: false + * error: + * type: boolean + * description: Whether the printer is in an error state + * default: false + * online: + * type: boolean + * description: Whether the printer is online and reachable + * default: false + * labelLength: + * type: integer + * nullable: true + * description: Discovered label length in dots/pixels reported by the printer + * default: null + * Printerjob: + * type: object + * required: [id, agentprinterId, type, state, data, createdAt] + * properties: + * id: + * type: integer + * agentprinterId: + * type: integer + * description: Target agent printer ID + * printeragentId: + * type: integer + * nullable: true + * description: Parent printer agent ID + * type: + * type: string + * description: Job format type ("zpl", "pdf", "epos") + * example: "zpl" + * state: + * type: string + * enum: [pending, processing, completed, cancelled, failed] + * description: Current processing state of the job + * example: "pending" + * data: + * type: string + * description: Raw job payload + * createdAt: + * type: string + * format: date-time + * completedAt: + * type: string + * format: date-time + * nullable: true * LabelObject: * type: object * required: [id, type, x, y] diff --git a/src/api/routes/agentprinter.js b/src/api/routes/agentprinter.js index 1aab69a..9d35f99 100644 --- a/src/api/routes/agentprinter.js +++ b/src/api/routes/agentprinter.js @@ -1,5 +1,6 @@ import * as db from '../../db/agentprinter.js'; import { emit } from '../sse.js'; +import { enrichAgentPrinter } from '../../services/companyPrinterService.js'; // #region Helpers @@ -91,7 +92,8 @@ export function register(app, basePath = '') { try { const printeragentId = req.query?.printeragentId ? Number(req.query.printeragentId) : undefined; const agentprinters = await db.list(req.user.id, printeragentId); - res.status(200).json({ agentprinters }); + const enriched = agentprinters.map((p) => enrichAgentPrinter(selected.companyId, p)); + res.status(200).json({ agentprinters: enriched }); } catch (error) { const status = agentprinterErrorStatus(error); if (status === 500) console.error('List agentprinters failed:', error); @@ -236,7 +238,7 @@ export function register(app, basePath = '') { if (!agentprinter) { return res.status(404).json({ error: 'Agentprinter not found' }); } - res.status(200).json({ agentprinter }); + res.status(200).json({ agentprinter: enrichAgentPrinter(selected.companyId, agentprinter) }); } catch (error) { const status = agentprinterErrorStatus(error); if (status === 500) console.error('Get agentprinter failed:', error); @@ -333,7 +335,7 @@ export function register(app, basePath = '') { try { const agentprinter = await db.update(req.user.id, payload); emit('agentprinter', { companyId: selected.companyId }); - res.status(200).json({ agentprinter }); + res.status(200).json({ agentprinter: enrichAgentPrinter(selected.companyId, agentprinter) }); } catch (error) { const status = agentprinterErrorStatus(error); if (status === 500) console.error('Update agentprinter failed:', error); diff --git a/src/api/routes/events.js b/src/api/routes/events.js index b609e08..1c13b40 100644 --- a/src/api/routes/events.js +++ b/src/api/routes/events.js @@ -57,6 +57,7 @@ export function register(app, basePath = '') { * | `printer` | `{}` | `POST /printer`, `PUT /printer/{id}`, `PATCH /printer/{id}`, `DELETE /printer/{id}` | * | `printeragent` | `{}` | `PUT /printeragent`, `PATCH /printeragent/{id}`, `DELETE /printeragent/{id}`, printer agent connect/disconnect/state | * | `agentprinter` | `{ printers }` or `{}` | `PATCH /agentprinter/{id}`, `PUT /agentprinter/order`, `DELETE /agentprinter/{id}`, agent state updates / printer discovery | + * | `printerjob` | `{ job }` or `{ jobId, state }` | `POST /zpljob`, `POST /printerjob`, `POST /printerjob/{id}/cancel`, `DELETE /printerjob/{id}`, agent job state updates | * | `warehouse` | `{}` | `POST /warehouse`, `PUT /warehouse/{id}`, `PATCH /warehouse/{id}`, `DELETE /warehouse/{id}` | * | `supplier` | `{}` | `POST /supplier`, `PATCH /supplier/{id}`, `DELETE /supplier/{id}` | * | `vfs` | `{}` | VFS uploads and filesystem mutations such as `POST /vfs/upload`, `POST /vfs/mkdir`, `POST /vfs/rename`, `PUT /vfs/{*path}`, `DELETE /vfs/{*path}` | @@ -99,6 +100,12 @@ export function register(app, basePath = '') { * payload: "{}" * - name: printer * payload: "{}" + * - name: printeragent + * payload: "{}" + * - name: agentprinter + * payload: "{ printers } or {}" + * - name: printerjob + * payload: "{ job } or { jobId, state }" * - name: warehouse * payload: "{}" * - name: supplier diff --git a/src/api/routes/printerjob.js b/src/api/routes/printerjob.js new file mode 100644 index 0000000..845e987 --- /dev/null +++ b/src/api/routes/printerjob.js @@ -0,0 +1,388 @@ +import * as printerjobDb from '../../db/printerjob.js'; +import { emit } from '../sse.js'; +import { notifyAgentJob } from '../agent/index.js'; + +// #region Helpers + +function requireSelectedCompany(req) { + const companyId = req.user?.selectedCompanyId; + if (companyId == null) { + return { error: 'No company selected' }; + } + return { companyId: Number(companyId) }; +} + +function parsePositiveInt(value, field) { + const id = Number(value); + if (!Number.isInteger(id) || id <= 0) { + return { error: `${field} must be a positive integer` }; + } + return { id }; +} + +function printerjobErrorStatus(error) { + if (error.message === 'No company selected') return 400; + if (error.message === 'Not authorized') return 403; + if (error.message === 'Company not found') return 404; + if (error.message === 'Agentprinter not found') return 404; + if (error.message === 'Printerjob not found') return 404; + if (error.message?.includes('is required')) return 400; + if (error.message?.startsWith('Invalid printerjob')) return 400; + return 500; +} + +// #endregion + +/** + * Registers printerjob routes. + * @param {import('express').Application} app + * @param {string} [basePath=''] + */ +export function register(app, basePath = '') { + /** + * @openapi + * /printerjob: + * get: + * tags: [PrinterJob] + * summary: List printer jobs + * description: Lists printer jobs for the selected company, optionally filtered by agent printer or state. + * security: + * - cookieAuth: [] + * parameters: + * - in: query + * name: agentprinterId + * schema: + * type: integer + * description: Optional agent printer ID filter + * - in: query + * name: state + * schema: + * type: string + * enum: [pending, processing, completed, cancelled, failed] + * description: Optional job state filter + * responses: + * 200: + * description: List of printer jobs + * content: + * application/json: + * schema: + * type: object + * properties: + * printerjobs: + * type: array + * items: + * $ref: '#/components/schemas/Printerjob' + * 400: + * description: No company selected + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 401: + * description: Unauthorized + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + */ + // #region GET /printerjob + + app.get(`${basePath}/printerjob`, async (req, res) => { + const selected = requireSelectedCompany(req); + if (selected.error) { + return res.status(400).json({ error: selected.error }); + } + + try { + const agentprinterId = req.query?.agentprinterId ? Number(req.query.agentprinterId) : undefined; + const state = req.query?.state ? String(req.query.state).trim().toLowerCase() : undefined; + const printerjobs = await printerjobDb.list(req.user.id, { agentprinterId, state }); + res.status(200).json({ printerjobs }); + } catch (error) { + const status = printerjobErrorStatus(error); + if (status === 500) console.error('List printerjobs failed:', error); + res.status(status).json({ error: error.message }); + } + }); + + // #endregion + + /** + * @openapi + * /printerjob/{id}: + * get: + * tags: [PrinterJob] + * summary: Get printer job + * description: Retrieves details of a specific printer job by ID. + * security: + * - cookieAuth: [] + * parameters: + * - in: path + * name: id + * required: true + * schema: + * type: integer + * responses: + * 200: + * description: Printer job details + * content: + * application/json: + * schema: + * type: object + * properties: + * printerjob: + * $ref: '#/components/schemas/Printerjob' + * 400: + * description: Invalid ID or no company selected + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 401: + * description: Unauthorized + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 404: + * description: Printer job not found + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + */ + // #region GET /printerjob/:id + + app.get(`${basePath}/printerjob/:id`, async (req, res) => { + const selected = requireSelectedCompany(req); + if (selected.error) { + return res.status(400).json({ error: selected.error }); + } + + const parsed = parsePositiveInt(req.params.id, 'id'); + if (parsed.error) { + return res.status(400).json({ error: parsed.error }); + } + + try { + const printerjob = await printerjobDb.getById(req.user.id, parsed.id); + if (!printerjob) { + return res.status(404).json({ error: 'Printerjob not found' }); + } + res.status(200).json({ printerjob }); + } catch (error) { + const status = printerjobErrorStatus(error); + if (status === 500) console.error('Get printerjob failed:', error); + res.status(status).json({ error: error.message }); + } + }); + + // #endregion + + /** + * @openapi + * /printerjob: + * post: + * tags: [PrinterJob] + * summary: Create print job + * description: Creates a new print job for an agent printer. Notifies the agent in real time. + * security: + * - cookieAuth: [] + * x-signals: [printerjob] + * requestBody: + * required: true + * content: + * application/json: + * schema: + * type: object + * required: [agentprinterId, data] + * properties: + * agentprinterId: + * type: integer + * type: + * type: string + * example: "zpl" + * data: + * type: string + * responses: + * 201: + * description: Printer job created + * content: + * application/json: + * schema: + * type: object + * properties: + * printerjob: + * $ref: '#/components/schemas/Printerjob' + */ + // #region POST /printerjob + + app.post(`${basePath}/printerjob`, async (req, res) => { + const selected = requireSelectedCompany(req); + if (selected.error) { + return res.status(400).json({ error: selected.error }); + } + + const rawApId = req.body?.agentprinterId ?? req.body?.agentprinterid; + const parsedApId = parsePositiveInt(rawApId, 'agentprinterId'); + if (parsedApId.error) { + return res.status(400).json({ error: parsedApId.error }); + } + + const rawData = req.body?.data; + if (!rawData || typeof rawData !== 'string' || !rawData.trim()) { + return res.status(400).json({ error: 'data is required' }); + } + + const type = typeof req.body?.type === 'string' && req.body.type.trim() + ? req.body.type.trim().toLowerCase() + : undefined; + + try { + const job = await printerjobDb.create(req.user.id, { + agentprinterId: parsedApId.id, + type, + data: rawData.trim(), + }); + + if (job.printeragentId) { + notifyAgentJob(job.printeragentId, 'created', job); + } + + emit('printerjob', { companyId: selected.companyId, data: { job } }); + res.status(201).json({ printerjob: job }); + } catch (error) { + const status = printerjobErrorStatus(error); + if (status === 500) console.error('Create printerjob failed:', error); + res.status(status).json({ error: error.message }); + } + }); + + // #endregion + + /** + * @openapi + * /printerjob/{id}/cancel: + * post: + * tags: [PrinterJob] + * summary: Cancel printer job + * description: Marks a print job as cancelled and notifies the connected agent in real time. + * security: + * - cookieAuth: [] + * x-signals: [printerjob] + * parameters: + * - in: path + * name: id + * required: true + * schema: + * type: integer + * responses: + * 200: + * description: Printer job cancelled + * content: + * application/json: + * schema: + * type: object + * properties: + * success: + * type: boolean + * printerjob: + * $ref: '#/components/schemas/Printerjob' + */ + // #region POST /printerjob/:id/cancel + + app.post(`${basePath}/printerjob/:id/cancel`, async (req, res) => { + const selected = requireSelectedCompany(req); + if (selected.error) { + return res.status(400).json({ error: selected.error }); + } + + const parsed = parsePositiveInt(req.params.id, 'id'); + if (parsed.error) { + return res.status(400).json({ error: parsed.error }); + } + + try { + const job = await printerjobDb.updateState(req.user.id, parsed.id, 'cancelled'); + + if (job.printeragentId) { + notifyAgentJob(job.printeragentId, 'cancelled', job); + } + + emit('printerjob', { companyId: selected.companyId, data: { job } }); + res.status(200).json({ success: true, printerjob: job }); + } catch (error) { + const status = printerjobErrorStatus(error); + if (status === 500) console.error('Cancel printerjob failed:', error); + res.status(status).json({ error: error.message }); + } + }); + + // #endregion + + /** + * @openapi + * /printerjob/{id}: + * delete: + * tags: [PrinterJob] + * summary: Cancel and delete printer job + * description: | + * Cancels and deletes a print job. If the job was pending or processing, sends a cancellation + * event to the connected printer agent before deletion. + * security: + * - cookieAuth: [] + * x-signals: [printerjob] + * parameters: + * - in: path + * name: id + * required: true + * schema: + * type: integer + * responses: + * 200: + * description: Job cancelled and deleted + * content: + * application/json: + * schema: + * type: object + * properties: + * success: + * type: boolean + * deletedJob: + * $ref: '#/components/schemas/Printerjob' + */ + // #region DELETE /printerjob/:id + + app.delete(`${basePath}/printerjob/:id`, async (req, res) => { + const selected = requireSelectedCompany(req); + if (selected.error) { + return res.status(400).json({ error: selected.error }); + } + + const parsed = parsePositiveInt(req.params.id, 'id'); + if (parsed.error) { + return res.status(400).json({ error: parsed.error }); + } + + try { + const job = await printerjobDb.deleteJob(req.user.id, parsed.id); + + if (job.printeragentId) { + notifyAgentJob(job.printeragentId, 'cancelled', job); + } + + emit('printerjob', { + companyId: selected.companyId, + data: { jobId: job.id, state: 'cancelled' }, + }); + res.status(200).json({ success: true, deletedJob: job }); + } catch (error) { + const status = printerjobErrorStatus(error); + if (status === 500) console.error('Delete printerjob failed:', error); + res.status(status).json({ error: error.message }); + } + }); + + // #endregion +} + diff --git a/src/api/routes/zpljob.js b/src/api/routes/zpljob.js new file mode 100644 index 0000000..ab4cf16 --- /dev/null +++ b/src/api/routes/zpljob.js @@ -0,0 +1,176 @@ +import * as printerjobDb from '../../db/printerjob.js'; +import { emit } from '../sse.js'; +import { notifyAgentJob } from '../agent/index.js'; + +// #region Helpers + +function requireSelectedCompany(req) { + const companyId = req.user?.selectedCompanyId; + if (companyId == null) { + return { error: 'No company selected' }; + } + return { companyId: Number(companyId) }; +} + +function parsePositiveInt(value, field) { + const id = Number(value); + if (!Number.isInteger(id) || id <= 0) { + return { error: `${field} must be a positive integer` }; + } + return { id }; +} + +function printerjobErrorStatus(error) { + if (error.message === 'No company selected') return 400; + if (error.message === 'Not authorized') return 403; + if (error.message === 'Company not found') return 404; + if (error.message === 'Agentprinter not found') return 404; + if (error.message === 'Printerjob not found') return 404; + if (error.message?.includes('is required')) return 400; + if (error.message?.startsWith('Invalid printerjob')) return 400; + return 500; +} + +/** + * Adjusts or inserts the ZPL print quantity command (^PQ) in the ZPL payload. + * + * @param {string} data - Raw ZPL string. + * @param {number|string} [copiescount=1] - Number of copies. + * @returns {string} + */ +export function applyZplCopies(data, copiescount) { + if (!data || typeof data !== 'string') return data; + const copies = Number(copiescount); + if (!Number.isInteger(copies) || copies <= 1) return data; + + if (/\^PQ\d+/i.test(data)) { + return data.replace(/\^PQ\d+/gi, `^PQ${copies}`); + } + + if (/\^XZ/i.test(data)) { + return data.replace(/\^XZ/gi, `^PQ${copies}\n^XZ`); + } + + return `${data}\n^PQ${copies}`; +} + +// #endregion + +/** + * Registers zpljob routes. + * @param {import('express').Application} app + * @param {string} [basePath=''] + */ +export function register(app, basePath = '') { + /** + * @openapi + * /zpljob: + * post: + * tags: [PrinterJob] + * summary: Create ZPL print job + * description: | + * Issues a new ZPL print job to an agent printer. If copiescount > 1, the ZPL quantity command (^PQ) + * is automatically applied. The connected printer agent receives an immediate real-time event. + * security: + * - cookieAuth: [] + * x-signals: [printerjob] + * requestBody: + * required: true + * content: + * application/json: + * schema: + * type: object + * required: [agentprinterId, data] + * properties: + * agentprinterId: + * type: integer + * description: Target agent printer ID + * example: 1 + * copiescount: + * type: integer + * description: Optional copy count (defaults to 1) + * default: 1 + * example: 2 + * data: + * type: string + * description: Raw ZPL string + * example: "^XA^FO50,50^ADN,36,20^FDHello Zebra^FS^XZ" + * responses: + * 201: + * description: Print job created + * content: + * application/json: + * schema: + * type: object + * properties: + * printerjob: + * $ref: '#/components/schemas/Printerjob' + * 400: + * description: Invalid input or missing fields + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 401: + * description: Unauthorized + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 404: + * description: Agent printer not found + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + */ + // #region POST /zpljob + + app.post(`${basePath}/zpljob`, async (req, res) => { + const selected = requireSelectedCompany(req); + if (selected.error) { + return res.status(400).json({ error: selected.error }); + } + + const rawApId = req.body?.agentprinterId ?? req.body?.agentprinterid; + const parsedApId = parsePositiveInt(rawApId, 'agentprinterId'); + if (parsedApId.error) { + return res.status(400).json({ error: parsedApId.error }); + } + + const rawData = req.body?.data; + if (!rawData || typeof rawData !== 'string' || !rawData.trim()) { + return res.status(400).json({ error: 'data is required' }); + } + + const rawCopies = req.body?.copiescount ?? req.body?.copiesCount ?? req.body?.copies; + const copies = rawCopies != null ? Number(rawCopies) : 1; + if (!Number.isInteger(copies) || copies <= 0) { + return res.status(400).json({ error: 'copiescount must be a positive integer' }); + } + + const finalData = applyZplCopies(rawData.trim(), copies); + + try { + const job = await printerjobDb.create(req.user.id, { + agentprinterId: parsedApId.id, + type: 'zpl', + data: finalData, + }); + + if (job.printeragentId) { + notifyAgentJob(job.printeragentId, 'created', job); + } + + emit('printerjob', { companyId: selected.companyId, data: { job } }); + res.status(201).json({ printerjob: job }); + } catch (error) { + const status = printerjobErrorStatus(error); + if (status === 500) console.error('Create zpljob failed:', error); + res.status(status).json({ error: error.message }); + } + }); + + // #endregion +} + diff --git a/src/db/printerjob.js b/src/db/printerjob.js new file mode 100644 index 0000000..76d7bed --- /dev/null +++ b/src/db/printerjob.js @@ -0,0 +1,27 @@ +import { getStore } from './store.js'; + +export async function create(googleAuthId, input) { + const store = await getStore(); + return store.printerjob.create(googleAuthId, input); +} + +export async function getById(auth, id) { + const store = await getStore(); + return store.printerjob.getById(auth, id); +} + +export async function list(auth, filters) { + const store = await getStore(); + return store.printerjob.list(auth, filters); +} + +export async function updateState(auth, id, state) { + const store = await getStore(); + return store.printerjob.updateState(auth, id, state); +} + +export async function deleteJob(googleAuthId, id) { + const store = await getStore(); + return store.printerjob.delete(googleAuthId, id); +} + diff --git a/src/db/store.js b/src/db/store.js index 019e3b6..b2cbc53 100644 --- a/src/db/store.js +++ b/src/db/store.js @@ -42,6 +42,9 @@ const STORE_NAMESPACES = [ 'ledger', 'warehouse', 'printer', + 'printeragent', + 'agentprinter', + 'printerjob', 'labeltemplate', 'stock', 'propertyname', diff --git a/src/services/companyPrinterService.js b/src/services/companyPrinterService.js index de6f508..9e40e76 100644 --- a/src/services/companyPrinterService.js +++ b/src/services/companyPrinterService.js @@ -48,12 +48,16 @@ export function updateAgentPrinters(companyId, agentId, agentName, rawPrinters) const now = new Date().toISOString(); const printerList = Array.isArray(rawPrinters) ? rawPrinters : []; - const normalized = printerList.map((p) => ({ - ...p, - agentId: aId, - agentName: agentName || null, - updatedAt: now, - })); + const normalized = printerList.map((p) => { + const liveStatus = extractLiveStatus(p); + return { + ...p, + agentId: aId, + agentName: agentName || null, + updatedAt: now, + ...liveStatus, + }; + }); companyAgents.get(cId).set(aId, normalized); @@ -155,6 +159,106 @@ export function broadcastCompanyPrinters(companyId, printers) { emit('agentprinter', { companyId: cId, data: payload }); } +/** + * Extracts normalized boolean live status indicators and telemetry from live printer telemetry. + * + * @param {object|null|undefined} live + * @returns {{ open: boolean, pause: boolean, error: boolean, online: boolean, labelLength: number|null }} + */ +export function extractLiveStatus(live) { + if (!live) { + return { + open: false, + pause: false, + error: false, + online: false, + labelLength: null, + }; + } + + const errors = live.errors || {}; + const isOffline = live.status === 'offline' || live.unreachable === true || errors.unreachable === true; + const online = !isOffline; + + const open = Boolean(live.open ?? live.headOpen ?? errors.headOpen ?? false); + const pause = Boolean(live.pause ?? live.paused ?? errors.pause ?? false); + + const hasOtherError = Boolean( + live.error || + errors.other || + errors.error || + Object.entries(errors).some(([key, val]) => !['headOpen', 'pause', 'unreachable'].includes(key) && Boolean(val)) + ); + + const rawLabelLength = live.labelLength ?? live.labellength; + const labelLength = rawLabelLength != null && Number.isFinite(Number(rawLabelLength)) + ? Number(rawLabelLength) + : null; + + return { + open, + pause, + error: hasOtherError, + online, + labelLength, + }; +} + +/** + * Finds a matching live printer from memory for a given database agentprinter record. + * + * @param {number} companyId + * @param {object} agentprinter + * @returns {LivePrinter|null} + */ +export function getLivePrinterForAgentPrinter(companyId, agentprinter) { + const printers = getCompanyPrinters(companyId); + if (!agentprinter || printers.length === 0) return null; + + if (agentprinter.id != null) { + const match = printers.find((p) => p.agentprinterId === agentprinter.id); + if (match) return match; + } + + if (agentprinter.printeragentId && agentprinter.serial) { + const match = printers.find((p) => + Number(p.agentId) === Number(agentprinter.printeragentId) && + p.serial && + String(p.serial).trim().toLowerCase() === String(agentprinter.serial).trim().toLowerCase() + ); + if (match) return match; + } + + if (agentprinter.printeragentId && agentprinter.model) { + const match = printers.find((p) => + Number(p.agentId) === Number(agentprinter.printeragentId) && + p.model && + String(p.model).trim().toLowerCase() === String(agentprinter.model).trim().toLowerCase() && + (!agentprinter.type || !p.type || String(p.type).trim().toLowerCase() === String(agentprinter.type).trim().toLowerCase()) + ); + if (match) return match; + } + + return null; +} + +/** + * Enriches an agentprinter database record with live operational status (open, pause, error, online). + * + * @param {number} companyId + * @param {object} agentprinter + * @returns {object} + */ +export function enrichAgentPrinter(companyId, agentprinter) { + if (!agentprinter) return agentprinter; + const live = getLivePrinterForAgentPrinter(companyId, agentprinter); + const status = extractLiveStatus(live); + return { + ...agentprinter, + ...status, + }; +} + /** * Clears all live printers for a company (e.g. on company deletion). *