@amigo-ai/platform-sdk 0.6.0 → 0.7.0

package/api.md

@@ -52,6 +52,8 @@ Notes:
 - Pagination and response helpers: `paginate`, `buildLastResponse`, `extractRequestId`
 - Response and hook types: `PaginatedList`, `ListParams`, `LastResponseInfo`, `ResponseMetadata`, `WithResponseMetadata`, `AmigoResponse`, `RetryOptions`, `RateLimitInfo`, `ClientHooks`, `RequestHookContext`, `ResponseHookContext`, `ErrorHookContext`
 - Generated OpenAPI types: `paths`, `components`, `operations`
+- Generated API types are produced with `npm run gen-types` from the committed `openapi.json` snapshot.
+- The generated OpenAPI types may include spec-only endpoints that do not yet have resource wrappers; use the low-level `GET`/`POST`/`PUT`/`PATCH`/`DELETE` helpers for those operations until a dedicated resource is added. Current spec-only groups include `/use-cases` and `/voicemail`.
 
 ## Resources
 
@@ -271,6 +273,13 @@ All workspace-scoped resources also expose `withOptions(options)`.
 - `recommend`
 - `getIntelligence`
 
+### `metrics`
+
+- `listLatest`
+- `getCatalog`
+- `getValues`
+- `getTrend`
+
 ### `settings`
 
 - `voice.get`

package/dist/core/utils.js

@@ -15,17 +15,25 @@ export function buildLastResponse(response) {
     };
 }
 /**
- * Extracts the data payload from an openapi-fetch response,
- * throwing ParseError if the response is empty or unexpected.
+ * Extracts the data payload from an openapi-fetch response.
+ * Empty-body success responses return undefined; other empty responses throw.
  */
