@purveyors/sdk 0.58.0 → 0.60.0

package/dist/index.js

@@ -405,6 +405,39 @@ function createParchmentClient(options) {
        */
       delete: (id) => client.DELETE("/v1/inventory/{id}", { params: { path: { id } } })
     },
+    /**
+     * Roast batches: roasting sessions with their own id. Batch names may
+     * repeat, so roasts, sales, and deletes refer to a batch by id.
+     */
+    roastBatches: {
+      /** List the caller's batches, newest batch date first. */
+      list: (query) => client.GET("/v1/roast-batches", { params: { query } }),
+      /** Fetch one of the caller's batches with the ids of its roasts. */
+      get: (batchId) => client.GET("/v1/roast-batches/{batchId}", {
+        params: { path: { batchId } }
+      }),
+      /**
+       * Create a batch and, when `items` are given, its roasts, atomically.
+       * Always creates a new batch. Omit `items` to open a batch for a
+       * session, then pass its id as `batchId` when creating each roast.
+       */
+      create: (body, idempotencyKey) => client.POST("/v1/roast-batches", {
+        body,
+        params: { header: { "idempotency-key": idempotencyKey } }
+      }),
+      /** Rename or re-date a batch. The name carries to its roasts and sales. */
+      update: (batchId, body) => client.PATCH("/v1/roast-batches/{batchId}", {
+        params: { path: { batchId } },
+        body
+      }),
+      /**
+       * Delete one batch and the roasts in it. No other batch is touched,
+       * whatever its name. Sales keep their record and lose the link.
+       */
+      delete: (batchId) => client.DELETE("/v1/roast-batches/{batchId}", {
+        params: { path: { batchId } }
+      })
+    },
     roasts: {
       /** Match Artisan roast metadata to one of the supplied inventory rows. */
       classify: (body) => client.POST("/v1/roasts/classify", { body }),
@@ -432,6 +465,10 @@ function createParchmentClient(options) {
       /**
        * Create every profile in one named batch atomically. The required
        * payload-bound idempotency key makes transport retries safe.
+       *
+       * @deprecated Use {@link ParchmentClient.roastBatches.create}, which
+       * returns a batch id. This places the roasts in the batch with the same
+       * name on the roast date, starting it when none exists.
        */
       createBatch: (body, idempotencyKey) => client.POST("/v1/roasts/batches", {
         body,
@@ -450,7 +487,13 @@ function createParchmentClient(options) {
       }),
       /** Delete one of the caller's own roast profiles. */
       delete: (id) => client.DELETE("/v1/roasts/{id}", { params: { path: { id } } }),
-      /** Delete every owner roast carrying one exact batch name. Session-only. */
+      /**
+       * Delete the one batch carrying an exact name. A name carried by several
+       * batches is refused with 409 `batch_name_ambiguous`, listing them.
+       * Session-only.
+       *
+       * @deprecated Use {@link ParchmentClient.roastBatches.delete}.
+       */
       deleteBatch: (batchName) => client.DELETE("/v1/roasts/batches/{batchName}", {
         params: { path: { batchName } }
       }),
@@ -931,6 +974,26 @@ var CHAT_AGENT_CAPABILITY_EXCLUSIONS = {
     reason: "write_not_agent_facing",
     note: "Destructive; no confirmed action."
   },
+  "roastBatches.list": {
+    reason: "read_not_wired",
+    note: "Roast tools return each roast's batch_id; a batch lookup tool follows with the sale-by-batch confirmed action."
+  },
+  "roastBatches.get": {
+    reason: "read_not_wired",
+    note: "Roast tools return each roast's batch_id; a batch lookup tool follows with the sale-by-batch confirmed action."
+  },
+  "roastBatches.create": {
+    reason: "write_not_agent_facing",
+    note: "Opens a batch for a roasting session; confirmed action create_roast_session creates single roasts."
+  },
+  "roastBatches.update": {
+    reason: "write_not_agent_facing",
+    note: "Renames a batch across its roasts and sales; no confirmed action."
+  },
+  "roastBatches.delete": {
+    reason: "write_not_agent_facing",
+    note: "Destructive; no confirmed action."
+  },
   "roasts.classify": {
     reason: "read_not_wired",
     note: "Artisan import matching helper for upload flows."
@@ -941,7 +1004,7 @@ var CHAT_AGENT_CAPABILITY_EXCLUSIONS = {
   },
   "roasts.createBatch": {
     reason: "write_not_agent_facing",
-    note: "Bulk roast creation; no confirmed action."
+    note: "Deprecated name-based bulk roast creation; no confirmed action."
   },
   "roasts.update": {
     reason: "confirmed_action_write",
@@ -953,7 +1016,7 @@ var CHAT_AGENT_CAPABILITY_EXCLUSIONS = {
   },
   "roasts.deleteBatch": {
     reason: "write_not_agent_facing",
-    note: "Destructive; no confirmed action."
+    note: "Deprecated name-based delete; destructive; no confirmed action."
   },
   "roasts.replaceLiveCurve": {
     reason: "write_not_agent_facing",