@myapihq/sdk 1.3.1 → 1.3.4

package/dist/hq.d.ts

@@ -132,3 +132,35 @@ export declare function setupPayment(apiKey: string): Promise<{
 export declare function topUp(apiKey: string, amountDollars: number): Promise<{
     new_balance_display: string;
 }>;
+export type DoctorSeverity = 'ok' | 'warn' | 'crit';
+export interface DoctorEntityRef {
+    slot: string;
+    id: string;
+    name?: string;
+}
+export interface DoctorIssue {
+    id: string;
+    severity: DoctorSeverity;
+    scope: string;
+    entity?: DoctorEntityRef;
+    category?: string;
+    message: string;
+    hint?: string;
+}
+export interface DoctorSection {
+    name: string;
+    summary: string;
+    issues: DoctorIssue[];
+}
+export interface DoctorReport {
+    org_id: string;
+    generated_at: string;
+    cache_ttl_seconds?: number;
+    sections: DoctorSection[];
+    totals: {
+        ok: number;
+        warn: number;
+        crit: number;
+    };
+}
+export declare function getDoctor(apiKey: string, orgId: string): Promise<DoctorReport>;

package/dist/hq.js

@@ -25,6 +25,7 @@ exports.getBillingHistory = getBillingHistory;
 exports.getBillingUsage = getBillingUsage;
 exports.setupPayment = setupPayment;
 exports.topUp = topUp;
+exports.getDoctor = getDoctor;
 const client_1 = require("./client");
 const config_1 = require("./config");
 exports.EXPOSES = [
@@ -52,6 +53,7 @@ exports.EXPOSES = [
     'GET /hq/billing/usage',
     'POST /hq/billing/setup-payment',
     'POST /hq/billing/topup',
+    'GET /hq/orgs/{org_id}/doctor',
 ];
 // The closed grantable-slot vocabulary. Mirrors `iam.GrantableSlots` in the
 // backend — keep in sync. Used to validate `--grant` client-side before the
@@ -153,3 +155,6 @@ async function setupPayment(apiKey) {
 async function topUp(apiKey, amountDollars) {
     return (0, client_1.request)('POST', `${config_1.HQ_BASE}/hq/billing/topup`, apiKey, { amount_dollars: amountDollars });
 }
+async function getDoctor(apiKey, orgId) {
+    return (0, client_1.request)('GET', `${config_1.HQ_BASE}/hq/orgs/${encodeURIComponent(orgId)}/doctor`, apiKey);
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@myapihq/sdk",
   "license": "Apache-2.0",
-  "version": "1.3.1",
+  "version": "1.3.4",
   "description": "TypeScript SDK for the MyAPI ecosystem",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/hq.ts

@@ -27,6 +27,7 @@ export const EXPOSES: Exposes = [
   'GET /hq/billing/usage',
   'POST /hq/billing/setup-payment',
   'POST /hq/billing/topup',
+  'GET /hq/orgs/{org_id}/doctor',
 ];
 
 export interface Org {
@@ -264,3 +265,52 @@ export async function setupPayment(apiKey: string): Promise<{ url: string }> {
 export async function topUp(apiKey: string, amountDollars: number): Promise<{ new_balance_display: string }> {
   return request('POST', `${BASE_URL}/hq/billing/topup`, apiKey, { amount_dollars: amountDollars });
 }
+
+// ── Org doctor ─────────────────────────────────────────────────────────
+// Aggregated consistency report across slots. The endpoint resolves the
+// reported org from the API key's binding, so the `{org_id}` path param
+// is currently positional/cosmetic (pass your default — the response will
+// indicate which org was actually scored under `report.org_id`).
+
+export type DoctorSeverity = 'ok' | 'warn' | 'crit';
+
+export interface DoctorEntityRef {
+  slot: string;     // 'funnel' | 'webhook' | 'workflow' | 'container' | 'domain' | …
+  id: string;
+  name?: string;
+}
+
+export interface DoctorIssue {
+  id: string;                       // stable across runs, dedupable
+  severity: DoctorSeverity;
+  scope: string;                    // logical scope, e.g. 'funnel/<slug>'
+  entity?: DoctorEntityRef;
+  // Open string — do not exhaustively switch on it. Backend categories,
+  // per the OpenAPI schema: 'reference_integrity' | 'orphan' | 'activity' |
+  // 'security' | 'billing' | 'internal'. The backend may also emit
+  // slash-namespaced subcategories (e.g. 'security/spf', 'security/dmarc');
+  // if you branch on category, match the parent by splitting on the first
+  // '/'. The CLI's local augmentation adds one more category not in the
+  // schema: 'network' (the DNS + HTTP reachability probes).
+  category?: string;
+  message: string;
+  hint?: string;
+}
+
+export interface DoctorSection {
+  name: string;
+  summary: string;
+  issues: DoctorIssue[];
+}
+
+export interface DoctorReport {
+  org_id: string;
+  generated_at: string;             // RFC3339
+  cache_ttl_seconds?: number;
+  sections: DoctorSection[];
+  totals: { ok: number; warn: number; crit: number };
+}
+
+export async function getDoctor(apiKey: string, orgId: string): Promise<DoctorReport> {
+  return request('GET', `${BASE_URL}/hq/orgs/${encodeURIComponent(orgId)}/doctor`, apiKey);
+}