-export function extractData(result) {
+export function extractData(result, options = {}) {
     if (result.data !== undefined) {
         return attachResponseMetadata(result.data, result.response);
     }
-    throw new ParseError('Unexpected empty response from API', result.error !== undefined ? JSON.stringify(result.error) : undefined);
+    if (isEmptyBodySuccess(result.response) || options.allowEmptyBody) {
+        return undefined;
+    }
+    // Degenerate openapi-fetch results with both data and error keep the SDK's
+    // original data-first behavior; without data, errors stay fatal.
+    if (result.error !== undefined) {
+        throw new ParseError('Unexpected error response from API', JSON.stringify(result.error));
+    }
+    throw new ParseError('Unexpected empty response from API', result.response ? `status=${result.response.status}` : undefined);
 }
-export function withResponse(result) {
-    const data = extractData(result);
+export function withResponse(result, options = {}) {
+    const data = extractData(result, options);
     const lastResponse = buildLastResponse(result.response);
     return {
         data,
@@ -65,6 +73,9 @@ function attachResponseMetadata(data, response) {
     defineHiddenMetadata(target, 'lastResponse', lastResponse);
     return target;
 }
+function isEmptyBodySuccess(response) {
+    return response?.status === 204 || response?.status === 205;
+}
 function defineHiddenMetadata(target, key, value) {
     try {
         Object.defineProperty(target, key, {

package/dist/core/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/core/utils.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,qBAAqB,EAAsB,MAAM,iBAAiB,CAAA;AAuB3E,MAAM,UAAU,gBAAgB,CAAC,QAAkB;IACjD,OAAO,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;AAC7C,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,QAAkB;IAClD,OAAO;QACL,SAAS,EAAE,gBAAgB,CAAC,QAAQ,CAAC;QACrC,UAAU,EAAE,QAAQ,CAAC,MAAM;QAC3B,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,SAAS,EAAE,qBAAqB,CAAC,QAAQ,CAAC,OAAO,CAAC;KACnD,CAAA;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAI,MAI9B;IACC,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC9B,OAAO,sBAAsB,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,QAAQ,CAA4B,CAAA;IACxF,CAAC;IACD,MAAM,IAAI,UAAU,CAClB,oCAAoC,EACpC,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CACtE,CAAA;AACH,CAAC;AAED,MAAM,UAAU,YAAY,CAAI,MAI/B;IACC,MAAM,IAAI,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,MAAM,YAAY,GAAG,iBAAiB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IAEvD,OAAO;QACL,IAAI;QACJ,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,SAAS,EAAE,YAAY,CAAC,SAAS;QACjC,SAAS,EAAE,YAAY,CAAC,SAAS;KAClC,CAAA;AACH,CAAC;AAqBD;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC,QAAQ,CAC7B,OAAkE;IAElE,IAAI,KAAK,GAAuB,SAAS,CAAA;IACzC,OAAO,IAAI,EAAE,CAAC;QACZ,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,CAAA;QACjC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YAC9B,MAAM,IAAI,CAAA;QACZ,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,kBAAkB,KAAK,IAAI;YAAE,MAAK;QAC7D,KAAK,GAAG,IAAI,CAAC,kBAAkB,CAAA;IACjC,CAAC;AACH,CAAC;AAED,SAAS,sBAAsB,CAAI,IAAO,EAAE,QAAmB;IAC7D,IAAI,CAAC,QAAQ,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAC3D,OAAO,IAA+B,CAAA;IACxC,CAAC;IAED,MAAM,MAAM,GAAG,IAAqC,CAAA;IACpD,MAAM,YAAY,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAA;IAEhD,oBAAoB,CAAC,MAAM,EAAE,aAAa,EAAE,YAAY,CAAC,SAAS,CAAC,CAAA;IACnE,oBAAoB,CAAC,MAAM,EAAE,cAAc,EAAE,YAAY,CAAC,CAAA;IAE1D,OAAO,MAAiC,CAAA;AAC1C,CAAC;AAED,SAAS,oBAAoB,CAC3B,MAAS,EACT,GAAM,EACN,KAA0B;IAE1B,IAAI,CAAC;QACH,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE;YACjC,KAAK;YACL,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,IAAI;YAClB,QAAQ,EAAE,KAAK;SAChB,CAAC,CAAA;IACJ,CAAC;IAAC,MAAM,CAAC;QACP,uCAAuC;IACzC,CAAC;AACH,CAAC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/core/utils.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,qBAAqB,EAAsB,MAAM,iBAAiB,CAAA;AAuB3E,MAAM,UAAU,gBAAgB,CAAC,QAAkB;IACjD,OAAO,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;AAC7C,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,QAAkB;IAClD,OAAO;QACL,SAAS,EAAE,gBAAgB,CAAC,QAAQ,CAAC;QACrC,UAAU,EAAE,QAAQ,CAAC,MAAM;QAC3B,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,SAAS,EAAE,qBAAqB,CAAC,QAAQ,CAAC,OAAO,CAAC;KACnD,CAAA;AACH,CAAC;AAYD;;;GAGG;AACH,MAAM,UAAU,WAAW,CACzB,MAAwB,EACxB,UAA8B,EAAE;IAEhC,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC9B,OAAO,sBAAsB,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,QAAQ,CAA4B,CAAA;IACxF,CAAC;IAED,IAAI,kBAAkB,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;QAClE,OAAO,SAAoC,CAAA;IAC7C,CAAC;IAED,2EAA2E;IAC3E,iEAAiE;IACjE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAC/B,MAAM,IAAI,UAAU,CAAC,oCAAoC,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;IAC1F,CAAC;IAED,MAAM,IAAI,UAAU,CAClB,oCAAoC,EACpC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,CACjE,CAAA;AACH,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,MAAiD,EACjD,UAA8B,EAAE;IAEhC,MAAM,IAAI,GAAG,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACzC,MAAM,YAAY,GAAG,iBAAiB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IAEvD,OAAO;QACL,IAAI;QACJ,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,SAAS,EAAE,YAAY,CAAC,SAAS;QACjC,SAAS,EAAE,YAAY,CAAC,SAAS;KAClC,CAAA;AACH,CAAC;AAqBD;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC,QAAQ,CAC7B,OAAkE;IAElE,IAAI,KAAK,GAAuB,SAAS,CAAA;IACzC,OAAO,IAAI,EAAE,CAAC;QACZ,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,CAAA;QACjC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YAC9B,MAAM,IAAI,CAAA;QACZ,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,kBAAkB,KAAK,IAAI;YAAE,MAAK;QAC7D,KAAK,GAAG,IAAI,CAAC,kBAAkB,CAAA;IACjC,CAAC;AACH,CAAC;AAED,SAAS,sBAAsB,CAAI,IAAO,EAAE,QAAmB;IAC7D,IAAI,CAAC,QAAQ,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAC3D,OAAO,IAA+B,CAAA;IACxC,CAAC;IAED,MAAM,MAAM,GAAG,IAAqC,CAAA;IACpD,MAAM,YAAY,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAA;IAEhD,oBAAoB,CAAC,MAAM,EAAE,aAAa,EAAE,YAAY,CAAC,SAAS,CAAC,CAAA;IACnE,oBAAoB,CAAC,MAAM,EAAE,cAAc,EAAE,YAAY,CAAC,CAAA;IAE1D,OAAO,MAAiC,CAAA;AAC1C,CAAC;AAED,SAAS,kBAAkB,CAAC,QAAmB;IAC7C,OAAO,QAAQ,EAAE,MAAM,KAAK,GAAG,IAAI,QAAQ,EAAE,MAAM,KAAK,GAAG,CAAA;AAC7D,CAAC;AAED,SAAS,oBAAoB,CAC3B,MAAS,EACT,GAAM,EACN,KAA0B;IAE1B,IAAI,CAAC;QACH,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE;YACjC,KAAK;YACL,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,IAAI;YAClB,QAAQ,EAAE,KAAK;SAChB,CAAC,CAAA;IACJ,CAAC;IAAC,MAAM,CAAC;QACP,uCAAuC;IACzC,CAAC;AACH,CAAC"}

package/dist/index.cjs

@@ -478,17 +478,23 @@ function buildLastResponse(response) {
     rateLimit: parseRateLimitHeaders(response.headers)
   };
 }
-function extractData(result) {
+function extractData(result, options = {}) {
   if (result.data !== void 0) {
     return attachResponseMetadata(result.data, result.response);
   }
+  if (isEmptyBodySuccess(result.response) || options.allowEmptyBody) {
+    return void 0;
+  }
+  if (result.error !== void 0) {
+    throw new ParseError("Unexpected error response from API", JSON.stringify(result.error));
+  }
   throw new ParseError(
     "Unexpected empty response from API",
-    result.error !== void 0 ? JSON.stringify(result.error) : void 0
+    result.response ? `status=${result.response.status}` : void 0
   );
 }
-function withResponse(result) {
-  const data = extractData(result);
+function withResponse(result, options = {}) {
+  const data = extractData(result, options);
   const lastResponse = buildLastResponse(result.response);
   return {
     data,
@@ -518,6 +524,9 @@ function attachResponseMetadata(data, response) {
   defineHiddenMetadata(target, "lastResponse", lastResponse);
   return target;
 }
+function isEmptyBodySuccess(response) {
+  return response?.status === 204 || response?.status === 205;
+}
 function defineHiddenMetadata(target, key, value) {
   try {
     Object.defineProperty(target, key, {
@@ -2203,6 +2212,48 @@ var SimulationsResource = class extends WorkspaceScopedResource {
   }
 };
 
+// src/resources/metrics.ts
+var MetricsResource = class extends WorkspaceScopedResource {
+  /** List the latest value for each metric in the workspace */
+  async listLatest() {
+    return extractData(
+      await this.client.GET("/v1/{workspace_id}/metrics", {
+        params: { path: { workspace_id: this.workspaceId } }
+      })
+    );
+  }
+  /** List available built-in and custom metric definitions */
+  async getCatalog() {
+    return extractData(
+      await this.client.GET("/v1/{workspace_id}/metrics/catalog", {
+        params: { path: { workspace_id: this.workspaceId } }
+      })
+    );
+  }
+  /** Get stored values for one metric key, optionally bounded by time range */
+  async getValues(metricKey, params) {
+    return extractData(
+      await this.client.GET("/v1/{workspace_id}/metrics/{metric_key}", {
+        params: {
+          path: { workspace_id: this.workspaceId, metric_key: metricKey },
+          query: params
+        }
+      })
+    );
+  }
+  /** Get a recent time-series trend for one metric key */
+  async getTrend(metricKey, params) {
+    return extractData(
+      await this.client.GET("/v1/{workspace_id}/metrics/{metric_key}/trend", {
+        params: {
+          path: { workspace_id: this.workspaceId, metric_key: metricKey },
+          query: params
+        }
+      })
+    );
+  }
+};
+
 // src/resources/settings.ts
 var SettingsResource = class extends WorkspaceScopedResource {
   voice = {
@@ -3106,6 +3157,7 @@ var AmigoClient = class _AmigoClient {
   integrations;
   analytics;
   simulations;
+  metrics;
   settings;
   billing;
   memory;
@@ -3162,10 +3214,14 @@ var AmigoClient = class _AmigoClient {
     return withResponse(await this.resolveApiRequest(path, "DELETE", init));
   }
   async HEAD(path, ...[init]) {
-    return withResponse(await this.resolveApiRequest(path, "HEAD", init));
+    return withResponse(await this.resolveApiRequest(path, "HEAD", init), {
+      allowEmptyBody: true
+    });
   }
   async OPTIONS(path, ...[init]) {
-    return withResponse(await this.resolveApiRequest(path, "OPTIONS", init));
+    return withResponse(await this.resolveApiRequest(path, "OPTIONS", init), {
+      allowEmptyBody: true
+    });
   }
   static fromPlatformClient(client, workspaceId2, baseUrl) {
     const instance = Object.create(_AmigoClient.prototype);
@@ -3193,6 +3249,7 @@ var AmigoClient = class _AmigoClient {
     mutable.integrations = new IntegrationsResource(client, workspaceId2);
     mutable.analytics = new AnalyticsResource(client, workspaceId2);
     mutable.simulations = new SimulationsResource(client, workspaceId2);
+    mutable.metrics = new MetricsResource(client, workspaceId2);
     mutable.settings = new SettingsResource(client, workspaceId2);
     mutable.billing = new BillingResource(client, workspaceId2);
     mutable.memory = new MemoryResource(client, workspaceId2);