@clocknext/sdk 0.16.0 → 0.17.0

package/README.md

@@ -727,7 +727,7 @@ const credit = await cnk.credits.create({
   agentKey: "deep_research",
   marginPercent: 20,
   modelBundle: [
-    { orgModelId: "cm_model_01", averageTokensPerLLMCall: 100000, input: 60, output: 30, cache: 5, cacheWrite: 5 },
+    { modelId: "claude-sonnet-4-5", averageTokensPerLLMCall: 100000, input: 60, output: 30, cache: 5, cacheWrite: 5 },
   ],
 });
 
@@ -737,7 +737,7 @@ const outcome = await cnk.outcomes.create({
   marginPercent: 100,
   steps: [
     { name: "Extract clauses", agentKey: "contract_review.extract",
-      modelBundle: [{ orgModelId: "cm_model_01", averageTokensPerLLMCall: 50000, input: 70, output: 30, cache: 0 }] },
+      modelBundle: [{ modelId: "claude-sonnet-4-5", averageTokensPerLLMCall: 50000, input: 70, output: 30, cache: 0 }] },
   ],
 });
 
@@ -771,8 +771,8 @@ await cnk.units.archive(unit.id);                           // retire it
 await cnk.units.unarchive(unit.id);                         // and bring it back
 ```
 
-Models are enabled in the ClockNext dashboard; a bundle line's `orgModelId` is
-the workspace's id for the model.
+Models are enabled in the ClockNext dashboard. A bundle line names its model by
+`modelId` — the same id you send as `usage.model` on a signal.
 
 ## Customer portal
 

package/dist/index.cjs

@@ -333,7 +333,7 @@ function sleep(ms) {
 }
 
 // src/http.ts
-var SDK_VERSION = "0.16.0" ;
+var SDK_VERSION = "0.17.0" ;
 var Transport = class {
   constructor(cfg) {
     this.cfg = cfg;

package/dist/index.d.cts

@@ -713,8 +713,10 @@ interface CreatePlanInput {
 type UpdatePlanInput = Partial<CreatePlanInput>;
 /** One model line of a credit's / outcome step's pricing bundle, as returned. */
 interface ModelBundleLine {
-    /** The workspace's model row id (`id` from the Models API). */
-    orgModelId: string;
+    /** The model's id — the same one a usage signal sends as `usage.model`.
+     *  `null` only when the model was removed from the workspace after this
+     *  bundle was saved (the line keeps its name and stored price). */
+    modelId: string | null;
     /** The model's display name, filled in by the server. */
     modelName: string;
     /** Average tokens one LLM call uses on this model. */
@@ -730,7 +732,10 @@ interface ModelBundleLine {
  *  the price is the sum of their costs, worked out on the server from the
  *  models' live prices. */
 interface ModelBundleLineInput {
-    orgModelId: string;
+    /** The model's id, e.g. `"gpt-4o"` — the same one a usage signal sends as
+     *  `usage.model`. Matched ignoring case; it must be enabled in your
+     *  workspace. */
+    modelId: string;
     /** Above 0. */
     averageTokensPerLLMCall: number;
     input: number;

package/dist/index.d.ts

@@ -713,8 +713,10 @@ interface CreatePlanInput {
 type UpdatePlanInput = Partial<CreatePlanInput>;
 /** One model line of a credit's / outcome step's pricing bundle, as returned. */
 interface ModelBundleLine {
-    /** The workspace's model row id (`id` from the Models API). */
-    orgModelId: string;
+    /** The model's id — the same one a usage signal sends as `usage.model`.
+     *  `null` only when the model was removed from the workspace after this
+     *  bundle was saved (the line keeps its name and stored price). */
+    modelId: string | null;
     /** The model's display name, filled in by the server. */
     modelName: string;
     /** Average tokens one LLM call uses on this model. */
@@ -730,7 +732,10 @@ interface ModelBundleLine {
  *  the price is the sum of their costs, worked out on the server from the
  *  models' live prices. */
 interface ModelBundleLineInput {
-    orgModelId: string;
+    /** The model's id, e.g. `"gpt-4o"` — the same one a usage signal sends as
+     *  `usage.model`. Matched ignoring case; it must be enabled in your
+     *  workspace. */
+    modelId: string;
     /** Above 0. */
     averageTokensPerLLMCall: number;
     input: number;

package/dist/index.js

@@ -331,7 +331,7 @@ function sleep(ms) {
 }
 
 // src/http.ts
-var SDK_VERSION = "0.16.0" ;
+var SDK_VERSION = "0.17.0" ;
 var Transport = class {
   constructor(cfg) {
     this.cfg = cfg;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clocknext/sdk",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "description": "Official ClockNext SDK — record usage signals and manage plans, purchases, invoices, customers, and billing from your backend.",
   "license": "MIT",
   "type": "module",

package/src/types.ts

@@ -785,8 +785,10 @@ export type UpdatePlanInput = Partial<CreatePlanInput>;
 
 /** One model line of a credit's / outcome step's pricing bundle, as returned. */
 export interface ModelBundleLine {
-  /** The workspace's model row id (`id` from the Models API). */
-  orgModelId: string;
+  /** The model's id — the same one a usage signal sends as `usage.model`.
+   *  `null` only when the model was removed from the workspace after this
+   *  bundle was saved (the line keeps its name and stored price). */
+  modelId: string | null;
   /** The model's display name, filled in by the server. */
   modelName: string;
   /** Average tokens one LLM call uses on this model. */
@@ -803,7 +805,10 @@ export interface ModelBundleLine {
  *  the price is the sum of their costs, worked out on the server from the
  *  models' live prices. */
 export interface ModelBundleLineInput {
-  orgModelId: string;
+  /** The model's id, e.g. `"gpt-4o"` — the same one a usage signal sends as
+   *  `usage.model`. Matched ignoring case; it must be enabled in your
+   *  workspace. */
+  modelId: string;
   /** Above 0. */
   averageTokensPerLLMCall: number;
   input: number;