@talonic/docs 0.20.18 → 0.20.20

package/dist/index.js

@@ -813,6 +813,41 @@ var NAV_SECTIONS = [
       { id: "credits-usage-log", label: "Usage Log" }
     ]
   },
+  {
+    id: "data-products",
+    label: "Data Products",
+    children: [
+      { id: "list-data-products", label: "List Data Products" },
+      { id: "get-data-product", label: "Get Data Product" },
+      { id: "delete-data-product", label: "Delete Data Product" },
+      { id: "get-data-product-results", label: "Get Results" }
+    ]
+  },
+  {
+    id: "data-policies",
+    label: "Data Policies",
+    children: [
+      { id: "list-data-policies", label: "List Policies" },
+      { id: "create-data-policy", label: "Create Policy" },
+      { id: "get-data-policy", label: "Get Policy" },
+      { id: "update-data-policy", label: "Update Policy" },
+      { id: "delete-data-policy", label: "Delete Policy" },
+      { id: "list-data-policy-versions", label: "List Versions" },
+      { id: "list-data-policy-fields", label: "List Fields" },
+      { id: "list-data-policy-rules", label: "List Rules" }
+    ]
+  },
+  {
+    id: "record-sets",
+    label: "Record Sets",
+    children: [
+      { id: "list-record-sets", label: "List Record Sets" },
+      { id: "get-record-set", label: "Get Record Set" },
+      { id: "list-record-set-fields", label: "List Fields" },
+      { id: "list-record-set-records", label: "List Records" },
+      { id: "export-record-set", label: "Export" }
+    ]
+  },
   {
     id: "billing",
     label: "Billing",
@@ -5032,6 +5067,128 @@ function verifyWebhook(payload, signature, secret) {
 }` })
         }
       ) }),
+      /* @__PURE__ */ jsx5(SectionHeading, { id: "data-products", children: "Data Products" }),
+      /* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-4", children: "Data products are the final assembled output of the structuring pipeline. They combine extraction results with resolution rules, validation, and approval gates into a deliverable dataset. Use these endpoints to list, inspect, and export your structured data." }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "list-data-products", children: "List Data Products" }),
+      /* @__PURE__ */ jsxs5(EndpointBlock, { method: "GET", path: "/v1/data-products", summary: "List data products with cursor-based pagination.", children: [
+        /* @__PURE__ */ jsx5(ParamTable, { title: "Query parameters", params: [
+          { name: "status", type: "string", description: "Filter by status (draft, ready, published, archived)." },
+          { name: "limit", type: "integer", default: "20", description: "Items per page (1-100)." },
+          { name: "cursor", type: "string", description: "Opaque pagination cursor." },
+          { name: "order", type: "string", default: "desc", description: "Sort order (asc | desc)." }
+        ] }),
+        /* @__PURE__ */ jsx5(CodeBlock, { title: "curl", children: `curl https://api.talonic.com/v1/data-products?status=ready \\
+  -H "Authorization: Bearer tlnc_YOUR_KEY"` })
+      ] }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "get-data-product", children: "Get Data Product" }),
+      /* @__PURE__ */ jsx5(EndpointBlock, { method: "GET", path: "/v1/data-products/{id}", summary: "Get a single data product by ID.", children: /* @__PURE__ */ jsx5(ParamTable, { title: "Path parameters", params: [
+        { name: "id", type: "uuid", required: true, description: "Data product UUID." }
+      ] }) }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "delete-data-product", children: "Delete Data Product" }),
+      /* @__PURE__ */ jsx5(EndpointBlock, { method: "DELETE", path: "/v1/data-products/{id}", summary: "Delete a data product. Requires write scope.", children: /* @__PURE__ */ jsx5(ParamTable, { title: "Path parameters", params: [
+        { name: "id", type: "uuid", required: true, description: "Data product UUID." }
+      ] }) }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "get-data-product-results", children: "Get Data Product Results" }),
+      /* @__PURE__ */ jsxs5(EndpointBlock, { method: "GET", path: "/v1/data-products/{id}/results", summary: "Get paginated result rows for a data product.", children: [
+        /* @__PURE__ */ jsx5(ParamTable, { title: "Path parameters", params: [
+          { name: "id", type: "uuid", required: true, description: "Data product UUID." }
+        ] }),
+        /* @__PURE__ */ jsx5(ParamTable, { title: "Query parameters", params: [
+          { name: "limit", type: "integer", default: "20", description: "Items per page (1-100)." },
+          { name: "cursor", type: "string", description: "Opaque pagination cursor." }
+        ] }),
+        /* @__PURE__ */ jsx5(CodeBlock, { title: "curl", children: `curl https://api.talonic.com/v1/data-products/DP_ID/results \\
+  -H "Authorization: Bearer tlnc_YOUR_KEY"` })
+      ] }),
+      /* @__PURE__ */ jsx5(SectionHeading, { id: "data-policies", children: "Data Policies" }),
+      /* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-4", children: "Data policies define transformation rules that normalize and enrich extracted field values. They power the resolution pipeline with lookup cascades, deterministic compute, format constraints, and optional Lua scripting. Policies are versioned \u2014 publish a version to lock it for production use." }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "list-data-policies", children: "List Policies" }),
+      /* @__PURE__ */ jsx5(EndpointBlock, { method: "GET", path: "/v1/data-policies", summary: "List all data policies with cursor-based pagination.", children: /* @__PURE__ */ jsx5(ParamTable, { title: "Query parameters", params: [
+        { name: "limit", type: "integer", default: "20", description: "Items per page (1-100)." },
+        { name: "cursor", type: "string", description: "Opaque pagination cursor." },
+        { name: "order", type: "string", default: "desc", description: "Sort order (asc | desc)." }
+      ] }) }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "create-data-policy", children: "Create Policy" }),
+      /* @__PURE__ */ jsxs5(EndpointBlock, { method: "POST", path: "/v1/data-policies", summary: "Create a new data policy. Requires write scope.", children: [
+        /* @__PURE__ */ jsx5(ParamTable, { title: "Body parameters", params: [
+          { name: "name", type: "string", required: true, description: "Policy name." },
+          { name: "description", type: "string", description: "Optional description." }
+        ] }),
+        /* @__PURE__ */ jsx5(CodeBlock, { title: "curl", children: `curl -X POST https://api.talonic.com/v1/data-policies \\
+  -H "Authorization: Bearer tlnc_YOUR_KEY" \\
+  -H "Content-Type: application/json" \\
+  -d '{"name": "Invoice Normalization"}'` })
+      ] }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "get-data-policy", children: "Get Policy" }),
+      /* @__PURE__ */ jsxs5(EndpointBlock, { method: "GET", path: "/v1/data-policies/{id}", summary: "Get a policy with its fields and rules inlined.", children: [
+        /* @__PURE__ */ jsx5(ParamTable, { title: "Path parameters", params: [
+          { name: "id", type: "uuid", required: true, description: "Policy UUID." }
+        ] }),
+        /* @__PURE__ */ jsxs5(Callout, { type: "info", children: [
+          "The response includes ",
+          /* @__PURE__ */ jsx5(InlineCode, { children: "fields" }),
+          " and ",
+          /* @__PURE__ */ jsx5(InlineCode, { children: "rules" }),
+          " arrays inlined in the policy object for convenience."
+        ] })
+      ] }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "update-data-policy", children: "Update Policy" }),
+      /* @__PURE__ */ jsx5(EndpointBlock, { method: "PATCH", path: "/v1/data-policies/{id}", summary: "Update policy name or description. Requires write scope.", children: /* @__PURE__ */ jsx5(ParamTable, { title: "Body parameters", params: [
+        { name: "name", type: "string", description: "New policy name." },
+        { name: "description", type: "string", description: "New description." }
+      ] }) }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "delete-data-policy", children: "Delete Policy" }),
+      /* @__PURE__ */ jsx5(EndpointBlock, { method: "DELETE", path: "/v1/data-policies/{id}", summary: "Delete a data policy. Requires write scope." }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "list-data-policy-versions", children: "List Versions" }),
+      /* @__PURE__ */ jsx5(EndpointBlock, { method: "GET", path: "/v1/data-policies/{id}/versions", summary: "List all published versions of a policy.", children: /* @__PURE__ */ jsx5(ParamTable, { title: "Path parameters", params: [
+        { name: "id", type: "uuid", required: true, description: "Policy UUID." }
+      ] }) }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "list-data-policy-fields", children: "List Fields" }),
+      /* @__PURE__ */ jsx5(EndpointBlock, { method: "GET", path: "/v1/data-policies/{id}/fields", summary: "List declared output fields for a policy.", children: /* @__PURE__ */ jsx5(ParamTable, { title: "Path parameters", params: [
+        { name: "id", type: "uuid", required: true, description: "Policy UUID." }
+      ] }) }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "list-data-policy-rules", children: "List Rules" }),
+      /* @__PURE__ */ jsx5(EndpointBlock, { method: "GET", path: "/v1/data-policies/{id}/rules", summary: "List transformation rules ordered by execution priority.", children: /* @__PURE__ */ jsx5(ParamTable, { title: "Path parameters", params: [
+        { name: "id", type: "uuid", required: true, description: "Policy UUID." }
+      ] }) }),
+      /* @__PURE__ */ jsx5(SectionHeading, { id: "record-sets", children: "Record Sets" }),
+      /* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-4", children: "Record sets are the value-plane storage layer \u2014 typed tables that hold cell values with confidence scores and provenance metadata. Each extraction, structuring run, or resolution produces a record set at the appropriate layer (capture, structured, resolved, or product)." }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "list-record-sets", children: "List Record Sets" }),
+      /* @__PURE__ */ jsx5(EndpointBlock, { method: "GET", path: "/v1/record-sets", summary: "List record sets with optional layer and source_type filters.", children: /* @__PURE__ */ jsx5(ParamTable, { title: "Query parameters", params: [
+        { name: "layer", type: "string", description: "Filter by value layer (capture, structured, resolved, product)." },
+        { name: "source_type", type: "string", description: "Filter by source type (e.g. extraction, job, resolution)." },
+        { name: "limit", type: "integer", default: "20", description: "Items per page (1-100)." },
+        { name: "cursor", type: "string", description: "Opaque pagination cursor." },
+        { name: "order", type: "string", default: "desc", description: "Sort order (asc | desc)." }
+      ] }) }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "get-record-set", children: "Get Record Set" }),
+      /* @__PURE__ */ jsx5(EndpointBlock, { method: "GET", path: "/v1/record-sets/{id}", summary: "Get a single record set with field and record counts.", children: /* @__PURE__ */ jsx5(ParamTable, { title: "Path parameters", params: [
+        { name: "id", type: "uuid", required: true, description: "Record set UUID." }
+      ] }) }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "list-record-set-fields", children: "List Fields" }),
+      /* @__PURE__ */ jsx5(EndpointBlock, { method: "GET", path: "/v1/record-sets/{id}/fields", summary: "List the field schema for a record set, ordered by ordinal.", children: /* @__PURE__ */ jsx5(ParamTable, { title: "Path parameters", params: [
+        { name: "id", type: "uuid", required: true, description: "Record set UUID." }
+      ] }) }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "list-record-set-records", children: "List Records" }),
+      /* @__PURE__ */ jsxs5(EndpointBlock, { method: "GET", path: "/v1/record-sets/{id}/records", summary: "Get paginated records using offset pagination.", children: [
+        /* @__PURE__ */ jsx5(ParamTable, { title: "Query parameters", params: [
+          { name: "page", type: "integer", default: "1", description: "Page number (1-based)." },
+          { name: "limit", type: "integer", default: "50", description: "Records per page (max 200)." }
+        ] }),
+        /* @__PURE__ */ jsx5(CodeBlock, { title: "curl", children: `curl "https://api.talonic.com/v1/record-sets/RS_ID/records?page=1&limit=50" \\
+  -H "Authorization: Bearer tlnc_YOUR_KEY"` })
+      ] }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "export-record-set", children: "Export" }),
+      /* @__PURE__ */ jsxs5(EndpointBlock, { method: "GET", path: "/v1/record-sets/{id}/export", summary: "Export all records as a JSON array. Best for smaller datasets.", children: [
+        /* @__PURE__ */ jsx5(ParamTable, { title: "Path parameters", params: [
+          { name: "id", type: "uuid", required: true, description: "Record set UUID." }
+        ] }),
+        /* @__PURE__ */ jsxs5(Callout, { type: "warning", children: [
+          "For large record sets (10,000+ records), prefer the paginated ",
+          /* @__PURE__ */ jsx5(InlineCode, { children: "/records" }),
+          " endpoint to avoid timeouts and high memory usage."
+        ] })
+      ] }),
       /* @__PURE__ */ jsx5(SectionHeading, { id: "errors-rate-limits", children: "Errors & Rate Limits" }),
       /* @__PURE__ */ jsx5(SubHeading, { id: "error-format", children: "Error Format" }),
       /* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-4", children: "All errors return a consistent JSON structure with a machine-readable code and a human-readable message." }),
@@ -6715,6 +6872,29 @@ var API_NAV_SECTIONS = [
   { id: "registry", label: "Registry", children: [
     { id: "registry-query", label: "Query" }
   ] },
+  { id: "data-products", label: "Data Products", children: [
+    { id: "list-data-products", label: "List Data Products" },
+    { id: "get-data-product", label: "Get Data Product" },
+    { id: "delete-data-product", label: "Delete Data Product" },
+    { id: "get-data-product-results", label: "Get Results" }
+  ] },
+  { id: "data-policies", label: "Data Policies", children: [
+    { id: "list-data-policies", label: "List Policies" },
+    { id: "create-data-policy", label: "Create Policy" },
+    { id: "get-data-policy", label: "Get Policy" },
+    { id: "update-data-policy", label: "Update Policy" },
+    { id: "delete-data-policy", label: "Delete Policy" },
+    { id: "list-data-policy-versions", label: "List Versions" },
+    { id: "list-data-policy-fields", label: "List Fields" },
+    { id: "list-data-policy-rules", label: "List Rules" }
+  ] },
+  { id: "record-sets", label: "Record Sets", children: [
+    { id: "list-record-sets", label: "List Record Sets" },
+    { id: "get-record-set", label: "Get Record Set" },
+    { id: "list-record-set-fields", label: "List Fields" },
+    { id: "list-record-set-records", label: "List Records" },
+    { id: "export-record-set", label: "Export" }
+  ] },
   { id: "billing", label: "Billing", children: [
     { id: "billing-settings", label: "Settings" },
     { id: "billing-topup", label: "Auto Top-Up" },