diff --git a/api-graph.dot b/api-graph.dot index 39d1063..959ad59 100644 --- a/api-graph.dot +++ b/api-graph.dot @@ -44,15 +44,15 @@ digraph api { fontcolor="#e2e8f0"; margin=14; Supplier [label=<
Supplier
/supplier
GET/List suppliers
POST/Create supplier
GET/{id}/articlesList supplier articles by S…
POST/{id}/articlesQuery supplier articles by …
PATCH/{id}Update supplier
DELETE/{id}Delete supplier
>]; ArticleSupplier [label=<
ArticleSupplier
/article/{sku}/supplier
GET/List article suppliers
POST/Assign supplier to article
PUT/orderReorder article suppliers
PATCH/{id}Update article supplier ass…
DELETE/{id}Remove supplier assignment …
>]; - Delivery [label=<
Delivery
/delivery
GET/List deliveries
POST/Create delivery
GET/{id}Get delivery
GET/{id}/file/{fileId}Get delivery attachment fil…
POST/{id}/pdfGenerate and attach deliver…
POST/parseParse document (SSE)
PATCH/{id}Update delivery
DELETE/{id}Delete delivery
>]; + Delivery [label=<
Delivery
/delivery
GET/List deliveries
POST/Create delivery
GET/{id}Get delivery
GET/{id}/file/{fileId}Get delivery attachment fil…
POST/{id}/pdfGenerate and attach deliver…
PATCH/{id}Update delivery
DELETE/{id}Delete delivery
DELETE/{id}/file/{fileId}Delete delivery file attach…
>]; } subgraph cluster_sales { label="Sales & Fulfillment"; labeljust="l"; fontsize=15; style="rounded,filled"; fillcolor="#202a3a"; color="#3f4c5f"; fontcolor="#e2e8f0"; margin=14; - Quote [label=<
Quote
/quote
GET/List quotes
POST/Create quote
GET/{id}Get quote
GET/{id}/file/{fileId}Get quote attachment file c…
POST/{id}/pdfGenerate and attach quote P…
PATCH/{id}Update quote
DELETE/{id}Delete quote
>]; - Order [label=<
Order
/order
GET/List orders
POST/Create order
GET/{id}Get order
GET/{id}/file/{fileId}Get order attachment file c…
GET/{id}/paymentList payments of an order
GET/{id}/shipmentList shipments of an order
GET/{id}/shippingList shippings of an order
POST/{id}/paymentAdd payment to an order
POST/{id}/pdfGenerate and attach order P…
POST/{id}/shipmentCreate shipment for an order
POST/{id}/shippingCreate shipping for an order
PATCH/{id}Update order
DELETE/{id}Delete order
>]; - Shipment [label=<
Shipment
/shipment
GET/{id}Get shipment by ID
GET/{id}/file/{fileId}Get shipment attachment fil…
GET/{id}/shippingList packages of a shipment
POST/{id}/pdfGenerate and attach shipmen…
POST/{id}/shippingCreate package for a shipme…
DELETE/{id}Delete shipment
>]; + Quote [label=<
Quote
/quote
GET/List quotes
POST/Create quote
GET/{id}Get quote
GET/{id}/file/{fileId}Get quote attachment file c…
POST/{id}/orderCreate order from quote
POST/{id}/pdfGenerate and attach quote P…
PATCH/{id}Update quote
DELETE/{id}Delete quote
DELETE/{id}/file/{fileId}Delete quote file attachment
>]; + Order [label=<
Order
/order
GET/List orders
POST/Create order
GET/{id}Get order
GET/{id}/file/{fileId}Get order attachment file c…
GET/{id}/paymentList payments of an order
GET/{id}/shipmentList shipments of an order
GET/{id}/shippingList shippings of an order
POST/{id}/paymentAdd payment to an order
POST/{id}/pdfGenerate and attach order P…
POST/{id}/shipmentCreate shipment for an order
POST/{id}/shippingCreate shipping for an order
PATCH/{id}Update order
DELETE/{id}Delete order
DELETE/{id}/file/{fileId}Delete order file attachment
>]; + Shipment [label=<
Shipment
/shipment
GET/List shipments
GET/{id}Get shipment by ID
GET/{id}/file/{fileId}Get shipment attachment fil…
GET/{id}/shippingList packages of a shipment
POST/{id}/pdfGenerate and attach shipmen…
POST/{id}/shippingCreate package for a shipme…
PATCH/{id}Update shipment state or me…
DELETE/{id}Delete shipment
DELETE/{id}/file/{fileId}Delete shipment file attach…
>]; Shipping [label=<
Shipping
/shipping
GET/{id}/packageList packages of a shipping
POST/{id}/packageCreate package for a shippi…
PATCH/{id}Update shipping
DELETE/{id}Delete shipping
>]; Package [label=<
Package
/package
DELETE/{id}Delete package
>]; } @@ -60,8 +60,8 @@ digraph api { label="Inventory & Warehousing"; labeljust="l"; fontsize=15; style="rounded,filled"; fillcolor="#202a3a"; color="#3f4c5f"; fontcolor="#e2e8f0"; margin=14; - Stock [label=<
Stock
/stock
POST/adjustAdjust stock manually
>]; - Ledger [label=<
Ledger
/ledger
GET/Query ledger by manifest ar…
POST/Add ledger entry
GET/manifestarticle/{manifestarticleId}Query ledger by manifest ar…
GET/sku/{sku}Query ledger by article SKU
>]; + Stock [label=<
Stock
/stock
POST/acceptAccept delivery manifest it…
POST/adjustAdjust stock manually
POST/shipShip shipment manifest item…
>]; + Ledger [label=<
Ledger
/ledger
GET/Query ledger by manifest ar…
GET/manifestarticle/{manifestarticleId}Query ledger by manifest ar…
GET/sku/{sku}Query ledger by article SKU
>]; Warehouse [label=<
Warehouse
/warehouse
GET/List warehouses
POST/Create warehouse
GET/{id}Get warehouse by ID
PUT/{id}Update warehouse
PUT/orderReorder warehouses
PATCH/{id}Update warehouse (partial)
DELETE/{id}Delete warehouse
>]; } subgraph cluster_finance { @@ -77,7 +77,7 @@ digraph api { fontcolor="#e2e8f0"; margin=14; Image [label=<
Image
/image
GET/{fullHash}Full image by hash
GET/smallthumb/{fullHash}Small thumb image by hash
GET/thumb/{fullHash}Thumb image by hash
>]; Serper [label=<
Serper
/serper
POST/imageCrawl image from URL, crop …
POST/imagesSearch images via Serper.de…
>]; - Vfs [label=<
Vfs
/vfs
GET/List virtual filesystem fil…
GET/{*path}Get a virtual filesystem fi…
POST/{*path}Execute a virtual filesyste…
POST/drafts/responseRespond to a frontend draft…
POST/mkdirCreate directory in virtual…
POST/renameRename or move a virtual fi…
POST/uploadUpload files to virtual fil…
PUT/{*path}Create or overwrite a virtu…
DELETE/{*path}Delete a virtual filesystem…
>]; + Vfs [label=<
Vfs
/vfs
GET/List virtual filesystem fil…
GET/{*path}Get a virtual filesystem fi…
POST/{*path}Execute a virtual filesyste…
POST/applets/restoreRestore system default appl…
POST/mkdirCreate directory in virtual…
POST/renameRename or move a virtual fi…
POST/skills/restoreRestore system default skil…
POST/uploadUpload files to virtual fil…
PUT/{*path}Create or overwrite a virtu…
DELETE/{*path}Delete a virtual filesystem…
>]; } subgraph cluster_pos { label="POS & Hardware"; labeljust="l"; fontsize=15; @@ -103,6 +103,7 @@ digraph api { Health [label=<
Health
/health
GET/Database health check
>]; Legend [label=<
API Graph Legend
GETSafe retrieval / query
POSTCreate resource / action
PUTFull replace / collection update
PATCHPartial entity update
DELETERemove resource
in#Inbound arrival port on resource
▪—▶Relational reference / dataflow
>]; } + SubagentSchedule [label=<
SubagentSchedule
/subagentschedule
GET/List subagent schedules
POST/Create subagent schedule
GET/{id}Get subagent schedule by ID
PUT/{id}Update subagent schedule
DELETE/{id}Delete subagent schedule
>]; Backup [label=<
Backup
/backup
GET/List backups and service st…
GET/{id}/vfsList VFS files in a backup
POST/{id}/vfs/recoverRecover VFS file from a bac…
>]; Order:ep_get__order__id_:e -> Entity:in2:n [color="#ff6b6b", fontcolor="#ff6b6b", tooltip="Order → Entity (entityId)", label=" entityId ", weight=3]; @@ -125,9 +126,9 @@ digraph api { ArticleSupplier:ep_post__article__sku__supplier:e -> Supplier:in0:n [color="#e0b25a", fontcolor="#e0b25a", tooltip="ArticleSupplier → Supplier (entityId)", label=" entityId ", weight=3]; ArticleSupplier:ep_get__article__sku__supplier:e -> Article:in0:n [color="#56c8c8", fontcolor="#56c8c8", tooltip="ArticleSupplier → Article (sku)", label=" sku ", constraint=false, weight=1]; Supplier:ep_get__supplier__id__articles:e -> Entity:in0:n [color="#ff5f9e", fontcolor="#ff5f9e", tooltip="Supplier → Entity (entityId)", label=" entityId ", weight=3]; - Stock:ep_post__stock_adjust:e -> Article:in5:n [color="#ffb25a", fontcolor="#ffb25a", tooltip="Stock → Article (sku)", label=" sku ", constraint=false, weight=1]; - Stock:ep_post__stock_adjust:e -> Warehouse:in0:n [color="#56d68a", fontcolor="#56d68a", tooltip="Stock → Warehouse (warehouseId)", label=" warehouseId ", constraint=false, weight=1]; - Stock:ep_post__stock_adjust:e -> Ledger:in1:n [color="#66b3ff", fontcolor="#66b3ff", tooltip="Stock → Ledger (ledger)", label=" ledger ", weight=3]; + Stock:ep_post__stock_accept:e -> Article:in5:n [color="#ffb25a", fontcolor="#ffb25a", tooltip="Stock → Article (sku)", label=" sku ", constraint=false, weight=1]; + Stock:ep_post__stock_accept:e -> Warehouse:in0:n [color="#56d68a", fontcolor="#56d68a", tooltip="Stock → Warehouse (warehouseId)", label=" warehouseId ", constraint=false, weight=1]; + Stock:ep_post__stock_accept:e -> Ledger:in1:n [color="#66b3ff", fontcolor="#66b3ff", tooltip="Stock → Ledger (ledger)", label=" ledger ", weight=3]; Ledger:ep_get__ledger:w -> Article:in9:n [color="#c79bff", fontcolor="#c79bff", tooltip="Ledger → Article (sku)", label=" sku ", weight=3]; Ledger:ep_get__ledger:w -> Warehouse:in1:n [color="#ff6b6b", fontcolor="#ff6b6b", tooltip="Ledger → Warehouse (warehouseId)", label=" warehouseId ", constraint=false, weight=1]; Article:ep_post__article:w -> Category:in1:n [color="#6bdf9a", fontcolor="#6bdf9a", tooltip="Article → Category (categoryId)", label=" categoryId ", constraint=false, weight=1]; @@ -135,7 +136,7 @@ digraph api { Article:ep_patch__article__sku_:w -> Unit:in0:n [color="#f5c15c", fontcolor="#f5c15c", tooltip="Article → Unit (unitSi)", label=" unitSi ", constraint=false, weight=1]; Article:ep_get__article__sku_:w -> ArticleSupplier:in0:n [color="#c79bff", fontcolor="#c79bff", tooltip="Article → ArticleSupplier (suppliers)", label=" suppliers ", constraint=false, weight=1]; Article:ep_post__article__sku__image:e -> Image:in2:n [color="#ff9f5a", fontcolor="#ff9f5a", tooltip="Article → Image (photos)", label=" photos ", constraint=false, weight=1]; - Article:ep_put__article__sku__prices:e -> Customergroup:in1:n [color="#5cd6d6", fontcolor="#5cd6d6", tooltip="Article → Customergroup (prices)", label=" prices ", constraint=false, weight=1]; + Article:ep_put__article__sku__prices:e -> Customergroup:in0:n [color="#5cd6d6", fontcolor="#5cd6d6", tooltip="Article → Customergroup (prices)", label=" prices ", constraint=false, weight=1]; Article:e -> Property:in1:n [color="#ff7fc2", fontcolor="#ff7fc2", tooltip="Article → Property (properties)", label=" properties ", constraint=false, weight=1]; Article:e -> Attribute:in1:n [color="#8f95ff", fontcolor="#8f95ff", tooltip="Article → Attribute (attributes)", label=" attributes ", weight=3]; Article:ep_get__article__sku__children:ne -> Article:in7:n [color="#58d18a", fontcolor="#58d18a", tooltip="Article → Article (bundles & variants)", label=" bundles & variants ", weight=3]; @@ -147,22 +148,22 @@ digraph api { Brand:ep_post__brand__id__image:e -> Image:in0:n [color="#5aa7e6", fontcolor="#5aa7e6", tooltip="Brand → Image (image)", label=" image ", weight=3]; Property:ep_get__propertyname:e -> Company:in0:n [color="#ff7aa8", fontcolor="#ff7aa8", tooltip="Property → Company (companyId)", label=" companyId ", weight=3]; Attribute:ep_post__attributevalue__id__image:e -> Image:in3:n [color="#e0b25a", fontcolor="#e0b25a", tooltip="Attribute → Image (image)", label=" image ", weight=3]; - Payment:w -> Account:in0:n [color="#56c8c8", fontcolor="#56c8c8", tooltip="Payment → Account (accountId)", label=" accountId ", weight=3]; + Payment:e -> Account:in0:n [color="#56c8c8", fontcolor="#56c8c8", tooltip="Payment → Account (accountId)", label=" accountId ", weight=3]; Payment:w -> Order:in3:n [color="#ff5f9e", fontcolor="#ff5f9e", tooltip="Payment → Order (manifestId)", label=" manifestId ", constraint=false, weight=1]; - Account:ep_get__account:e -> Company:in1:n [color="#ffb25a", fontcolor="#ffb25a", tooltip="Account → Company (companyId)", label=" companyId ", weight=3]; - Entity:ep_post__entity:e -> Customergroup:in0:n [color="#56d68a", fontcolor="#56d68a", tooltip="Entity → Customergroup (customergroupId)", label=" customergroupId ", weight=3]; + Account:ep_get__account:e -> Company:in3:n [color="#ffb25a", fontcolor="#ffb25a", tooltip="Account → Company (companyId)", label=" companyId ", weight=3]; + Entity:ep_post__entity:e -> Customergroup:in1:n [color="#56d68a", fontcolor="#56d68a", tooltip="Entity → Customergroup (customergroupId)", label=" customergroupId ", weight=3]; Company:e -> Customergroup:in2:n [color="#66b3ff", fontcolor="#66b3ff", tooltip="Company → Customergroup (poscustomergroup)", label=" poscustomergroup ", weight=3]; - Company:w -> Category:in3:n [color="#c79bff", fontcolor="#c79bff", tooltip="Company → Category (root_category)", label=" root_category ", constraint=false, weight=1]; + Company:w -> Category:in5:n [color="#c79bff", fontcolor="#c79bff", tooltip="Company → Category (root_category)", label=" root_category ", constraint=false, weight=1]; Company:w -> CompanySetting:in0:n [color="#ff6b6b", fontcolor="#ff6b6b", tooltip="Company → CompanySetting (settings)", label=" settings ", constraint=false, weight=1]; - Number:ep_get__number:w -> Company:in2:n [color="#6bdf9a", fontcolor="#6bdf9a", tooltip="Number → Company (companyId)", label=" companyId ", weight=3]; - POSTerminal:ep_get__posterminal:w -> Company:in4:n [color="#5aa7ff", fontcolor="#5aa7ff", tooltip="POSTerminal → Company (companyId)", label=" companyId ", weight=3]; - POSTerminal:ep_get__posterminal:w -> Category:in4:n [color="#f5c15c", fontcolor="#f5c15c", tooltip="POSTerminal → Category (root_category)", label=" root_category ", constraint=false, weight=1]; - Printer:ep_get__printer:w -> Company:in5:n [color="#c79bff", fontcolor="#c79bff", tooltip="Printer → Company (companyId)", label=" companyId ", weight=3]; + Number:ep_get__number:w -> Company:in5:n [color="#6bdf9a", fontcolor="#6bdf9a", tooltip="Number → Company (companyId)", label=" companyId ", weight=3]; + POSTerminal:ep_get__posterminal:e -> Company:in2:n [color="#5aa7ff", fontcolor="#5aa7ff", tooltip="POSTerminal → Company (companyId)", label=" companyId ", weight=3]; + POSTerminal:ep_get__posterminal:w -> Category:in3:n [color="#f5c15c", fontcolor="#f5c15c", tooltip="POSTerminal → Category (root_category)", label=" root_category ", constraint=false, weight=1]; + Printer:ep_get__printer:e -> Company:in4:n [color="#c79bff", fontcolor="#c79bff", tooltip="Printer → Company (companyId)", label=" companyId ", weight=3]; Printer:ep_get__printer:w -> LabelTemplate:in0:n [color="#ff9f5a", fontcolor="#ff9f5a", tooltip="Printer → LabelTemplate (templates)", label=" templates ", constraint=false, weight=1]; - LabelTemplate:ep_get__labeltemplate:w -> Company:in3:n [color="#5cd6d6", fontcolor="#5cd6d6", tooltip="LabelTemplate → Company (companyId)", label=" companyId ", weight=3]; + LabelTemplate:ep_get__labeltemplate:e -> Company:in1:n [color="#5cd6d6", fontcolor="#5cd6d6", tooltip="LabelTemplate → Company (companyId)", label=" companyId ", weight=3]; POSSync:w -> POSTerminal:in0:n [color="#ff7fc2", fontcolor="#ff7fc2", tooltip="POSSync → POSTerminal (client bind)", label=" client bind ", constraint=false, weight=1]; POSSync:ep_get__v1_product:w -> Article:in12:n [color="#8f95ff", fontcolor="#8f95ff", tooltip="POSSync → Article (product sync)", label=" product sync ", constraint=false, weight=1]; - POSSync:ep_get__v1_category:w -> Category:in5:n [color="#58d18a", fontcolor="#58d18a", tooltip="POSSync → Category (category sync)", label=" category sync ", weight=3]; + POSSync:ep_get__v1_category:w -> Category:in4:n [color="#58d18a", fontcolor="#58d18a", tooltip="POSSync → Category (category sync)", label=" category sync ", weight=3]; PublicCatalog:w -> Article:in8:n [color="#ff8f66", fontcolor="#ff8f66", tooltip="PublicCatalog → Article (articles)", label=" articles ", weight=3]; PublicCatalog:w -> Category:in2:n [color="#4fc4e8", fontcolor="#4fc4e8", tooltip="PublicCatalog → Category (category)", label=" category ", constraint=false, weight=1]; ModelConversation:ep_get__modelconversation:e -> Vfs:in0:n [color="#a98cff", fontcolor="#a98cff", tooltip="ModelConversation → Vfs (vfs workspace)", label=" vfs workspace ", weight=3]; diff --git a/api-graph.svg b/api-graph.svg index 125ad09..57c8c9b 100644 --- a/api-graph.svg +++ b/api-graph.svg @@ -4,2225 +4,2274 @@ - - + + api - + cluster_identity - -Identity & Access + +Identity & Access cluster_crm - -Entities & CRM + +Entities & CRM cluster_catalog - -Catalog & Products + +Catalog & Products cluster_properties - -Properties & Attributes + +Properties & Attributes cluster_purchasing - -Suppliers & Purchasing + +Suppliers & Purchasing cluster_sales - -Sales & Fulfillment + +Sales & Fulfillment cluster_inventory - -Inventory & Warehousing + +Inventory & Warehousing cluster_finance - -Finance & Payments + +Finance & Payments cluster_media - -Media & Storage + +Media & Storage cluster_pos - -POS & Hardware + +POS & Hardware cluster_ai_mcp - -AI & Integrations + +AI & Integrations cluster_system - -System & Realtime + +System & Realtime Auth - - -Auth -/auth - - - -GET -/.well-known/oauth-authorization-server -OAuth 2.0 Authorization Ser… - - - -GET -/.well-known/oauth-protected-resource -OAuth 2.0 Protected Resourc… - - - -GET -/me -Current user - - - -POST -/login -Login with Google ID token - - - -POST -/logout -Logout - - - -PUT -/selected-company -Set selected company + + +Auth +/auth + + + +GET +/.well-known/oauth-authorization-server +OAuth 2.0 Authorization Ser… + + + +GET +/.well-known/oauth-protected-resource +OAuth 2.0 Protected Resourc… + + + +GET +/me +Current user + + + +POST +/login +Login with Google ID token + + + +POST +/logout +Logout + + + +PUT +/selected-company +Set selected company Company - - - - - - - - -Company -/company - - - -GET -/ -List companies - - - -POST -/ -Create company - - - -GET -/export -Export company catalog as z… - - - -GET -/history -Get company history - - - -POST -/export -Export company catalog as z… - - - -POST -/history -Add company history entry - - - -POST -/import -Import company catalog from… - - - -PUT -/{id} -Update company - - - -DELETE -/{id} -Delete company + + + + + + + + +Company +/company + + + +GET +/ +List companies + + + +POST +/ +Create company + + + +GET +/export +Export company catalog as z… + + + +GET +/history +Get company history + + + +POST +/export +Export company catalog as z… + + + +POST +/history +Add company history entry + + + +POST +/import +Import company catalog from… + + + +PUT +/{id} +Update company + + + +DELETE +/{id} +Delete company CompanySetting - - - -CompanySetting -/companysetting - - - -GET -/company/setting -List company settings - - - -GET -/company/setting/{key} -Get company setting by key - - - -PUT -/company/setting/{key} -Upsert company setting + + + +CompanySetting +/companysetting + + + +GET +/company/setting +List company settings + + + +GET +/company/setting/{key} +Get company setting by key + + + +PUT +/company/setting/{key} +Upsert company setting Company:w->CompanySetting:n - - + + -  settings   +  settings   Customergroup - - - - - -Customergroup -/customergroup - - - -GET -/ -List customer groups - - - -POST -/ -Create customer group - - - -PUT -/order -Reorder customer groups - - - -PATCH -/{id} -Update customer group - - - -DELETE -/{id} -Delete customer group + + + + + +Customergroup +/customergroup + + + +GET +/ +List customer groups + + + +POST +/ +Create customer group + + + +PUT +/order +Reorder customer groups + + + +PATCH +/{id} +Update customer group + + + +DELETE +/{id} +Delete customer group Company:e->Customergroup:n - - + + -  poscustomergroup   +  poscustomergroup   Category - - - - - - - - -Category -/category - - - -POST -/ -Create category - - - -GET -/{id}/articles -Articles in category - - - -GET -/export.zip -Export categories as ZIP - - - -GET -/tree -Category tree - - - -POST -/{id}/image -Add category image - - - -PUT -/order -Reorder sibling categories - - - -PATCH -/{id} -Update category (rename or … - - - -DELETE -/{id} -Delete category - - - -DELETE -/{id}/image -Delete category image + + + + + + + + +Category +/category + + + +POST +/ +Create category + + + +GET +/{id}/articles +Articles in category + + + +GET +/export.zip +Export categories as ZIP + + + +GET +/tree +Category tree + + + +POST +/{id}/image +Add category image + + + +PUT +/order +Reorder sibling categories + + + +PATCH +/{id} +Update category (rename or … + + + +DELETE +/{id} +Delete category + + + +DELETE +/{id}/image +Delete category image Company:w->Category:n - - + + -  root_category   +  root_category   Number - - -Number -/number - - - -GET -/ -List number sequences - - - -PATCH -/{id} -Update number sequence + + +Number +/number + + + +GET +/ +List number sequences + + + +PATCH +/{id} +Update number sequence Number:w->Company:n - - + + -  companyId   +  companyId   Entity - - - - - - -Entity -/entity - - - -GET -/ -List entities - - - -POST -/ -Create entity - - - -GET -/{entityId}/address -List entity addresses - - - -GET -/{entityId}/contact -List entity contacts - - - -GET -/{id} -Get entity - - - -GET -/next-number -Peek next customer number - - - -POST -/{entityId}/address -Create entity address - - - -POST -/{entityId}/contact -Create entity contact - - - -PATCH -/{entityId}/address/{id} -Update entity address - - - -PATCH -/{entityId}/contact/{id} -Update entity contact - - - -PATCH -/{id} -Update entity - - - -DELETE -/{entityId}/address/{id} -Delete entity address - - - -DELETE -/{entityId}/contact/{id} -Delete entity contact - - - -DELETE -/{id} -Delete entity + + + + + + +Entity +/entity + + + +GET +/ +List entities + + + +POST +/ +Create entity + + + +GET +/{entityId}/address +List entity addresses + + + +GET +/{entityId}/contact +List entity contacts + + + +GET +/{id} +Get entity + + + +GET +/next-number +Peek next customer number + + + +POST +/{entityId}/address +Create entity address + + + +POST +/{entityId}/contact +Create entity contact + + + +PATCH +/{entityId}/address/{id} +Update entity address + + + +PATCH +/{entityId}/contact/{id} +Update entity contact + + + +PATCH +/{id} +Update entity + + + +DELETE +/{entityId}/address/{id} +Delete entity address + + + +DELETE +/{entityId}/contact/{id} +Delete entity contact + + + +DELETE +/{id} +Delete entity Entity:e->Customergroup:n - - + + -  customergroupId   +  customergroupId   Article - - - - - - - - - - - - - - - -Article -/article - - - -POST -/ -Create article in category - - - -GET -/{sku} -Get article by SKU - - - -GET -/{sku}/articlelist -Get Stückliste (bundle item… - - - -GET -/{sku}/children -List child articles of a pa… - - - -GET -/{sku}/history -Get article history by SKU - - - -GET -/{sku}/optionslist -Get options list for an art… - - - -GET -/export.zip -Export articles as ZIP - - - -POST -/{sku}/children -Create and attach a new chi… - - - -POST -/{sku}/image -Add article image - - - -POST -/{sku}/parent -Toggle parent mode for an a… - - - -POST -/{sku}/print -Print article label - - - -PUT -/{sku}/articlelist -Set Stückliste (bundle item… - - - -PUT -/{sku}/brand -Set or clear article brand … - - - -PUT -/{sku}/categories -Replace article categories … - - - -PUT -/{sku}/children -Attach an existing article … - - - -PUT -/{sku}/eans -Replace article EANs by SKU - - - -PUT -/{sku}/images/order -Reorder article images - - - -PUT -/{sku}/optionslist -Set options list for an art… - - - -PUT -/{sku}/prices -Replace POS prices by SKU (… - - - -PUT -/{sku}/track_stock -Set article track_stock fla… - - - -PUT -/{sku}/weight -Set article weight by SKU - - - -PATCH -/{sku} -Update article by SKU - - - -DELETE -/{sku} -Delete article by SKU - - - -DELETE -/{sku}/children/{childSku} -Remove a child article from… - - - -DELETE -/{sku}/image/{fullHash} -Delete article image + + + + + + + + + + + + + + + +Article +/article + + + +POST +/ +Create article in category + + + +GET +/{sku} +Get article by SKU + + + +GET +/{sku}/articlelist +Get Stückliste (bundle item… + + + +GET +/{sku}/children +List child articles of a pa… + + + +GET +/{sku}/history +Get article history by SKU + + + +GET +/{sku}/optionslist +Get options list for an art… + + + +GET +/export.zip +Export articles as ZIP + + + +POST +/{sku}/children +Create and attach a new chi… + + + +POST +/{sku}/image +Add article image + + + +POST +/{sku}/parent +Toggle parent mode for an a… + + + +POST +/{sku}/print +Print article label + + + +PUT +/{sku}/articlelist +Set Stückliste (bundle item… + + + +PUT +/{sku}/brand +Set or clear article brand … + + + +PUT +/{sku}/categories +Replace article categories … + + + +PUT +/{sku}/children +Attach an existing article … + + + +PUT +/{sku}/eans +Replace article EANs by SKU + + + +PUT +/{sku}/images/order +Reorder article images + + + +PUT +/{sku}/optionslist +Set options list for an art… + + + +PUT +/{sku}/prices +Replace POS prices by SKU (… + + + +PUT +/{sku}/track_stock +Set article track_stock fla… + + + +PUT +/{sku}/weight +Set article weight by SKU + + + +PATCH +/{sku} +Update article by SKU + + + +DELETE +/{sku} +Delete article by SKU + + + +DELETE +/{sku}/children/{childSku} +Remove a child article from… + + + +DELETE +/{sku}/image/{fullHash} +Delete article image Article:e->Customergroup:n - - + + -  prices   +  prices   Article:ne->Article:n - - + + -  bundles & variants   +  bundles & variants   Article:w->Category:n - - + + -  categoryId   +  categoryId   Brand - - - -Brand -/brand - - - -GET -/ -List brands - - - -POST -/ -Create brand - - - -POST -/{id}/image -Add or replace brand image - - - -PATCH -/{id} -Rename brand - - - -DELETE -/{id} -Delete brand - - - -DELETE -/{id}/image -Delete brand image + + + +Brand +/brand + + + +GET +/ +List brands + + + +POST +/ +Create brand + + + +POST +/{id}/image +Add or replace brand image + + + +PATCH +/{id} +Rename brand + + + +DELETE +/{id} +Delete brand + + + +DELETE +/{id}/image +Delete brand image Article:w->Brand:n - - + + -  brand   +  brand   Unit - - - -Unit -/unit - - - -GET -/ -List units - - - -PUT -/ -Upsert unit - - - -DELETE -/ -Delete unit + + + +Unit +/unit + + + +GET +/ +List units + + + +PUT +/ +Upsert unit + + + +DELETE +/ +Delete unit Article:w->Unit:n - - + + -  unitSi   +  unitSi   Property - - - - -Property -/propertyname - - - -GET -/ -List property names - - - -POST -/ -Create property name - - - -GET -/article/{sku}/property -List article properties - - - -GET -/category/{id}/property -List category properties - - - -PUT -/article/{sku}/property -Bulk set article properties - - - -PUT -/category/{id}/property -Bulk set category properties - - - -PUT -/order -Reorder property names - - - -PATCH -/{id} -Update property name - - - -DELETE -/{id} -Delete property name - - - -DELETE -/article/{sku}/property/{propertyId} -Delete article property - - - -DELETE -/category/{id}/property/{propertyId} -Delete category property + + + + +Property +/propertyname + + + +GET +/ +List property names + + + +POST +/ +Create property name + + + +GET +/article/{sku}/property +List article properties + + + +GET +/category/{id}/property +List category properties + + + +PUT +/article/{sku}/property +Bulk set article properties + + + +PUT +/category/{id}/property +Bulk set category properties + + + +PUT +/order +Reorder property names + + + +PATCH +/{id} +Update property name + + + +DELETE +/{id} +Delete property name + + + +DELETE +/article/{sku}/property/{propertyId} +Delete article property + + + +DELETE +/category/{id}/property/{propertyId} +Delete category property Article:e->Property:n - - + + -  properties   +  properties   Attribute - - - - -Attribute -/attributename - - - -GET -/ -List attribute names - - - -POST -/ -Create attribute name - - - -GET -/{attributeId}/value -List values for an attribute - - - -GET -/article/{sku}/attributevalue -List article attribute valu… - - - -GET -/category/{id}/attributevalue -List category attribute val… - - - -POST -/{attributeId}/value -Create value for an attribu… - - - -POST -/attributevalue/{id}/image -Add or replace attribute va… - - - -PUT -/{attributeId}/value/order -Reorder values of an attrib… - - - -PUT -/article/{sku}/attributevalue -Bulk set article attribute … - - - -PUT -/category/{id}/attributevalue -Bulk set category attribute… - - - -PUT -/order -Reorder attribute names - - - -PATCH -/{id} -Update attribute name - - - -PATCH -/attributevalue/{id} -Update attribute value - - - -DELETE -/{id} -Delete attribute name - - - -DELETE -/attributevalue/{id} -Delete attribute value - - - -DELETE -/attributevalue/{id}/image -Delete attribute value image + + + + +Attribute +/attributename + + + +GET +/ +List attribute names + + + +POST +/ +Create attribute name + + + +GET +/{attributeId}/value +List values for an attribute + + + +GET +/article/{sku}/attributevalue +List article attribute valu… + + + +GET +/category/{id}/attributevalue +List category attribute val… + + + +POST +/{attributeId}/value +Create value for an attribu… + + + +POST +/attributevalue/{id}/image +Add or replace attribute va… + + + +PUT +/{attributeId}/value/order +Reorder values of an attrib… + + + +PUT +/article/{sku}/attributevalue +Bulk set article attribute … + + + +PUT +/category/{id}/attributevalue +Bulk set category attribute… + + + +PUT +/order +Reorder attribute names + + + +PATCH +/{id} +Update attribute name + + + +PATCH +/attributevalue/{id} +Update attribute value + + + +DELETE +/{id} +Delete attribute name + + + +DELETE +/attributevalue/{id} +Delete attribute value + + + +DELETE +/attributevalue/{id}/image +Delete attribute value image Article:e->Attribute:n - - + + -  attributes   +  attributes   ArticleSupplier - - - -ArticleSupplier -/article/{sku}/supplier - - - -GET -/ -List article suppliers - - - -POST -/ -Assign supplier to article - - - -PUT -/order -Reorder article suppliers - - - -PATCH -/{id} -Update article supplier ass… - - - -DELETE -/{id} -Remove supplier assignment … + + + +ArticleSupplier +/article/{sku}/supplier + + + +GET +/ +List article suppliers + + + +POST +/ +Assign supplier to article + + + +PUT +/order +Reorder article suppliers + + + +PATCH +/{id} +Update article supplier ass… + + + +DELETE +/{id} +Remove supplier assignment … Article:w->ArticleSupplier:n - - + + -  suppliers   +  suppliers   Image - - - - - - -Image -/image - - - -GET -/{fullHash} -Full image by hash - - - -GET -/smallthumb/{fullHash} -Small thumb image by hash - - - -GET -/thumb/{fullHash} -Thumb image by hash + + + + + + +Image +/image + + + +GET +/{fullHash} +Full image by hash + + + +GET +/smallthumb/{fullHash} +Small thumb image by hash + + + +GET +/thumb/{fullHash} +Thumb image by hash Article:e->Image:n - - + + -  photos   +  photos   Category:e->Article:n - - + + -  articles   +  articles   Category:ne->Category:n - - + + -  parentId   +  parentId   Category:e->Property:n - - + + -  properties   +  properties   Category:e->Attribute:n - - + + -  attributes   +  attributes   Category:e->Image:n - - + + -  image   +  image   Brand:e->Image:n - - + + -  image   +  image   PublicCatalog - - -PublicCatalog -/public - - - -GET -/{companyId}/articles -List public articles - - - -GET -/{companyId}/articles/{sku} -Get public article detail - - - -GET -/{companyId}/categories -List public categories - - - -POST -/telemetry/crash -Receipt crash dump + + +PublicCatalog +/public + + + +GET +/{companyId}/articles +List public articles + + + +GET +/{companyId}/articles/{sku} +Get public article detail + + + +GET +/{companyId}/categories +List public categories + + + +POST +/telemetry/crash +Receipt crash dump PublicCatalog:w->Article:n - - + + -  articles   +  articles   PublicCatalog:w->Category:n - - + + -  category   +  category   Property:e->Company:n - - + + -  companyId   +  companyId   Attribute:e->Image:n - - + + -  image   +  image   Supplier - - - - -Supplier -/supplier - - - -GET -/ -List suppliers - - - -POST -/ -Create supplier - - - -GET -/{id}/articles -List supplier articles by S… - - - -POST -/{id}/articles -Query supplier articles by … - - - -PATCH -/{id} -Update supplier - - - -DELETE -/{id} -Delete supplier + + + + +Supplier +/supplier + + + +GET +/ +List suppliers + + + +POST +/ +Create supplier + + + +GET +/{id}/articles +List supplier articles by S… + + + +POST +/{id}/articles +Query supplier articles by … + + + +PATCH +/{id} +Update supplier + + + +DELETE +/{id} +Delete supplier Supplier:e->Entity:n - - + + -  entityId   +  entityId   ArticleSupplier:e->Article:n - - + + -  sku   +  sku   ArticleSupplier:e->Supplier:n - - + + -  entityId   +  entityId   Delivery - - -Delivery -/delivery - - - -GET -/ -List deliveries - - - -POST -/ -Create delivery - - - -GET -/{id} -Get delivery - - - -GET -/{id}/file/{fileId} -Get delivery attachment fil… - - - -POST -/{id}/pdf -Generate and attach deliver… - - - -POST -/parse -Parse document (SSE) - - - -PATCH -/{id} -Update delivery - - - -DELETE -/{id} -Delete delivery + + +Delivery +/delivery + + + +GET +/ +List deliveries + + + +POST +/ +Create delivery + + + +GET +/{id} +Get delivery + + + +GET +/{id}/file/{fileId} +Get delivery attachment fil… + + + +POST +/{id}/pdf +Generate and attach deliver… + + + +PATCH +/{id} +Update delivery + + + +DELETE +/{id} +Delete delivery + + + +DELETE +/{id}/file/{fileId} +Delete delivery file attach… Delivery:e->Article:n - - + + -  lines.sku   +  lines.sku   Delivery:w->Supplier:n - - + + -  supplierId   +  supplierId   Ledger - - - - - -Ledger -/ledger - - - -GET -/ -Query ledger by manifest ar… - - - -POST -/ -Add ledger entry - - - -GET -/manifestarticle/{manifestarticleId} -Query ledger by manifest ar… - - - -GET -/sku/{sku} -Query ledger by article SKU + + + + + +Ledger +/ledger + + + +GET +/ +Query ledger by manifest ar… + + + +GET +/manifestarticle/{manifestarticleId} +Query ledger by manifest ar… + + + +GET +/sku/{sku} +Query ledger by article SKU Delivery:e->Ledger:n - - + + -  ledger   +  ledger   Quote - - -Quote -/quote - - - -GET -/ -List quotes - - - -POST -/ -Create quote - - - -GET -/{id} -Get quote - - - -GET -/{id}/file/{fileId} -Get quote attachment file c… - - - -POST -/{id}/pdf -Generate and attach quote P… - - - -PATCH -/{id} -Update quote - - - -DELETE -/{id} -Delete quote + + +Quote +/quote + + + +GET +/ +List quotes + + + +POST +/ +Create quote + + + +GET +/{id} +Get quote + + + +GET +/{id}/file/{fileId} +Get quote attachment file c… + + + +POST +/{id}/order +Create order from quote + + + +POST +/{id}/pdf +Generate and attach quote P… + + + +PATCH +/{id} +Update quote + + + +DELETE +/{id} +Delete quote + + + +DELETE +/{id}/file/{fileId} +Delete quote file attachment Quote:e->Entity:n - - + + -  entityId   +  entityId   Quote:e->Article:n - - + + -  lines.sku   +  lines.sku   Order - - - - - - -Order -/order - - - -GET -/ -List orders - - - -POST -/ -Create order - - - -GET -/{id} -Get order - - - -GET -/{id}/file/{fileId} -Get order attachment file c… - - - -GET -/{id}/payment -List payments of an order - - - -GET -/{id}/shipment -List shipments of an order - - - -GET -/{id}/shipping -List shippings of an order - - - -POST -/{id}/payment -Add payment to an order - - - -POST -/{id}/pdf -Generate and attach order P… - - - -POST -/{id}/shipment -Create shipment for an order - - - -POST -/{id}/shipping -Create shipping for an order - - - -PATCH -/{id} -Update order - - - -DELETE -/{id} -Delete order + + + + + + +Order +/order + + + +GET +/ +List orders + + + +POST +/ +Create order + + + +GET +/{id} +Get order + + + +GET +/{id}/file/{fileId} +Get order attachment file c… + + + +GET +/{id}/payment +List payments of an order + + + +GET +/{id}/shipment +List shipments of an order + + + +GET +/{id}/shipping +List shippings of an order + + + +POST +/{id}/payment +Add payment to an order + + + +POST +/{id}/pdf +Generate and attach order P… + + + +POST +/{id}/shipment +Create shipment for an order + + + +POST +/{id}/shipping +Create shipping for an order + + + +PATCH +/{id} +Update order + + + +DELETE +/{id} +Delete order + + + +DELETE +/{id}/file/{fileId} +Delete order file attachment Quote:e->Order:n - - + + -  convert order   +  convert order   Order:e->Entity:n - - + + -  entityId   +  entityId   Order:e->Article:n - - + + -  lines.sku   +  lines.sku   Shipment - - - -Shipment -/shipment - - - -GET -/{id} -Get shipment by ID - - - -GET -/{id}/file/{fileId} -Get shipment attachment fil… - - - -GET -/{id}/shipping -List packages of a shipment - - - -POST -/{id}/pdf -Generate and attach shipmen… - - - -POST -/{id}/shipping -Create package for a shipme… - - - -DELETE -/{id} -Delete shipment + + + +Shipment +/shipment + + + +GET +/ +List shipments + + + +GET +/{id} +Get shipment by ID + + + +GET +/{id}/file/{fileId} +Get shipment attachment fil… + + + +GET +/{id}/shipping +List packages of a shipment + + + +POST +/{id}/pdf +Generate and attach shipmen… + + + +POST +/{id}/shipping +Create package for a shipme… + + + +PATCH +/{id} +Update shipment state or me… + + + +DELETE +/{id} +Delete shipment + + + +DELETE +/{id}/file/{fileId} +Delete shipment file attach… Order:e->Shipment:n - - + + -  shipments   +  shipments   Shipping - - - - - -Shipping -/shipping - - - -GET -/{id}/package -List packages of a shipping - - - -POST -/{id}/package -Create package for a shippi… - - - -PATCH -/{id} -Update shipping - - - -DELETE -/{id} -Delete shipping + + + + + +Shipping +/shipping + + + +GET +/{id}/package +List packages of a shipping + + + +POST +/{id}/package +Create package for a shippi… + + + +PATCH +/{id} +Update shipping + + + +DELETE +/{id} +Delete shipping Order:e->Shipping:n - - + + -  shippings   +  shippings   Payment - - - -Payment -/payment - - - -DELETE -/{id} -Delete payment + + + +Payment +/payment + + + +DELETE +/{id} +Delete payment Order:e->Payment:n - - + + -  payments   +  payments   Shipment:e->Article:n - - + + -  lines.sku   +  lines.sku   Shipment:w->Order:n - - + + -  manifestId   +  manifestId   Shipment:w->Shipping:n - - + + -  shippings   +  shippings   Package - - - -Package -/package - - - -DELETE -/{id} -Delete package + + + +Package +/package + + + +DELETE +/{id} +Delete package Shipping:e->Package:n - - + + -  packages   +  packages   Package:e->Entity:n - - + + -  addressId   +  addressId   Package:w->Shipping:n - - + + -  shippingId   +  shippingId   Stock - - - -Stock -/stock - - - -POST -/adjust -Adjust stock manually + + + +Stock +/stock + + + +POST +/accept +Accept delivery manifest it… + + + +POST +/adjust +Adjust stock manually + + + +POST +/ship +Ship shipment manifest item… Stock:e->Article:n - - + + -  sku   +  sku   Stock:e->Ledger:n - - + + -  ledger   +  ledger   Warehouse - - - - -Warehouse -/warehouse - - - -GET -/ -List warehouses - - - -POST -/ -Create warehouse - - - -GET -/{id} -Get warehouse by ID - - - -PUT -/{id} -Update warehouse - - - -PUT -/order -Reorder warehouses - - - -PATCH -/{id} -Update warehouse (partial) - - - -DELETE -/{id} -Delete warehouse + + + + +Warehouse +/warehouse + + + +GET +/ +List warehouses + + + +POST +/ +Create warehouse + + + +GET +/{id} +Get warehouse by ID + + + +PUT +/{id} +Update warehouse + + + +PUT +/order +Reorder warehouses + + + +PATCH +/{id} +Update warehouse (partial) + + + +DELETE +/{id} +Delete warehouse Stock:e->Warehouse:n - + + -  warehouseId   +  warehouseId   Ledger:w->Article:n - - + + -  sku   +  sku   Ledger:w->Warehouse:n - - + + -  warehouseId   +  warehouseId   Account - - - -Account -/account - - - -GET -/ -List accounts - - - -POST -/ -Create account - - - -DELETE -/{id} -Delete account + + + +Account +/account + + + +GET +/ +List accounts + + + +POST +/ +Create account + + + +DELETE +/{id} +Delete account Account:e->Company:n - - + + -  companyId   +  companyId   Payment:w->Order:n - - + + -  manifestId   +  manifestId   -Payment:w->Account:n +Payment:e->Account:n - - + + -  accountId   +  accountId   Serper - - -Serper -/serper - - - -POST -/image -Crawl image from URL, crop … - - - -POST -/images -Search images via Serper.de… + + +Serper +/serper + + + +POST +/image +Crawl image from URL, crop … + + + +POST +/images +Search images via Serper.de… Vfs - - - -Vfs -/vfs - - - -GET -/ -List virtual filesystem fil… - - - -GET -/{*path} -Get a virtual filesystem fi… - - - -POST -/{*path} -Execute a virtual filesyste… - - - -POST -/drafts/response -Respond to a frontend draft… - - - -POST -/mkdir -Create directory in virtual… - - - -POST -/rename -Rename or move a virtual fi… - - - -POST -/upload -Upload files to virtual fil… - - - -PUT -/{*path} -Create or overwrite a virtu… - - - -DELETE -/{*path} -Delete a virtual filesystem… + + + +Vfs +/vfs + + + +GET +/ +List virtual filesystem fil… + + + +GET +/{*path} +Get a virtual filesystem fi… + + + +POST +/{*path} +Execute a virtual filesyste… + + + +POST +/applets/restore +Restore system default appl… + + + +POST +/mkdir +Create directory in virtual… + + + +POST +/rename +Rename or move a virtual fi… + + + +POST +/skills/restore +Restore system default skil… + + + +POST +/upload +Upload files to virtual fil… + + + +PUT +/{*path} +Create or overwrite a virtu… + + + +DELETE +/{*path} +Delete a virtual filesystem… POSTerminal - - - -POSTerminal -/posterminal - - - -GET -/ -List POS terminals - - - -PUT -/ -Create POS terminal - - - -PUT -/{id}/all -Enable all categories on te… - - - -PUT -/{id}/category/{categoryId} -Enable category on terminal - - - -PATCH -/{id} -Update POS terminal - - - -DELETE -/{id} -Delete POS terminal - - - -DELETE -/{id}/all -Disable all categories on t… - - - -DELETE -/{id}/category/{categoryId} -Disable category on terminal + + + +POSTerminal +/posterminal + + + +GET +/ +List POS terminals + + + +PUT +/ +Create POS terminal + + + +PUT +/{id}/all +Enable all categories on te… + + + +PUT +/{id}/category/{categoryId} +Enable category on terminal + + + +PATCH +/{id} +Update POS terminal + + + +DELETE +/{id} +Delete POS terminal + + + +DELETE +/{id}/all +Disable all categories on t… + + + +DELETE +/{id}/category/{categoryId} +Disable category on terminal -POSTerminal:w->Company:n +POSTerminal:e->Company:n - - + + -  companyId   +  companyId   POSTerminal:w->Category:n - - + + -  root_category   +  root_category   Printer - - -Printer -/printer - - - -GET -/ -List printers - - - -POST -/ -Create printer - - - -GET -/{id} -Get printer by ID - - - -PUT -/{id} -Update printer - - - -PUT -/order -Reorder printers - - - -PATCH -/{id} -Update printer (partial) - - - -DELETE -/{id} -Delete printer + + +Printer +/printer + + + +GET +/ +List printers + + + +POST +/ +Create printer + + + +GET +/{id} +Get printer by ID + + + +PUT +/{id} +Update printer + + + +PUT +/order +Reorder printers + + + +PATCH +/{id} +Update printer (partial) + + + +DELETE +/{id} +Delete printer -Printer:w->Company:n +Printer:e->Company:n - - + + -  companyId   +  companyId   LabelTemplate - - - -LabelTemplate -/labeltemplate - - - -GET -/ -List label templates - - - -POST -/ -Create label template - - - -GET -/{id} -Get label template by ID - - - -PUT -/{id} -Update label template - - - -PATCH -/{id} -Update label template (part… - - - -DELETE -/{id} -Delete label template + + + +LabelTemplate +/labeltemplate + + + +GET +/ +List label templates + + + +POST +/ +Create label template + + + +GET +/{id} +Get label template by ID + + + +PUT +/{id} +Update label template + + + +PATCH +/{id} +Update label template (part… + + + +DELETE +/{id} +Delete label template @@ -2231,362 +2280,392 @@ -  templates   +  templates   -LabelTemplate:w->Company:n +LabelTemplate:e->Company:n - - + + -  companyId   +  companyId   POSSync - - -POSSync -/v1 - - - -GET -/category -JTL-POS category synchroniz… - - - -GET -/client -POS discovery and pairing - - - -GET -/init -POS sync initialization cou… - - - -GET -/pimage -POS product image delivery - - - -GET -/product -JTL-POS product catalog syn… + + +POSSync +/v1 + + + +GET +/category +JTL-POS category synchroniz… + + + +GET +/client +POS discovery and pairing + + + +GET +/init +POS sync initialization cou… + + + +GET +/pimage +POS product image delivery + + + +GET +/product +JTL-POS product catalog syn… POSSync:w->Article:n - - + + -  product sync   +  product sync   POSSync:w->Category:n - - + + -  category sync   - - - -POSSync:w->POSTerminal:n - - - -  client bind   +  category sync   ModelConversation - - -ModelConversation -/modelconversation - - - -GET -/ -List conversations - - - -POST -/ -Create conversation - - - -GET -/{id} -Get conversation - - - -GET -/{id}/message -List conversation messages - - - -GET -/{id}/stream -Stream conversation events … - - - -POST -/{id}/message -Post a user message - - - -DELETE -/{id} -Delete conversation + + +ModelConversation +/modelconversation + + + +GET +/ +List conversations + + + +POST +/ +Create conversation + + + +GET +/{id} +Get conversation + + + +GET +/{id}/message +List conversation messages + + + +GET +/{id}/stream +Stream conversation events … + + + +POST +/{id}/message +Post a user message + + + +DELETE +/{id} +Delete conversation ModelConversation:e->Vfs:n - - + + -  vfs workspace   +  vfs workspace   MCP - - -MCP -/mcp - - - -POST -/ -Model Context Protocol (MCP… - - - -GET -/authorizations -List active MCP client auth… - - - -GET -/authorize -Get MCP authorization promp… - - - -GET -/clients -List registered MCP clients - - - -GET -/oauth/authorize -OAuth 2.1 Authorization End… - - - -POST -/authorize -Grant or deny MCP client au… - - - -POST -/oauth/introspect -OAuth 2.0 Token Introspecti… - - - -POST -/oauth/register -Dynamic Client Registration… - - - -POST -/oauth/token -OAuth 2.1 Token Endpoint (R… - - - -DELETE -/authorizations/{clientId} -Revoke MCP client authoriza… - - - -DELETE -/clients/{clientId} -Delete registered MCP client + + +MCP +/mcp + + + +POST +/ +Model Context Protocol (MCP… + + + +GET +/authorizations +List active MCP client auth… + + + +GET +/authorize +Get MCP authorization promp… + + + +GET +/clients +List registered MCP clients + + + +GET +/oauth/authorize +OAuth 2.1 Authorization End… + + + +POST +/authorize +Grant or deny MCP client au… + + + +POST +/oauth/introspect +OAuth 2.0 Token Introspecti… + + + +POST +/oauth/register +Dynamic Client Registration… + + + +POST +/oauth/token +OAuth 2.1 Token Endpoint (R… + + + +DELETE +/authorizations/{clientId} +Revoke MCP client authoriza… + + + +DELETE +/clients/{clientId} +Delete registered MCP client MCP:w->Article:n - - + + -  article tools   +  article tools   MCP:w->Order:n - - + + -  order tools   +  order tools   Events - - -Events -/events - - - -GET -/ -Subscribe to update signals… + + +Events +/events + + + +GET +/ +Subscribe to update signals… Events:w->Article:n - - + + -  article sse   +  article sse   Events:w->Stock:n - - + + -  stock sse   +  stock sse   Events:w->Ledger:n - - + + -  ledger sse   +  ledger sse   Health - - -Health -/health - - - -GET -/ -Database health check + + +Health +/health + + + +GET +/ +Database health check Legend - - - -API Graph Legend - - -GET - -Safe retrieval / query - - -POST - -Create resource / action - - -PUT - -Full replace / collection update - - -PATCH - -Partial entity update - - -DELETE - -Remove resource - -in# - -Inbound arrival port on resource - -▪—▶ - -Relational reference / dataflow + + + +API Graph Legend + + +GET + +Safe retrieval / query + + +POST + +Create resource / action + + +PUT + +Full replace / collection update + + +PATCH + +Partial entity update + + +DELETE + +Remove resource + +in# + +Inbound arrival port on resource + +▪—▶ + +Relational reference / dataflow + + + +SubagentSchedule + + +SubagentSchedule +/subagentschedule + + + +GET +/ +List subagent schedules + + + +POST +/ +Create subagent schedule + + + +GET +/{id} +Get subagent schedule by ID + + + +PUT +/{id} +Update subagent schedule + + + +DELETE +/{id} +Delete subagent schedule - + Backup - - -Backup -/backup - - - -GET -/ -List backups and service st… - - - -GET -/{id}/vfs -List VFS files in a backup - - - -POST -/{id}/vfs/recover -Recover VFS file from a bac… + + +Backup +/backup + + + +GET +/ +List backups and service st… + + + +GET +/{id}/vfs +List VFS files in a backup + + + +POST +/{id}/vfs/recover +Recover VFS file from a bac… diff --git a/docs/api/README.md b/docs/api/README.md index c5d532c..c327c4d 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -250,6 +250,11 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route | [`routes/stock/accept.md`](routes/stock/accept.md) | `POST /stock/accept` | | [`routes/stock/adjust.md`](routes/stock/adjust.md) | `POST /stock/adjust` | | [`routes/stock/ship.md`](routes/stock/ship.md) | `POST /stock/ship` | +| [`routes/subagentschedule.get.md`](routes/subagentschedule.get.md) | `GET /subagentschedule` | +| [`routes/subagentschedule.post.md`](routes/subagentschedule.post.md) | `POST /subagentschedule` | +| [`routes/subagentschedule/_id.delete.md`](routes/subagentschedule/_id.delete.md) | `DELETE /subagentschedule/{id}` | +| [`routes/subagentschedule/_id.get.md`](routes/subagentschedule/_id.get.md) | `GET /subagentschedule/{id}` | +| [`routes/subagentschedule/_id.put.md`](routes/subagentschedule/_id.put.md) | `PUT /subagentschedule/{id}` | | [`routes/supplier/list.md`](routes/supplier/list.md) | `GET /supplier` | | [`routes/supplier/create.md`](routes/supplier/create.md) | `POST /supplier` | | [`routes/supplier/delete.md`](routes/supplier/delete.md) | `DELETE /supplier/{id}` | @@ -308,6 +313,7 @@ Clients subscribe via [`GET /events`](routes/events.md) (`text/event-stream`). A | `shipment` | `PATCH /shipment/{id}`, `DELETE /shipment/{id}/file/{fileId}`, `POST /shipment/{id}/pdf` | | `shipping` | `POST /stock/ship` | | `stock` | `POST /stock/accept`, `POST /stock/adjust`, `POST /stock/ship` | +| `subagentschedule` | `POST /subagentschedule`, `DELETE /subagentschedule/{id}`, `PUT /subagentschedule/{id}` | | `vfs` | `POST /vfs/applets/restore`, `POST /vfs/mkdir`, `POST /vfs/rename`, `POST /vfs/skills/restore`, `POST /vfs/upload`, `DELETE /vfs/{*path}`, `POST /vfs/{*path}`, `PUT /vfs/{*path}` | | `warehouse` | `POST /warehouse`, `PUT /warehouse/order`, `DELETE /warehouse/{id}`, `PUT /warehouse/{id}` | diff --git a/docs/api/routes-all.md b/docs/api/routes-all.md index 1004292..f51716f 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 250 API endpoints across all modules. +Overview of all 255 API endpoints across all modules. ### Notation @@ -10,60 +10,62 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). ### Reusable types - `T1` = `{ order: T2 }` -- `T2` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T29[], externalNumber?: str|null, createdAt?: str, shipping?: T36|null, shippings?: T36[], payment?: T42|null, payments?: T42[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T6[], files?: T16[] }` +- `T2` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T31[], externalNumber?: str|null, createdAt?: str, shipping?: T38|null, shippings?: T38[], payment?: T44|null, payments?: T44[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T6[], files?: T16[] }` - `T3` = `{ article: T4 }` -- `T4` = `{ id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T39, brand: T37|null, categoryIds: int[], photos: T34[], eans: str[], prices: T46[], suppliers: T18[] }` +- `T4` = `{ id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T41, brand: T39|null, categoryIds: int[], photos: T36[], eans: str[], prices: T48[], suppliers: T18[] }` - `T5` = `{ shipment: T6 }` -- `T6` = `{ id: int, number: str, type: str, date: str, lines: T29[], shippings: T36[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T16[], state?: str }` +- `T6` = `{ id: int, number: str, type: str, date: str, lines: T31[], shippings: T38[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T16[], state?: str }` - `T7` = `{ quote: T8 }` -- `T8` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T29[], externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T16[] }` +- `T8` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T31[], externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T16[] }` - `T9` = `{ delivery: T10 }` -- `T10` = `{ id: int, number: str, type: str, supplierId: int|null, date: str, lines: T29[], files: T16[], externalNumber?: str|null, createdAt?: str, ledger?: T50 }` +- `T10` = `{ id: int, number: str, type: str, supplierId: int|null, date: str, lines: T31[], files: T16[], externalNumber?: str|null, createdAt?: str, ledger?: T52 }` - `T11` = `{ name: str, path: str, totalSizeBytes: int, timestamp: str|null, manifest?: T12|null }` - `T12` = `{ id: str, timestamp: str, dateKey: str, monthKey: str, dbProvider: str, files: T19, totalSizeBytes: int, durationMs: int }` - `T13` = `{ labeltemplate: T15 }` - `T14` = `{ attachment: T16, fileUrl: str }` -- `T15` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: T26, thumb?: str|null }` +- `T15` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: T28, thumb?: str|null }` - `T16` = `{ 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 }` - `T17` = `{ id: int, name: str, pairingpin?: str|null, token?: str|null, pairedAt?: str|null, clientserial?: str|null, rootCategoryId?: int|null, syncRootArticles?: bool, lastseenAt?: str|null, updatedAt?: str|null, categoryIds?: int[] }` -- `T18` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T53|null }` -- `T19` = `{ vfs: T51, storage: T51, database: T44 }` -- `T20` = `{ 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 }` -- `T21` = `{ ledger: T22[] }` -- `T22` = `{ 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 }` -- `T23` = `{ id: int, name: str, sort: int, exclusive: bool, values: T40[], articleCount?: int }` -- `T24` = `{ 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 }` -- `T25` = `{ id: int, name: str, rootCategoryId: int|null, languageId: int|null, iso639: str|null, taxrate: num, reducedtaxrate: num, taxfreerate: num }` -- `T26` = `{ objects: T30[] }` -- `T27` = `{ printer: T32 }` -- `T28` = `{ entity: T35 }` -- `T29` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }` -- `T30` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` -- `T31` = `{ shipping: T36 }` -- `T32` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }` -- `T33` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }` -- `T34` = `{ sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }` -- `T35` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` -- `T36` = `{ id: int, manifestId: int, number: str, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` -- `T37` = `{ name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }` -- `T38` = `{ article: T43 }` -- `T39` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` -- `T40` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` -- `T41` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` -- `T42` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` -- `T43` = `{ id: int, categoryId: int, name: str, sku: str, track_stock: bool }` -- `T44` = `{ name: str|null, sizeBytes: int, backedUp: bool, reason?: str|null }` -- `T45` = `{ id: int, email: str, selectedCompanyId: int|null, picture?: str }` -- `T46` = `{ minmultiplier: num, net: num, taxRate: num, customergroupId: int }` -- `T47` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` -- `T48` = `{ id: int, entityId: int, contactType: str, contact: str }` -- `T49` = `{ id: int, name: str, createdAt: str, updatedAt: str }` -- `T50` = `{ totalPositions: int, completelyOnLedgerPositions: int }` -- `T51` = `{ name: str, sizeBytes: int, sourceExists: bool }` -- `T52` = `{ warehouse: T54 }` -- `T53` = `{ net: num, taxId: int, taxRate?: num|null }` -- `T54` = `{ id: int, name: str, sort: int }` -- `T55` = `{ id: int, categoryIds: int[] }` +- `T18` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T55|null }` +- `T19` = `{ vfs: T53, storage: T53, database: T46 }` +- `T20` = `{ schedule: T23 }` +- `T21` = `{ 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 }` +- `T22` = `{ ledger: T24[] }` +- `T23` = `{ 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 }` +- `T24` = `{ 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 }` +- `T25` = `{ id: int, name: str, sort: int, exclusive: bool, values: T42[], articleCount?: int }` +- `T26` = `{ 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 }` +- `T27` = `{ id: int, name: str, rootCategoryId: int|null, languageId: int|null, iso639: str|null, taxrate: num, reducedtaxrate: num, taxfreerate: num }` +- `T28` = `{ objects: T32[] }` +- `T29` = `{ printer: T34 }` +- `T30` = `{ entity: T37 }` +- `T31` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }` +- `T32` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` +- `T33` = `{ shipping: T38 }` +- `T34` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }` +- `T35` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }` +- `T36` = `{ sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }` +- `T37` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` +- `T38` = `{ id: int, manifestId: int, number: str, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` +- `T39` = `{ name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }` +- `T40` = `{ article: T45 }` +- `T41` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` +- `T42` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` +- `T43` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` +- `T44` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` +- `T45` = `{ id: int, categoryId: int, name: str, sku: str, track_stock: bool }` +- `T46` = `{ name: str|null, sizeBytes: int, backedUp: bool, reason?: str|null }` +- `T47` = `{ id: int, email: str, selectedCompanyId: int|null, picture?: str }` +- `T48` = `{ minmultiplier: num, net: num, taxRate: num, customergroupId: int }` +- `T49` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` +- `T50` = `{ id: int, entityId: int, contactType: str, contact: str }` +- `T51` = `{ id: int, name: str, createdAt: str, updatedAt: str }` +- `T52` = `{ totalPositions: int, completelyOnLedgerPositions: int }` +- `T53` = `{ name: str, sizeBytes: int, sourceExists: bool }` +- `T54` = `{ warehouse: T56 }` +- `T55` = `{ net: num, taxId: int, taxRate?: num|null }` +- `T56` = `{ id: int, name: str, sort: int }` +- `T57` = `{ id: int, categoryIds: int[] }` ### Routes @@ -93,7 +95,7 @@ _none_ #### Create article in category — `POST /article` - Params: `body: { categoryId: int, name: str, desc?: str, seo?: str, track_stock?: bool }` -- Returns: `201 T38` +- Returns: `201 T40` #### Export articles as ZIP — `GET /article/export.zip` - Params: `query: categoryId?: int` - Returns: `200 zip` @@ -129,10 +131,10 @@ _none_ - Returns: `200 { children: { id: int, sku: str, name: str, parentsort: int, attributeValueId: int, attributeValue: str }[] }` #### Create and attach a new child article to a parent article — `POST /article/{sku}/children` - Params: `sku: str, body: { attributeValueId?: int, value?: str, name?: str }` -- Returns: `201 T38` +- Returns: `201 T40` #### Attach an existing article as a child to a parent article — `PUT /article/{sku}/children` - Params: `sku: str, body: { sku: str, attributeValueId?: int, value?: str, reparent?: bool }` -- Returns: `200 { article: T43, children: { id: int, sku: str, name: str, parentsort: int, attributeValueId: int, attributeValue: str }[] }` +- Returns: `200 { article: T45, children: { id: int, sku: str, name: str, parentsort: int, attributeValueId: int, attributeValue: str }[] }` #### Remove a child article from a parent article — `DELETE /article/{sku}/children/{childSku}` - Params: `sku: str, childSku: str, query: deleteArticle?: bool` - Returns: `200 { success: bool, deleted: bool }` @@ -159,7 +161,7 @@ _none_ - Returns: `200 { options: { id: int, articleId: int, sku: str, name: str, count: int, sort: int, mandated: bool }[] }` #### Toggle parent mode for an article — `POST /article/{sku}/parent` - Params: `sku: str, body: { isParent: bool, attributeNameId?: int }` -- Returns: `200 T38` +- Returns: `200 T40` #### Replace POS prices by SKU (net > gross; price=net, tax=taxRate %) — `PUT /article/{sku}/prices` - Params: `sku: str, body: { prices: { net?: num, gross?: num, price?: num, taxRate?: num, tax?: num, minmultiplier?: num }[] }` - Returns: `200 T3` @@ -201,19 +203,19 @@ _none_ #### List attribute names — `GET /attributename` _none_ -- Returns: `200 { attributenames: T23[] }` +- Returns: `200 { attributenames: T25[] }` #### Create attribute name — `POST /attributename` - Params: `body: { name: str, sort?: int, exclusive?: bool }` -- Returns: `201 { attributename: T23 }` +- Returns: `201 { attributename: T25 }` #### 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: T40[] }` +- Returns: `200 { values: T42[] }` #### Create value for an attribute — `POST /attributename/{attributeId}/value` - Params: `attributeId: int, body: { value: str, sort?: int }` -- Returns: `201 { attributevalue: T40 }` +- Returns: `201 { attributevalue: T42 }` #### Reorder values of an attribute — `PUT /attributename/{attributeId}/value/order` - Params: `attributeId: int, body: { attributevalueIds: int[] }` - Returns: `200 { ok: bool }` @@ -222,7 +224,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: T23 }` +- Returns: `200 { attributename: T25 }` ### Section: /attributevalue @@ -231,28 +233,28 @@ _none_ - Returns: `200 { ok: bool }` #### Update attribute value — `PATCH /attributevalue/{id}` - Params: `id: int, body: { value?: str, sort?: int }` -- Returns: `200 { attributevalue: T40 }` +- Returns: `200 { attributevalue: T42 }` #### 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: T47[] } }` +- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T49[] } }` #### 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: T47[] } }` +- Returns: `201 { attributevalue: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T49[] } }` ### Section: /auth #### Login with Google ID token — `POST /auth/login` - Params: `body: { idToken: str }` -- Returns: `200 { message: str, user: T45 }` +- Returns: `200 { message: str, user: T47 }` #### Logout — `POST /auth/logout` _none_ - Returns: `200 { message: str }` #### Current user — `GET /auth/me` _none_ -- Returns: `200 { user: T45, googleClientId: str }` +- Returns: `200 { user: T47, googleClientId: str }` #### Set selected company — `PUT /auth/selected-company` - Params: `body: { companyId: int }` -- Returns: `200 { user: T45 }` +- Returns: `200 { user: T47 }` ### Section: /backup @@ -273,7 +275,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: T47[], gsprpinfo?: str|null } }` +- Returns: `201 { brand: { id: int, name: str, pics: T49[], gsprpinfo?: str|null } }` #### Delete brand — `DELETE /brand/{id}` - Params: `id: int` - Returns: `204 void` @@ -282,10 +284,10 @@ _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: T47[] } }` +- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T49[] } }` #### 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: T47[] } }` +- Returns: `201 { brand: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T49[] } }` ### Section: /category @@ -309,7 +311,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` -- 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, brand?: T37|null }[] }` +- 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, brand?: T39|null }[] }` #### 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 }[] }` @@ -336,10 +338,10 @@ _none_ #### List companies — `GET /company` _none_ -- Returns: `200 { companies: T25[] }` +- Returns: `200 { companies: T27[] }` #### Create company — `POST /company` - Params: `body: { iso639: str, name: str, taxrate: num, reducedtaxrate: num }` -- Returns: `201 { company: T25, user: T45 }` +- Returns: `201 { company: T27, user: T47 }` #### Export company catalog as zip archive (SSE) — `GET /company/export` - Params: `query: stream?: str` - Returns: `200 SSE` @@ -369,7 +371,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: T25 }` +- Returns: `200 { company: T27 }` ### Section: /customergroup @@ -378,7 +380,7 @@ _none_ - Returns: `200 { customergroups: { id: int, name: str, sort: int, editable: bool }[] }` #### Create customer group — `POST /customergroup` - Params: `body: { name: str }` -- Returns: `201 { customergroup: T54 }` +- Returns: `201 { customergroup: T56 }` #### Reorder customer groups — `PUT /customergroup/order` - Params: `body: { customergroupIds: int[] }` - Returns: `200 { customergroupIds: int[] }` @@ -387,15 +389,15 @@ _none_ - Returns: `204 void` #### Update customer group — `PATCH /customergroup/{id}` - Params: `id: int, body: { name: str }` -- Returns: `200 { customergroup: T54 }` +- Returns: `200 { customergroup: T56 }` ### Section: /delivery #### 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|null, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T50 }[], total: int, unfilteredTotal: int, offset: int, limit: int }` +- Returns: `200 { deliveries: { id: int, number: str, type: str, supplierId: int|null, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T52 }[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create delivery — `POST /delivery` -- Params: `body: { externalNumber: str, date: str, lines: T33[], supplierId?: int|null, files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` +- Params: `body: { externalNumber: str, date: str, lines: T35[], supplierId?: int|null, files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` - Returns: `201 T9` #### Delete delivery — `DELETE /delivery/{id}` - Params: `id: int` @@ -404,7 +406,7 @@ _none_ - Params: `id: int` - Returns: `200 T9` #### Update delivery — `PATCH /delivery/{id}` -- Params: `id: int, body: { externalNumber?: str|null, date?: str, supplierId?: int|null, lines?: T33[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` +- Params: `id: int, body: { externalNumber?: str|null, date?: str, supplierId?: int|null, lines?: T35[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` - Returns: `200 T9` #### Delete delivery file attachment — `DELETE /delivery/{id}/file/{fileId}` - Params: `id: int, fileId: int` @@ -420,46 +422,46 @@ _none_ #### List entities — `GET /entity` - Params: `query: customergroupId?: int, role?: str` -- Returns: `200 { entities: T35[] }` +- Returns: `200 { entities: T37[] }` #### Create entity — `POST /entity` - Params: `body: { customergroupId: int, name: str, firstName?: str|null, number?: str }` -- Returns: `201 T28` +- Returns: `201 T30` #### 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: T20[] }` +- Returns: `200 { addresses: T21[] }` #### 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: T20 }` +- Returns: `201 { address: T21 }` #### 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: T20 }` +- Returns: `200 { address: T21 }` #### List entity contacts — `GET /entity/{entityId}/contact` - Params: `entityId: int` -- Returns: `200 { contacts: T48[] }` +- Returns: `200 { contacts: T50[] }` #### Create entity contact — `POST /entity/{entityId}/contact` - Params: `entityId: int, body: { contactType: str, contact: str }` -- Returns: `201 { contact: T48 }` +- Returns: `201 { contact: T50 }` #### 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: T48 }` +- Returns: `200 { contact: T50 }` #### Delete entity — `DELETE /entity/{id}` - Params: `id: int` - Returns: `204 void` #### Get entity — `GET /entity/{id}` - Params: `id: int` -- Returns: `200 T28` +- Returns: `200 T30` #### Update entity — `PATCH /entity/{id}` - Params: `id: int, body: { name?: str, firstName?: str|null, number?: str|null }` -- Returns: `200 T28` +- Returns: `200 T30` ### Section: /events @@ -501,7 +503,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: T26 }` +- Params: `body: { name: str, width: num, height: num, dpi: int, type: str, content: T28 }` - Returns: `201 T13` #### Delete label template — `DELETE /labeltemplate/{id}` - Params: `id: int` @@ -510,23 +512,23 @@ _none_ - Params: `id: int` - Returns: `200 T13` #### Update label template (partial) — `PATCH /labeltemplate/{id}` -- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: T26 }` +- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: T28 }` - Returns: `200 T13` #### Update label template — `PUT /labeltemplate/{id}` -- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: T26 }` +- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: T28 }` - Returns: `200 T13` ### Section: /ledger #### Query ledger by manifest article ID or SKU — `GET /ledger` - Params: `query: manifestarticle_id?: int, sku?: str, transaction_type?: str` -- Returns: `200 T21` +- Returns: `200 T22` #### Query ledger by manifest article ID — `GET /ledger/manifestarticle/{manifestarticleId}` - Params: `manifestarticleId: int, query: transaction_type?: str` -- Returns: `200 T21` +- Returns: `200 T22` #### Query ledger by article SKU — `GET /ledger/sku/{sku}` - Params: `sku: str, query: transaction_type?: str` -- Returns: `200 T21` +- Returns: `200 T22` ### Section: /mcp @@ -556,16 +558,16 @@ _none_ #### List conversations — `GET /modelconversation` _none_ -- Returns: `200 { conversations: T24[] }` +- Returns: `200 { conversations: T26[] }` #### Create conversation — `POST /modelconversation` - Params: `body: { provider: str, model: str }` -- Returns: `201 { conversation: T24 }` +- Returns: `201 { conversation: T26 }` #### Delete conversation — `DELETE /modelconversation/{id}` - Params: `id: int` - Returns: `204 void` #### Get conversation — `GET /modelconversation/{id}` - Params: `id: int` -- Returns: `200 { conversation: T24 }` +- Returns: `200 { conversation: T26 }` #### 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 }[] }` @@ -606,7 +608,7 @@ _none_ - Params: `query: offset?: int, limit?: int, search?: str, onlyUnpaid?: bool, onlyUndelivered?: bool, seekMonths?: int` - Returns: `200 { orders: T2[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create order — `POST /order` -- Params: `body: { number: str, date: str, lines: T33[], entityId?: int|null, externalNumber?: str|null }` +- Params: `body: { number: str, date: str, lines: T35[], entityId?: int|null, externalNumber?: str|null }` - Returns: `201 T1` #### Delete order — `DELETE /order/{id}` - Params: `id: int` @@ -615,7 +617,7 @@ _none_ - Params: `id: int` - Returns: `200 T1` #### Update order — `PATCH /order/{id}` -- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T33[] }` +- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T35[] }` - Returns: `200 T1` #### Delete order file attachment — `DELETE /order/{id}/file/{fileId}` - Params: `id: int, fileId: int` @@ -625,10 +627,10 @@ _none_ - Returns: `200 str` #### List payments of an order — `GET /order/{id}/payment` - Params: `id: int` -- Returns: `200 { payments: T42[] }` +- Returns: `200 { payments: T44[] }` #### Add payment to an order — `POST /order/{id}/payment` - Params: `id: int, body: { accountId: int, type: str, amount: num }` -- Returns: `201 { payment: T42 }` +- Returns: `201 { payment: T44 }` #### Generate and attach order PDF — `POST /order/{id}/pdf` - Params: `id: int` - Returns: `201 T14` @@ -640,10 +642,10 @@ _none_ - Returns: `201 T5` #### List shippings of an order — `GET /order/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T36[] }` +- Returns: `200 { shippings: T38[] }` #### Create shipping for an order — `POST /order/{id}/shipping` - Params: `id: int, body: { type: str, state: str, warehouseId?: int }` -- Returns: `201 T31` +- Returns: `201 T33` ### Section: /package @@ -673,25 +675,25 @@ _none_ - Returns: `200 { posterminal: T17 }` #### Disable all categories on terminal — `DELETE /posterminal/{id}/all` - Params: `id: int` -- Returns: `200 T55` +- Returns: `200 T57` #### Enable all categories on terminal — `PUT /posterminal/{id}/all` - Params: `id: int` -- Returns: `200 T55` +- Returns: `200 T57` #### Disable category on terminal — `DELETE /posterminal/{id}/category/{categoryId}` - Params: `id: int, categoryId: int` -- Returns: `200 T55` +- Returns: `200 T57` #### Enable category on terminal — `PUT /posterminal/{id}/category/{categoryId}` - Params: `id: int, categoryId: int` -- Returns: `200 T55` +- Returns: `200 T57` ### Section: /printer #### List printers — `GET /printer` _none_ -- Returns: `200 { printers: T32[] }` +- Returns: `200 { printers: T34[] }` #### Create printer — `POST /printer` - Params: `body: { address: str, type: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }` -- Returns: `201 T27` +- Returns: `201 T29` #### Reorder printers — `PUT /printer/order` - Params: `body: { printerIds: int[] }` - Returns: `200 { printerIds: int[] }` @@ -700,22 +702,22 @@ _none_ - Returns: `204 void` #### Get printer by ID — `GET /printer/{id}` - Params: `id: int` -- Returns: `200 T27` +- Returns: `200 T29` #### 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 T27` +- Returns: `200 T29` #### 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 T27` +- Returns: `200 T29` ### Section: /propertyname #### List property names — `GET /propertyname` _none_ -- Returns: `200 { propertynames: T41[] }` +- Returns: `200 { propertynames: T43[] }` #### Create property name — `POST /propertyname` - Params: `body: { name: str, sort?: int, exclusive?: bool }` -- Returns: `201 { propertyname: T41 }` +- Returns: `201 { propertyname: T43 }` #### Reorder property names — `PUT /propertyname/order` - Params: `body: { propertynameIds: int[] }` - Returns: `200 { ok: bool }` @@ -724,7 +726,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: T41 }` +- Returns: `200 { propertyname: T43 }` ### Section: /public @@ -736,7 +738,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: T39|null, brand: T37|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: T34[], 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: T41|null, brand: T39|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: T36[], 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 }[] }` @@ -747,7 +749,7 @@ _none_ - Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int` - Returns: `200 { quotes: T8[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create quote — `POST /quote` -- Params: `body: { number: str, date: str, lines: T33[], entityId?: int|null, externalNumber?: str|null }` +- Params: `body: { number: str, date: str, lines: T35[], entityId?: int|null, externalNumber?: str|null }` - Returns: `201 T7` #### Delete quote — `DELETE /quote/{id}` - Params: `id: int` @@ -756,7 +758,7 @@ _none_ - Params: `id: int` - Returns: `200 T7` #### Update quote — `PATCH /quote/{id}` -- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T33[] }` +- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T35[] }` - Returns: `200 T7` #### Delete quote file attachment — `DELETE /quote/{id}/file/{fileId}` - Params: `id: int, fileId: int` @@ -765,7 +767,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?: T33[] }` +- Params: `id: int, body?: { number?: str, date?: str, createdAt?: str, entityId?: int|null, externalNumber?: str|null, lines?: T35[] }` - Returns: `201 T1` #### Generate and attach quote PDF — `POST /quote/{id}/pdf` - Params: `id: int` @@ -811,10 +813,10 @@ _none_ - Returns: `201 T14` #### List packages of a shipment — `GET /shipment/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T36[] }` +- Returns: `200 { shippings: T38[] }` #### Create package for a shipment — `POST /shipment/{id}/shipping` - Params: `id: int, body: { type: str, state: str, trackingCode?: str, carrier?: str, warehouseId?: int }` -- Returns: `201 T31` +- Returns: `201 T33` ### Section: /shipping @@ -823,7 +825,7 @@ _none_ - Returns: `204 void` #### Update shipping — `PATCH /shipping/{id}` - Params: `id: int, body: { type?: str, state?: str, trackingCode?: str, carrier?: str, warehouseId?: int }` -- Returns: `200 T31` +- Returns: `200 T33` #### 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 }[] }` @@ -844,31 +846,49 @@ _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: T22[] }` +- 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: T24[] }` #### Ship shipment manifest item(s) — `POST /stock/ship` - Params: `body: { manifestarticleId?: int, warehouseId?: int, items?: { manifestarticleId: int, warehouseId?: int }[] }` - Returns: `200` +### Section: /subagentschedule + +#### List subagent schedules — `GET /subagentschedule` +_none_ +- Returns: `200 { schedules: T23[] }` +#### 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 T20` +#### 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 T20` +#### 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 T20` + ### Section: /supplier #### List suppliers — `GET /supplier` _none_ -- Returns: `200 { suppliers: T49[] }` +- Returns: `200 { suppliers: T51[] }` #### Create supplier — `POST /supplier` - Params: `body: { name: str }` -- Returns: `201 { supplier: T49 }` +- Returns: `201 { supplier: T51 }` #### 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: T49 }` +- Returns: `200 { supplier: T51 }` #### 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?: T53|null }[] }` +- 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?: T55|null }[] }` #### 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?: T53|null }[] }` +- 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?: T55|null }[] }` ### Section: /thumb @@ -883,10 +903,10 @@ _none_ - Returns: `204 void` #### List units — `GET /unit` _none_ -- Returns: `200 { units: T39[] }` +- Returns: `200 { units: T41[] }` #### Upsert unit — `PUT /unit` - Params: `body: { si: str, basesi: str, basesifactor: num, symbol: str, name: str }` -- Returns: `200 { unit: T39 }` +- Returns: `200 { unit: T41 }` ### Section: /v1 @@ -943,10 +963,10 @@ _none_ #### List warehouses — `GET /warehouse` _none_ -- Returns: `200 { warehouses: T54[] }` +- Returns: `200 { warehouses: T56[] }` #### Create warehouse — `POST /warehouse` - Params: `body: { name: str, sort?: int }` -- Returns: `201 T52` +- Returns: `201 T54` #### Reorder warehouses — `PUT /warehouse/order` - Params: `body: { warehouseIds: int[] }` - Returns: `200 { warehouseIds: int[] }` @@ -955,10 +975,10 @@ _none_ - Returns: `204 void` #### Get warehouse by ID — `GET /warehouse/{id}` - Params: `id: int` -- Returns: `200 T52` +- Returns: `200 T54` #### Update warehouse (partial) — `PATCH /warehouse/{id}` - Params: `id: int, body: { name?: str, sort?: int }` -- Returns: `200 T52` +- Returns: `200 T54` #### Update warehouse — `PUT /warehouse/{id}` - Params: `id: int, body: { name?: str, sort?: int }` -- Returns: `200 T52` +- Returns: `200 T54` diff --git a/docs/api/routes.md b/docs/api/routes.md index 756765e..e9c6629 100644 --- a/docs/api/routes.md +++ b/docs/api/routes.md @@ -1,6 +1,6 @@ # Dash API Routes Overview -Overview of all 175 API endpoints across all modules. +Overview of all 180 API endpoints across all modules. ### Notation @@ -10,50 +10,52 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). ### Reusable types - `T1` = `{ order: T2 }` -- `T2` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T23[], externalNumber?: str|null, createdAt?: str, shipping?: T30|null, shippings?: T30[], payment?: T36|null, payments?: T36[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T6[], files?: T14[] }` +- `T2` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T25[], externalNumber?: str|null, createdAt?: str, shipping?: T32|null, shippings?: T32[], payment?: T38|null, payments?: T38[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T6[], files?: T14[] }` - `T3` = `{ article: T4 }` -- `T4` = `{ id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T33, brand: T31|null, categoryIds: int[], photos: T28[], eans: str[], prices: T38[], suppliers: T15[] }` +- `T4` = `{ id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T35, brand: T33|null, categoryIds: int[], photos: T30[], eans: str[], prices: T40[], suppliers: T15[] }` - `T5` = `{ shipment: T6 }` -- `T6` = `{ id: int, number: str, type: str, date: str, lines: T23[], shippings: T30[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T14[], state?: str }` +- `T6` = `{ id: int, number: str, type: str, date: str, lines: T25[], shippings: T32[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T14[], state?: str }` - `T7` = `{ quote: T8 }` -- `T8` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T23[], externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T14[] }` +- `T8` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T25[], externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T14[] }` - `T9` = `{ delivery: T10 }` -- `T10` = `{ id: int, number: str, type: str, supplierId: int|null, date: str, lines: T23[], files: T14[], externalNumber?: str|null, createdAt?: str, ledger?: T42 }` +- `T10` = `{ id: int, number: str, type: str, supplierId: int|null, date: str, lines: T25[], files: T14[], externalNumber?: str|null, createdAt?: str, ledger?: T44 }` - `T11` = `{ labeltemplate: T13 }` - `T12` = `{ attachment: T14, fileUrl: str }` -- `T13` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: T20, thumb?: str|null }` +- `T13` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: T22, thumb?: str|null }` - `T14` = `{ 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 }` -- `T15` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T44|null }` -- `T16` = `{ 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 }` -- `T17` = `{ ledger: T18[] }` -- `T18` = `{ 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 }` -- `T19` = `{ id: int, name: str, sort: int, exclusive: bool, values: T34[], articleCount?: int }` -- `T20` = `{ objects: T24[] }` -- `T21` = `{ printer: T26 }` -- `T22` = `{ entity: T29 }` -- `T23` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }` -- `T24` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` -- `T25` = `{ shipping: T30 }` -- `T26` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }` -- `T27` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }` -- `T28` = `{ sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }` -- `T29` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` -- `T30` = `{ id: int, manifestId: int, number: str, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` -- `T31` = `{ name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }` -- `T32` = `{ article: T37 }` -- `T33` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` -- `T34` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` -- `T35` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` -- `T36` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` -- `T37` = `{ id: int, categoryId: int, name: str, sku: str, track_stock: bool }` -- `T38` = `{ minmultiplier: num, net: num, taxRate: num, customergroupId: int }` -- `T39` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` -- `T40` = `{ id: int, entityId: int, contactType: str, contact: str }` -- `T41` = `{ id: int, name: str, createdAt: str, updatedAt: str }` -- `T42` = `{ totalPositions: int, completelyOnLedgerPositions: int }` -- `T43` = `{ warehouse: T45 }` -- `T44` = `{ net: num, taxId: int, taxRate?: num|null }` -- `T45` = `{ id: int, name: str, sort: int }` +- `T15` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T46|null }` +- `T16` = `{ schedule: T19 }` +- `T17` = `{ 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 }` +- `T18` = `{ ledger: T20[] }` +- `T19` = `{ 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 }` +- `T20` = `{ 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 }` +- `T21` = `{ id: int, name: str, sort: int, exclusive: bool, values: T36[], articleCount?: int }` +- `T22` = `{ objects: T26[] }` +- `T23` = `{ printer: T28 }` +- `T24` = `{ entity: T31 }` +- `T25` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }` +- `T26` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` +- `T27` = `{ shipping: T32 }` +- `T28` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }` +- `T29` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }` +- `T30` = `{ sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }` +- `T31` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` +- `T32` = `{ id: int, manifestId: int, number: str, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` +- `T33` = `{ name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }` +- `T34` = `{ article: T39 }` +- `T35` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` +- `T36` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` +- `T37` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` +- `T38` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` +- `T39` = `{ id: int, categoryId: int, name: str, sku: str, track_stock: bool }` +- `T40` = `{ minmultiplier: num, net: num, taxRate: num, customergroupId: int }` +- `T41` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` +- `T42` = `{ id: int, entityId: int, contactType: str, contact: str }` +- `T43` = `{ id: int, name: str, createdAt: str, updatedAt: str }` +- `T44` = `{ totalPositions: int, completelyOnLedgerPositions: int }` +- `T45` = `{ warehouse: T47 }` +- `T46` = `{ net: num, taxId: int, taxRate?: num|null }` +- `T47` = `{ id: int, name: str, sort: int }` ### Routes @@ -62,7 +64,7 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). #### Create article in category — `POST /article` - Params: `body: { categoryId: int, name: str, desc?: str, seo?: str, track_stock?: bool }` -- Returns: `201 T32` +- Returns: `201 T34` #### Delete article by SKU — `DELETE /article/{sku}` - Params: `sku: str, query: cascade?: bool` - Returns: `204 void` @@ -95,10 +97,10 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). - Returns: `200 { children: { id: int, sku: str, name: str, parentsort: int, attributeValueId: int, attributeValue: str }[] }` #### Create and attach a new child article to a parent article — `POST /article/{sku}/children` - Params: `sku: str, body: { attributeValueId?: int, value?: str, name?: str }` -- Returns: `201 T32` +- Returns: `201 T34` #### Attach an existing article as a child to a parent article — `PUT /article/{sku}/children` - Params: `sku: str, body: { sku: str, attributeValueId?: int, value?: str, reparent?: bool }` -- Returns: `200 { article: T37, children: { id: int, sku: str, name: str, parentsort: int, attributeValueId: int, attributeValue: str }[] }` +- Returns: `200 { article: T39, children: { id: int, sku: str, name: str, parentsort: int, attributeValueId: int, attributeValue: str }[] }` #### Remove a child article from a parent article — `DELETE /article/{sku}/children/{childSku}` - Params: `sku: str, childSku: str, query: deleteArticle?: bool` - Returns: `200 { success: bool, deleted: bool }` @@ -122,7 +124,7 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). - Returns: `200 { options: { id: int, articleId: int, sku: str, name: str, count: int, sort: int, mandated: bool }[] }` #### Toggle parent mode for an article — `POST /article/{sku}/parent` - Params: `sku: str, body: { isParent: bool, attributeNameId?: int }` -- Returns: `200 T32` +- Returns: `200 T34` #### Replace POS prices by SKU (net > gross; price=net, tax=taxRate %) — `PUT /article/{sku}/prices` - Params: `sku: str, body: { prices: { net?: num, gross?: num, price?: num, taxRate?: num, tax?: num, minmultiplier?: num }[] }` - Returns: `200 T3` @@ -164,19 +166,19 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). #### List attribute names — `GET /attributename` _none_ -- Returns: `200 { attributenames: T19[] }` +- Returns: `200 { attributenames: T21[] }` #### Create attribute name — `POST /attributename` - Params: `body: { name: str, sort?: int, exclusive?: bool }` -- Returns: `201 { attributename: T19 }` +- Returns: `201 { attributename: T21 }` #### 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: T34[] }` +- Returns: `200 { values: T36[] }` #### Create value for an attribute — `POST /attributename/{attributeId}/value` - Params: `attributeId: int, body: { value: str, sort?: int }` -- Returns: `201 { attributevalue: T34 }` +- Returns: `201 { attributevalue: T36 }` #### Reorder values of an attribute — `PUT /attributename/{attributeId}/value/order` - Params: `attributeId: int, body: { attributevalueIds: int[] }` - Returns: `200 { ok: bool }` @@ -185,7 +187,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: T19 }` +- Returns: `200 { attributename: T21 }` ### Section: /attributevalue @@ -194,13 +196,13 @@ _none_ - Returns: `200 { ok: bool }` #### Update attribute value — `PATCH /attributevalue/{id}` - Params: `id: int, body: { value?: str, sort?: int }` -- Returns: `200 { attributevalue: T34 }` +- Returns: `200 { attributevalue: T36 }` #### 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: T39[] } }` +- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T41[] } }` #### 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: T39[] } }` +- Returns: `201 { attributevalue: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T41[] } }` ### Section: /brand @@ -209,7 +211,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: T39[], gsprpinfo?: str|null } }` +- Returns: `201 { brand: { id: int, name: str, pics: T41[], gsprpinfo?: str|null } }` #### Delete brand — `DELETE /brand/{id}` - Params: `id: int` - Returns: `204 void` @@ -218,10 +220,10 @@ _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: T39[] } }` +- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T41[] } }` #### 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: T39[] } }` +- Returns: `201 { brand: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T41[] } }` ### Section: /category @@ -242,7 +244,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` -- 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, brand?: T31|null }[] }` +- 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, brand?: T33|null }[] }` #### 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 }[] }` @@ -296,7 +298,7 @@ _none_ - Returns: `200 { customergroups: { id: int, name: str, sort: int, editable: bool }[] }` #### Create customer group — `POST /customergroup` - Params: `body: { name: str }` -- Returns: `201 { customergroup: T45 }` +- Returns: `201 { customergroup: T47 }` #### Reorder customer groups — `PUT /customergroup/order` - Params: `body: { customergroupIds: int[] }` - Returns: `200 { customergroupIds: int[] }` @@ -305,15 +307,15 @@ _none_ - Returns: `204 void` #### Update customer group — `PATCH /customergroup/{id}` - Params: `id: int, body: { name: str }` -- Returns: `200 { customergroup: T45 }` +- Returns: `200 { customergroup: T47 }` ### Section: /delivery #### 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|null, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T42 }[], total: int, unfilteredTotal: int, offset: int, limit: int }` +- Returns: `200 { deliveries: { id: int, number: str, type: str, supplierId: int|null, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T44 }[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create delivery — `POST /delivery` -- Params: `body: { externalNumber: str, date: str, lines: T27[], supplierId?: int|null, files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` +- Params: `body: { externalNumber: str, date: str, lines: T29[], supplierId?: int|null, files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` - Returns: `201 T9` #### Delete delivery — `DELETE /delivery/{id}` - Params: `id: int` @@ -322,7 +324,7 @@ _none_ - Params: `id: int` - Returns: `200 T9` #### Update delivery — `PATCH /delivery/{id}` -- Params: `id: int, body: { externalNumber?: str|null, date?: str, supplierId?: int|null, lines?: T27[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` +- Params: `id: int, body: { externalNumber?: str|null, date?: str, supplierId?: int|null, lines?: T29[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` - Returns: `200 T9` #### Delete delivery file attachment — `DELETE /delivery/{id}/file/{fileId}` - Params: `id: int, fileId: int` @@ -335,46 +337,46 @@ _none_ #### List entities — `GET /entity` - Params: `query: customergroupId?: int, role?: str` -- Returns: `200 { entities: T29[] }` +- Returns: `200 { entities: T31[] }` #### Create entity — `POST /entity` - Params: `body: { customergroupId: int, name: str, firstName?: str|null, number?: str }` -- Returns: `201 T22` +- Returns: `201 T24` #### 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: T16[] }` +- Returns: `200 { addresses: T17[] }` #### 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: T16 }` +- Returns: `201 { address: T17 }` #### 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: T16 }` +- Returns: `200 { address: T17 }` #### List entity contacts — `GET /entity/{entityId}/contact` - Params: `entityId: int` -- Returns: `200 { contacts: T40[] }` +- Returns: `200 { contacts: T42[] }` #### Create entity contact — `POST /entity/{entityId}/contact` - Params: `entityId: int, body: { contactType: str, contact: str }` -- Returns: `201 { contact: T40 }` +- Returns: `201 { contact: T42 }` #### 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: T40 }` +- Returns: `200 { contact: T42 }` #### Delete entity — `DELETE /entity/{id}` - Params: `id: int` - Returns: `204 void` #### Get entity — `GET /entity/{id}` - Params: `id: int` -- Returns: `200 T22` +- Returns: `200 T24` #### Update entity — `PATCH /entity/{id}` - Params: `id: int, body: { name?: str, firstName?: str|null, number?: str|null }` -- Returns: `200 T22` +- Returns: `200 T24` ### Section: /labeltemplate @@ -382,7 +384,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: T20 }` +- Params: `body: { name: str, width: num, height: num, dpi: int, type: str, content: T22 }` - Returns: `201 T11` #### Delete label template — `DELETE /labeltemplate/{id}` - Params: `id: int` @@ -391,23 +393,23 @@ _none_ - Params: `id: int` - Returns: `200 T11` #### Update label template (partial) — `PATCH /labeltemplate/{id}` -- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: T20 }` +- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: T22 }` - Returns: `200 T11` #### Update label template — `PUT /labeltemplate/{id}` -- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: T20 }` +- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: T22 }` - Returns: `200 T11` ### Section: /ledger #### Query ledger by manifest article ID or SKU — `GET /ledger` - Params: `query: manifestarticle_id?: int, sku?: str, transaction_type?: str` -- Returns: `200 T17` +- Returns: `200 T18` #### Query ledger by manifest article ID — `GET /ledger/manifestarticle/{manifestarticleId}` - Params: `manifestarticleId: int, query: transaction_type?: str` -- Returns: `200 T17` +- Returns: `200 T18` #### Query ledger by article SKU — `GET /ledger/sku/{sku}` - Params: `sku: str, query: transaction_type?: str` -- Returns: `200 T17` +- Returns: `200 T18` ### Section: /number @@ -424,7 +426,7 @@ _none_ - Params: `query: offset?: int, limit?: int, search?: str, onlyUnpaid?: bool, onlyUndelivered?: bool, seekMonths?: int` - Returns: `200 { orders: T2[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create order — `POST /order` -- Params: `body: { number: str, date: str, lines: T27[], entityId?: int|null, externalNumber?: str|null }` +- Params: `body: { number: str, date: str, lines: T29[], entityId?: int|null, externalNumber?: str|null }` - Returns: `201 T1` #### Delete order — `DELETE /order/{id}` - Params: `id: int` @@ -433,17 +435,17 @@ _none_ - Params: `id: int` - Returns: `200 T1` #### Update order — `PATCH /order/{id}` -- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T27[] }` +- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T29[] }` - Returns: `200 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: T36[] }` +- Returns: `200 { payments: T38[] }` #### Add payment to an order — `POST /order/{id}/payment` - Params: `id: int, body: { accountId: int, type: str, amount: num }` -- Returns: `201 { payment: T36 }` +- Returns: `201 { payment: T38 }` #### Generate and attach order PDF — `POST /order/{id}/pdf` - Params: `id: int` - Returns: `201 T12` @@ -455,10 +457,10 @@ _none_ - Returns: `201 T5` #### List shippings of an order — `GET /order/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T30[] }` +- Returns: `200 { shippings: T32[] }` #### Create shipping for an order — `POST /order/{id}/shipping` - Params: `id: int, body: { type: str, state: str, warehouseId?: int }` -- Returns: `201 T25` +- Returns: `201 T27` ### Section: /package @@ -476,10 +478,10 @@ _none_ #### List printers — `GET /printer` _none_ -- Returns: `200 { printers: T26[] }` +- Returns: `200 { printers: T28[] }` #### Create printer — `POST /printer` - Params: `body: { address: str, type: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }` -- Returns: `201 T21` +- Returns: `201 T23` #### Reorder printers — `PUT /printer/order` - Params: `body: { printerIds: int[] }` - Returns: `200 { printerIds: int[] }` @@ -488,22 +490,22 @@ _none_ - Returns: `204 void` #### Get printer by ID — `GET /printer/{id}` - Params: `id: int` -- Returns: `200 T21` +- Returns: `200 T23` #### 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 T21` +- Returns: `200 T23` #### 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 T21` +- Returns: `200 T23` ### Section: /propertyname #### List property names — `GET /propertyname` _none_ -- Returns: `200 { propertynames: T35[] }` +- Returns: `200 { propertynames: T37[] }` #### Create property name — `POST /propertyname` - Params: `body: { name: str, sort?: int, exclusive?: bool }` -- Returns: `201 { propertyname: T35 }` +- Returns: `201 { propertyname: T37 }` #### Reorder property names — `PUT /propertyname/order` - Params: `body: { propertynameIds: int[] }` - Returns: `200 { ok: bool }` @@ -512,7 +514,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: T35 }` +- Returns: `200 { propertyname: T37 }` ### Section: /quote @@ -520,7 +522,7 @@ _none_ - Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int` - Returns: `200 { quotes: T8[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create quote — `POST /quote` -- Params: `body: { number: str, date: str, lines: T27[], entityId?: int|null, externalNumber?: str|null }` +- Params: `body: { number: str, date: str, lines: T29[], entityId?: int|null, externalNumber?: str|null }` - Returns: `201 T7` #### Delete quote — `DELETE /quote/{id}` - Params: `id: int` @@ -529,13 +531,13 @@ _none_ - Params: `id: int` - Returns: `200 T7` #### Update quote — `PATCH /quote/{id}` -- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T27[] }` +- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T29[] }` - Returns: `200 T7` #### 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?: T27[] }` +- Params: `id: int, body?: { number?: str, date?: str, createdAt?: str, entityId?: int|null, externalNumber?: str|null, lines?: T29[] }` - Returns: `201 T1` #### Generate and attach quote PDF — `POST /quote/{id}/pdf` - Params: `id: int` @@ -563,10 +565,10 @@ _none_ - Returns: `201 T12` #### List packages of a shipment — `GET /shipment/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T30[] }` +- Returns: `200 { shippings: T32[] }` #### Create package for a shipment — `POST /shipment/{id}/shipping` - Params: `id: int, body: { type: str, state: str, trackingCode?: str, carrier?: str, warehouseId?: int }` -- Returns: `201 T25` +- Returns: `201 T27` ### Section: /shipping @@ -575,7 +577,7 @@ _none_ - Returns: `204 void` #### Update shipping — `PATCH /shipping/{id}` - Params: `id: int, body: { type?: str, state?: str, trackingCode?: str, carrier?: str, warehouseId?: int }` -- Returns: `200 T25` +- Returns: `200 T27` #### 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 }[] }` @@ -596,31 +598,49 @@ _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: T18[] }` +- 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: T20[] }` #### Ship shipment manifest item(s) — `POST /stock/ship` - Params: `body: { manifestarticleId?: int, warehouseId?: int, items?: { manifestarticleId: int, warehouseId?: int }[] }` - Returns: `200` +### Section: /subagentschedule + +#### List subagent schedules — `GET /subagentschedule` +_none_ +- Returns: `200 { schedules: T19[] }` +#### 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 T16` +#### 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 T16` +#### 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 T16` + ### Section: /supplier #### List suppliers — `GET /supplier` _none_ -- Returns: `200 { suppliers: T41[] }` +- Returns: `200 { suppliers: T43[] }` #### Create supplier — `POST /supplier` - Params: `body: { name: str }` -- Returns: `201 { supplier: T41 }` +- Returns: `201 { supplier: T43 }` #### 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: T41 }` +- Returns: `200 { supplier: T43 }` #### 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?: T44|null }[] }` +- 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?: T46|null }[] }` #### 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?: T44|null }[] }` +- 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?: T46|null }[] }` ### Section: /unit @@ -629,19 +649,19 @@ _none_ - Returns: `204 void` #### List units — `GET /unit` _none_ -- Returns: `200 { units: T33[] }` +- Returns: `200 { units: T35[] }` #### Upsert unit — `PUT /unit` - Params: `body: { si: str, basesi: str, basesifactor: num, symbol: str, name: str }` -- Returns: `200 { unit: T33 }` +- Returns: `200 { unit: T35 }` ### Section: /warehouse #### List warehouses — `GET /warehouse` _none_ -- Returns: `200 { warehouses: T45[] }` +- Returns: `200 { warehouses: T47[] }` #### Create warehouse — `POST /warehouse` - Params: `body: { name: str, sort?: int }` -- Returns: `201 T43` +- Returns: `201 T45` #### Reorder warehouses — `PUT /warehouse/order` - Params: `body: { warehouseIds: int[] }` - Returns: `200 { warehouseIds: int[] }` @@ -650,13 +670,13 @@ _none_ - Returns: `204 void` #### Get warehouse by ID — `GET /warehouse/{id}` - Params: `id: int` -- Returns: `200 T43` +- Returns: `200 T45` #### Update warehouse (partial) — `PATCH /warehouse/{id}` - Params: `id: int, body: { name?: str, sort?: int }` -- Returns: `200 T43` +- Returns: `200 T45` #### Update warehouse — `PUT /warehouse/{id}` - Params: `id: int, body: { name?: str, sort?: int }` -- Returns: `200 T43` +- Returns: `200 T45` ### Binary & streaming routes (reachable only via `fetch()` in javascript_execute) These routes are NOT in the table above because their responses are binary or long-lived streams, which the `dashback_request` tool cannot return usefully. They ARE reachable from inside `javascript_execute` with `fetch("/route")`, where you can decode the bytes, write them to the VFS and embed them in your reply: diff --git a/docs/api/routes/subagentschedule.get.md b/docs/api/routes/subagentschedule.get.md new file mode 100644 index 0000000..f2f9b13 --- /dev/null +++ b/docs/api/routes/subagentschedule.get.md @@ -0,0 +1,42 @@ +# `GET /subagentschedule` + +Protected. Requires a valid session cookie (`credentials: 'include'`). + +List subagent schedules + +Lists all subagent schedules for the selected company. + +## Response `200` + +List of subagent schedules + +```json +{ + "schedules": [ + { + "id": 1, + "company_id": 1, + "desc": "…", + "prompt": "…", + "skills": "…", + "lastagentnote": "…", + "max_itr": 1, + "cron": "…", + "created_at": "…", + "lastrun_at": "…" + } + ] +} +``` + +## Errors + +| Status | Description | +|--------|-------------| +| 400 | No company selected — `{"error":"…"}` | +| 401 | Unauthorized — `{"error":"…"}` | +| 403 | Not authorized — `{"error":"…"}` | + +--- + +_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._ diff --git a/docs/api/routes/subagentschedule.post.md b/docs/api/routes/subagentschedule.post.md new file mode 100644 index 0000000..29d7ed6 --- /dev/null +++ b/docs/api/routes/subagentschedule.post.md @@ -0,0 +1,68 @@ +# `POST /subagentschedule` + +Protected. Requires a valid session cookie (`credentials: 'include'`). + +Create subagent schedule + +Creates a new scheduled subagent execution for the selected company. +`cron` must be a valid 5-part cron timetable expression (e.g. "0 9 * * 1-5"). + + +## Body (JSON) + +| Field | Required | Type | Description | +|-------|----------|------|-------------| +| `prompt` | yes | string | | +| `cron` | yes | string | | +| `desc` | no | string | | +| `skills` | no | string | | +| `lastagentnote` | no | string | | +| `max_itr` | no | integer | | + +```json +{ + "prompt": "…", + "cron": "…", + "desc": "…", + "skills": "…", + "lastagentnote": "…", + "max_itr": 1 +} +``` + +## Signals + +On success, emits SSE signal: `subagentschedule` (see [`GET /events`](../events.md)). + +## Response `201` + +Created subagent schedule + +```json +{ + "schedule": { + "id": 1, + "company_id": 1, + "desc": "…", + "prompt": "…", + "skills": "…", + "lastagentnote": "…", + "max_itr": 1, + "cron": "…", + "created_at": "…", + "lastrun_at": "…" + } +} +``` + +## Errors + +| Status | Description | +|--------|-------------| +| 400 | Invalid input, missing prompt, or invalid cron expression — `{"error":"…"}` | +| 401 | Unauthorized — `{"error":"…"}` | +| 403 | Not authorized — `{"error":"…"}` | + +--- + +_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._ diff --git a/docs/api/routes/subagentschedule/_id.delete.md b/docs/api/routes/subagentschedule/_id.delete.md new file mode 100644 index 0000000..1a81810 --- /dev/null +++ b/docs/api/routes/subagentschedule/_id.delete.md @@ -0,0 +1,36 @@ +# `DELETE /subagentschedule/{id}` + +Protected. Requires a valid session cookie (`credentials: 'include'`). + +Delete subagent schedule + +Deletes a subagent schedule for the selected company. + +## Path parameters + +| Param | Required | Type | Description | +|-------|----------|------|-------------| +| `id` | yes | integer | Schedule ID | + +## Signals + +On success, emits SSE signal: `subagentschedule` (see [`GET /events`](../events.md)). + +## Response `204` + +Schedule deleted successfully + +_No content_ + +## Errors + +| Status | Description | +|--------|-------------| +| 400 | Invalid ID or no company selected — `{"error":"…"}` | +| 401 | Unauthorized — `{"error":"…"}` | +| 403 | Not authorized — `{"error":"…"}` | +| 404 | Subagent schedule not found — `{"error":"…"}` | + +--- + +_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._ diff --git a/docs/api/routes/subagentschedule/_id.get.md b/docs/api/routes/subagentschedule/_id.get.md new file mode 100644 index 0000000..07a29c1 --- /dev/null +++ b/docs/api/routes/subagentschedule/_id.get.md @@ -0,0 +1,47 @@ +# `GET /subagentschedule/{id}` + +Protected. Requires a valid session cookie (`credentials: 'include'`). + +Get subagent schedule by ID + +Retrieves a single subagent schedule for the selected company. + +## Path parameters + +| Param | Required | Type | Description | +|-------|----------|------|-------------| +| `id` | yes | integer | Schedule ID | + +## Response `200` + +Subagent schedule details + +```json +{ + "schedule": { + "id": 1, + "company_id": 1, + "desc": "…", + "prompt": "…", + "skills": "…", + "lastagentnote": "…", + "max_itr": 1, + "cron": "…", + "created_at": "…", + "lastrun_at": "…" + } +} +``` + +## Errors + +| Status | Description | +|--------|-------------| +| 400 | Invalid ID or no company selected — `{"error":"…"}` | +| 401 | Unauthorized — `{"error":"…"}` | +| 403 | Not authorized — `{"error":"…"}` | +| 404 | Subagent schedule not found — `{"error":"…"}` | + +--- + +_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._ diff --git a/docs/api/routes/subagentschedule/_id.put.md b/docs/api/routes/subagentschedule/_id.put.md new file mode 100644 index 0000000..56d5693 --- /dev/null +++ b/docs/api/routes/subagentschedule/_id.put.md @@ -0,0 +1,75 @@ +# `PUT /subagentschedule/{id}` + +Protected. Requires a valid session cookie (`credentials: 'include'`). + +Update subagent schedule + +Updates an existing subagent schedule for the selected company. + +## Path parameters + +| Param | Required | Type | Description | +|-------|----------|------|-------------| +| `id` | yes | integer | Schedule ID | + +## Body (JSON) + +| Field | Required | Type | Description | +|-------|----------|------|-------------| +| `prompt` | no | string | | +| `cron` | no | string | | +| `desc` | no | string | | +| `skills` | no | string | | +| `lastagentnote` | no | string | | +| `max_itr` | no | integer | | +| `lastrun_at` | no | string | | + +```json +{ + "prompt": "…", + "cron": "…", + "desc": "…", + "skills": "…", + "lastagentnote": "…", + "max_itr": 1, + "lastrun_at": "…" +} +``` + +## Signals + +On success, emits SSE signal: `subagentschedule` (see [`GET /events`](../events.md)). + +## Response `200` + +Updated subagent schedule + +```json +{ + "schedule": { + "id": 1, + "company_id": 1, + "desc": "…", + "prompt": "…", + "skills": "…", + "lastagentnote": "…", + "max_itr": 1, + "cron": "…", + "created_at": "…", + "lastrun_at": "…" + } +} +``` + +## Errors + +| Status | Description | +|--------|-------------| +| 400 | Invalid input or invalid cron expression — `{"error":"…"}` | +| 401 | Unauthorized — `{"error":"…"}` | +| 403 | Not authorized — `{"error":"…"}` | +| 404 | Subagent schedule not found — `{"error":"…"}` | + +--- + +_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._ diff --git a/src/api/openapi.js b/src/api/openapi.js index 36cb2ac..ea57860 100644 --- a/src/api/openapi.js +++ b/src/api/openapi.js @@ -1453,6 +1453,74 @@ * desc: * type: string * nullable: true + * SubagentSchedule: + * type: object + * required: [id, company_id, prompt, cron, max_itr, created_at] + * properties: + * id: + * type: integer + * company_id: + * type: integer + * desc: + * type: string + * nullable: true + * prompt: + * type: string + * skills: + * type: string + * nullable: true + * lastagentnote: + * type: string + * nullable: true + * max_itr: + * type: integer + * cron: + * type: string + * created_at: + * type: string + * lastrun_at: + * type: string + * nullable: true + * SubagentScheduleCreateInput: + * type: object + * required: [prompt, cron] + * properties: + * prompt: + * type: string + * cron: + * type: string + * desc: + * type: string + * nullable: true + * skills: + * type: string + * nullable: true + * lastagentnote: + * type: string + * nullable: true + * max_itr: + * type: integer + * SubagentScheduleUpdateInput: + * type: object + * properties: + * prompt: + * type: string + * cron: + * type: string + * desc: + * type: string + * nullable: true + * skills: + * type: string + * nullable: true + * lastagentnote: + * type: string + * nullable: true + * max_itr: + * type: integer + * lastrun_at: + * type: string + * nullable: true * Posterminal: * type: object * required: [id, name] diff --git a/src/api/routes/subagentschedule.js b/src/api/routes/subagentschedule.js new file mode 100644 index 0000000..2aa410c --- /dev/null +++ b/src/api/routes/subagentschedule.js @@ -0,0 +1,528 @@ +import * as db from '../../db/subagentschedule.js'; +import { emit } from '../sse.js'; + +// #region Cron Validation + +const CRON_NICKNAMES = new Set([ + '@yearly', + '@annually', + '@monthly', + '@weekly', + '@daily', + '@midnight', + '@hourly', +]); + +const MONTH_NAMES = { + jan: 1, feb: 2, mar: 3, apr: 4, may: 5, jun: 6, + jul: 7, aug: 8, sep: 9, oct: 10, nov: 11, dec: 12, +}; + +const DAY_NAMES = { + sun: 0, mon: 1, tue: 2, wed: 3, thu: 4, fri: 5, sat: 6, +}; + +const FIELD_RANGES = [ + { name: 'minute', min: 0, max: 59 }, + { name: 'hour', min: 0, max: 23 }, + { name: 'day of month', min: 1, max: 31 }, + { name: 'month', min: 1, max: 12, names: MONTH_NAMES }, + { name: 'day of week', min: 0, max: 7, names: DAY_NAMES }, +]; + +function parseCronValue(val, min, max, names) { + if (names && typeof val === 'string') { + const lower = val.toLowerCase(); + if (lower in names) return names[lower]; + } + if (!/^\d+$/.test(val)) return null; + const num = parseInt(val, 10); + if (num < min || num > max) return null; + return num; +} + +function validateField(part, min, max, names) { + if (!part) return false; + const items = part.split(','); + if (items.length === 0) return false; + + for (const item of items) { + if (!item) return false; + const slashParts = item.split('/'); + if (slashParts.length > 2) return false; + if (slashParts.length === 2) { + const step = slashParts[1]; + if (!/^\d+$/.test(step)) return false; + const stepNum = parseInt(step, 10); + if (stepNum <= 0 || stepNum > max) return false; + } + + const base = slashParts[0]; + if (base === '*' || base === '?') { + continue; + } + + const dashParts = base.split('-'); + if (dashParts.length > 2) return false; + if (dashParts.length === 2) { + const start = parseCronValue(dashParts[0], min, max, names); + const end = parseCronValue(dashParts[1], min, max, names); + if (start === null || end === null || start > end) return false; + continue; + } + + const val = parseCronValue(base, min, max, names); + if (val === null) return false; + } + + return true; +} + +function isValidCron(cron) { + if (typeof cron !== 'string') return false; + const trimmed = cron.trim(); + if (!trimmed) return false; + if (CRON_NICKNAMES.has(trimmed.toLowerCase())) return true; + + const parts = trimmed.split(/\s+/); + if (parts.length !== 5) return false; + + for (let i = 0; i < 5; i++) { + const part = parts[i]; + const { min, max, names } = FIELD_RANGES[i]; + if (!validateField(part, min, max, names)) { + return false; + } + } + return true; +} + +// #endregion + +// #region Helpers + +function requireSelectedCompany(req) { + const companyId = req.user?.selectedCompanyId; + if (companyId == null) { + return { error: 'No company selected' }; + } + return { companyId }; +} + +function parsePositiveInt(value, field) { + const id = Number(value); + if (!Number.isInteger(id) || id <= 0) { + return { error: `${field} is required` }; + } + return { id }; +} + +function subagentscheduleErrorStatus(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 === 'Subagent schedule not found') return 404; + if (error.message === 'Prompt required') return 400; + if (error.message === 'Cron expression required') return 400; + if (error.message === 'Invalid cron expression') return 400; + if (error.message?.startsWith('Invalid max iterations')) return 400; + return 500; +} + +// #endregion + +/** + * Registers subagent schedule CRUD routes for the authenticated user's selected company. + * @param {import('express').Application} app + * @param {string} [basePath=''] + */ +export function register(app, basePath = '') { + /** + * @openapi + * /subagentschedule: + * get: + * tags: [SubagentSchedule] + * summary: List subagent schedules + * description: Lists all subagent schedules for the selected company. + * security: + * - cookieAuth: [] + * responses: + * 200: + * description: List of subagent schedules + * content: + * application/json: + * schema: + * type: object + * properties: + * schedules: + * type: array + * items: + * $ref: '#/components/schemas/SubagentSchedule' + * 400: + * description: No company selected + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 401: + * description: Unauthorized + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 403: + * description: Not authorized + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + */ + // #region GET /subagentschedule + + app.get(`${basePath}/subagentschedule`, async (req, res) => { + const selected = requireSelectedCompany(req); + if (selected.error) { + return res.status(400).json({ error: selected.error }); + } + + try { + const schedules = await db.list(req.user.id); + res.status(200).json({ schedules }); + } catch (error) { + const status = subagentscheduleErrorStatus(error); + if (status === 500) console.error('List subagent schedules failed:', error); + res.status(status).json({ error: error.message }); + } + }); + + // #endregion + + /** + * @openapi + * /subagentschedule/{id}: + * get: + * tags: [SubagentSchedule] + * summary: Get subagent schedule by ID + * description: Retrieves a single subagent schedule for the selected company. + * security: + * - cookieAuth: [] + * parameters: + * - in: path + * name: id + * required: true + * schema: + * type: integer + * description: Schedule ID + * responses: + * 200: + * description: Subagent schedule details + * content: + * application/json: + * schema: + * type: object + * properties: + * schedule: + * $ref: '#/components/schemas/SubagentSchedule' + * 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' + * 403: + * description: Not authorized + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 404: + * description: Subagent schedule not found + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + */ + // #region GET /subagentschedule/:id + + app.get(`${basePath}/subagentschedule/:id`, async (req, res) => { + const selected = requireSelectedCompany(req); + if (selected.error) { + return res.status(400).json({ error: selected.error }); + } + + const parsedId = parsePositiveInt(req.params.id, 'id'); + if (parsedId.error) { + return res.status(400).json({ error: parsedId.error }); + } + + try { + const schedule = await db.getById(req.user.id, parsedId.id); + if (!schedule) { + return res.status(404).json({ error: 'Subagent schedule not found' }); + } + res.status(200).json({ schedule }); + } catch (error) { + const status = subagentscheduleErrorStatus(error); + if (status === 500) console.error('Get subagent schedule failed:', error); + res.status(status).json({ error: error.message }); + } + }); + + // #endregion + + /** + * @openapi + * /subagentschedule: + * post: + * tags: [SubagentSchedule] + * summary: Create subagent schedule + * description: | + * Creates a new scheduled subagent execution for the selected company. + * `cron` must be a valid 5-part cron timetable expression (e.g. "0 9 * * 1-5"). + * security: + * - cookieAuth: [] + * x-signals: [subagentschedule] + * requestBody: + * required: true + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/SubagentScheduleCreateInput' + * responses: + * 201: + * description: Created subagent schedule + * content: + * application/json: + * schema: + * type: object + * properties: + * schedule: + * $ref: '#/components/schemas/SubagentSchedule' + * 400: + * description: Invalid input, missing prompt, or invalid cron expression + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 401: + * description: Unauthorized + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 403: + * description: Not authorized + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + */ + // #region POST /subagentschedule + + app.post(`${basePath}/subagentschedule`, async (req, res) => { + const selected = requireSelectedCompany(req); + if (selected.error) { + return res.status(400).json({ error: selected.error }); + } + + const { desc, prompt, skills, lastagentnote, max_itr, cron } = req.body ?? {}; + + if (cron !== undefined && !isValidCron(cron)) { + return res.status(400).json({ error: 'Invalid cron expression' }); + } + + try { + const schedule = await db.create(req.user.id, { + desc, + prompt, + skills, + lastagentnote, + max_itr, + cron, + }); + emit('subagentschedule', { companyId: selected.companyId, action: 'create', scheduleId: schedule.id }); + res.status(201).json({ schedule }); + } catch (error) { + const status = subagentscheduleErrorStatus(error); + if (status === 500) console.error('Create subagent schedule failed:', error); + res.status(status).json({ error: error.message }); + } + }); + + // #endregion + + /** + * @openapi + * /subagentschedule/{id}: + * put: + * tags: [SubagentSchedule] + * summary: Update subagent schedule + * description: Updates an existing subagent schedule for the selected company. + * security: + * - cookieAuth: [] + * x-signals: [subagentschedule] + * parameters: + * - in: path + * name: id + * required: true + * schema: + * type: integer + * description: Schedule ID + * requestBody: + * required: true + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/SubagentScheduleUpdateInput' + * responses: + * 200: + * description: Updated subagent schedule + * content: + * application/json: + * schema: + * type: object + * properties: + * schedule: + * $ref: '#/components/schemas/SubagentSchedule' + * 400: + * description: Invalid input or invalid cron expression + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 401: + * description: Unauthorized + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 403: + * description: Not authorized + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 404: + * description: Subagent schedule not found + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + */ + // #region PUT /subagentschedule/:id + + app.put(`${basePath}/subagentschedule/:id`, async (req, res) => { + const selected = requireSelectedCompany(req); + if (selected.error) { + return res.status(400).json({ error: selected.error }); + } + + const parsedId = parsePositiveInt(req.params.id, 'id'); + if (parsedId.error) { + return res.status(400).json({ error: parsedId.error }); + } + + const { desc, prompt, skills, lastagentnote, max_itr, cron, lastrun_at } = req.body ?? {}; + + if (cron !== undefined && !isValidCron(cron)) { + return res.status(400).json({ error: 'Invalid cron expression' }); + } + + try { + const schedule = await db.update(req.user.id, parsedId.id, { + desc, + prompt, + skills, + lastagentnote, + max_itr, + cron, + lastrun_at, + }); + emit('subagentschedule', { companyId: selected.companyId, action: 'update', scheduleId: schedule.id }); + res.status(200).json({ schedule }); + } catch (error) { + const status = subagentscheduleErrorStatus(error); + if (status === 500) console.error('Update subagent schedule failed:', error); + res.status(status).json({ error: error.message }); + } + }); + + // #endregion + + /** + * @openapi + * /subagentschedule/{id}: + * delete: + * tags: [SubagentSchedule] + * summary: Delete subagent schedule + * description: Deletes a subagent schedule for the selected company. + * security: + * - cookieAuth: [] + * x-signals: [subagentschedule] + * parameters: + * - in: path + * name: id + * required: true + * schema: + * type: integer + * description: Schedule ID + * responses: + * 204: + * description: Schedule deleted successfully + * 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' + * 403: + * description: Not authorized + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 404: + * description: Subagent schedule not found + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + */ + // #region DELETE /subagentschedule/:id + + app.delete(`${basePath}/subagentschedule/:id`, async (req, res) => { + const selected = requireSelectedCompany(req); + if (selected.error) { + return res.status(400).json({ error: selected.error }); + } + + const parsedId = parsePositiveInt(req.params.id, 'id'); + if (parsedId.error) { + return res.status(400).json({ error: parsedId.error }); + } + + try { + await db.remove(req.user.id, parsedId.id); + emit('subagentschedule', { companyId: selected.companyId, action: 'delete', scheduleId: parsedId.id }); + res.status(204).end(); + } catch (error) { + const status = subagentscheduleErrorStatus(error); + if (status === 500) console.error('Delete subagent schedule failed:', error); + res.status(status).json({ error: error.message }); + } + }); + + // #endregion +} diff --git a/src/db/subagentschedule.js b/src/db/subagentschedule.js new file mode 100644 index 0000000..7f3bbda --- /dev/null +++ b/src/db/subagentschedule.js @@ -0,0 +1,26 @@ +import { getStore } from './store.js'; + +export async function list(googleAuthId) { + const store = await getStore(); + return store.subagentschedule.list(googleAuthId); +} + +export async function getById(googleAuthId, id) { + const store = await getStore(); + return store.subagentschedule.getById(googleAuthId, id); +} + +export async function create(googleAuthId, data) { + const store = await getStore(); + return store.subagentschedule.create(googleAuthId, data); +} + +export async function update(googleAuthId, id, data) { + const store = await getStore(); + return store.subagentschedule.update(googleAuthId, id, data); +} + +export async function remove(googleAuthId, id) { + const store = await getStore(); + return store.subagentschedule.delete(googleAuthId, id); +}