@epilot/sdk 2.15.11 → 2.15.12

package/docs/deduplication.md

@@ -27,6 +27,12 @@ const { data } = await deduplicationClient.deduplicate(...)
 - [`deduplicate`](#deduplicate)
 - [`deduplicateAsync`](#deduplicateasync)
 - [`getDeduplicationJob`](#getdeduplicationjob)
+- [`detectDuplicates`](#detectduplicates)
+- [`listUniquenessCriteria`](#listuniquenesscriteria)
+- [`createUniquenessCriteria`](#createuniquenesscriteria)
+- [`getUniquenessCriteria`](#getuniquenesscriteria)
+- [`updateUniquenessCriteria`](#updateuniquenesscriteria)
+- [`deleteUniquenessCriteria`](#deleteuniquenesscriteria)
 
 **Schemas**
 - [`DeduplicateRequestBody`](#deduplicaterequestbody)
@@ -35,6 +41,15 @@ const { data } = await deduplicationClient.deduplicate(...)
 - [`DeduplicateAsyncResponse`](#deduplicateasyncresponse)
 - [`JobStatus`](#jobstatus)
 - [`DeduplicationJob`](#deduplicationjob)
+- [`DetectDuplicatesRequestBody`](#detectduplicatesrequestbody)
+- [`DetectDuplicatesResponse`](#detectduplicatesresponse)
+- [`DetectedDuplicateMatch`](#detectedduplicatematch)
+- [`UniquenessCriteriaListResponse`](#uniquenesscriterialistresponse)
+- [`UniquenessCriteria`](#uniquenesscriteria)
+- [`MatchRule`](#matchrule)
+- [`MatchAttribute`](#matchattribute)
+- [`UniquenessCriteriaCreateBody`](#uniquenesscriteriacreatebody)
+- [`UniquenessCriteriaUpdateBody`](#uniquenesscriteriaupdatebody)
 
 ### `deduplicate`
 
@@ -153,6 +168,265 @@ const { data } = await client.getDeduplicationJob({
 
 ---
 
+### `detectDuplicates`
+
+Detects potential duplicate entities for the given entity using the schema's prioritized uniqueness rules. Returns matches with a confidence score.
+
+`POST /v1/detect-duplicates`
+
+```ts
+const { data } = await client.detectDuplicates(
+  null,
+  {
+    schema: 'string',
+    entity: {}
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "matches": [
+    {
+      "entity": {
+        "_id": "string",
+        "_org": "string",
+        "_schema": "string",
+        "_created_at": "1970-01-01T00:00:00.000Z",
+        "_updated_at": "1970-01-01T00:00:00.000Z",
+        "_created_by": "string",
+        "created_by": "string",
+        "_tags": ["string"],
+        "_acl": {},
+        "_owners": [
+          {
+            "org_id": "string",
+            "user_id": "string"
+          }
+        ],
+        "type": "string"
+      },
+      "confidence": 0,
+      "matched_attributes": ["string"]
+    }
+  ]
+}
+```
+
+</details>
+
+---
+
+### `listUniquenessCriteria`
+
+Lists UniquenessCriteria for the requesting organization. Optionally filtered by schema.
+
+`GET /v1/uniqueness-criteria`
+
+```ts
+const { data } = await client.listUniquenessCriteria({
+  schema: 'example',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "items": [
+    {
+      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+      "orgId": "string",
+      "schema": "string",
+      "matchRules": [
+        {
+          "name": "string",
+          "attributes": [
+            {
+              "attribute": "string"
+            }
+          ],
+          "confidence": 0
+        }
+      ],
+      "createdAt": "1970-01-01T00:00:00.000Z",
+      "updatedAt": "1970-01-01T00:00:00.000Z"
+    }
+  ]
+}
+```
+
+</details>
+
+---
+
+### `createUniquenessCriteria`
+
+Creates a new UniquenessCriteria record.
+
+`POST /v1/uniqueness-criteria`
+
+```ts
+const { data } = await client.createUniquenessCriteria(
+  null,
+  {
+    schema: 'string',
+    matchRules: [
+      {
+        name: 'string',
+        attributes: [
+          {
+            attribute: 'string'
+          }
+        ],
+        confidence: 0
+      }
+    ]
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+  "orgId": "string",
+  "schema": "string",
+  "matchRules": [
+    {
+      "name": "string",
+      "attributes": [
+        {
+          "attribute": "string"
+        }
+      ],
+      "confidence": 0
+    }
+  ],
+  "createdAt": "1970-01-01T00:00:00.000Z",
+  "updatedAt": "1970-01-01T00:00:00.000Z"
+}
+```
+
+</details>
+
+---
+
+### `getUniquenessCriteria`
+
+Fetch a single UniquenessCriteria record.
+
+`GET /v1/uniqueness-criteria/{schema}`
+
+```ts
+const { data } = await client.getUniquenessCriteria({
+  schema: 'example',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+  "orgId": "string",
+  "schema": "string",
+  "matchRules": [
+    {
+      "name": "string",
+      "attributes": [
+        {
+          "attribute": "string"
+        }
+      ],
+      "confidence": 0
+    }
+  ],
+  "createdAt": "1970-01-01T00:00:00.000Z",
+  "updatedAt": "1970-01-01T00:00:00.000Z"
+}
+```
+
+</details>
+
+---
+
+### `updateUniquenessCriteria`
+
+Replace the matchRules on an existing UniquenessCriteria record.
+
+`PUT /v1/uniqueness-criteria/{schema}`
+
+```ts
+const { data } = await client.updateUniquenessCriteria(
+  {
+    schema: 'example',
+  },
+  {
+    matchRules: [
+      {
+        name: 'string',
+        attributes: [
+          {
+            attribute: 'string'
+          }
+        ],
+        confidence: 0
+      }
+    ]
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+  "orgId": "string",
+  "schema": "string",
+  "matchRules": [
+    {
+      "name": "string",
+      "attributes": [
+        {
+          "attribute": "string"
+        }
+      ],
+      "confidence": 0
+    }
+  ],
+  "createdAt": "1970-01-01T00:00:00.000Z",
+  "updatedAt": "1970-01-01T00:00:00.000Z"
+}
+```
+
+</details>
+
+---
+
+### `deleteUniquenessCriteria`
+
+Delete a UniquenessCriteria record.
+
+`DELETE /v1/uniqueness-criteria/{schema}`
+
+```ts
+const { data } = await client.deleteUniquenessCriteria({
+  schema: 'example',
+})
+```
+
+---
+
 ## Schemas
 
 ### `DeduplicateRequestBody`
@@ -255,3 +529,154 @@ type DeduplicationJob = {
   updatedAt: string // date-time
 }
 ```
+
+### `DetectDuplicatesRequestBody`
+
+```ts
+type DetectDuplicatesRequestBody = {
+  schema: string
+  entity: Record<string, unknown>
+}
+```
+
+### `DetectDuplicatesResponse`
+
+```ts
+type DetectDuplicatesResponse = {
+  matches: Array<{
+    entity: {
+      _id: { ... }
+      _org?: { ... }
+      _schema?: { ... }
+      _created_at?: { ... }
+      _updated_at?: { ... }
+      _created_by?: { ... }
+      created_by?: { ... }
+      _tags?: { ... }
+      _acl?: { ... }
+      _owners?: { ... }
+      type?: { ... }
+    }
+    confidence: number
+    matched_attributes: string[]
+  }>
+}
+```
+
+### `DetectedDuplicateMatch`
+
+```ts
+type DetectedDuplicateMatch = {
+  entity: {
+    _id: string
+    _org?: string
+    _schema?: string
+    _created_at?: string // date-time
+    _updated_at?: string // date-time
+    _created_by?: string | number
+    created_by?: string | number
+    _tags?: string[]
+    _acl?: Record<string, string[]>
+    _owners?: Array<{
+      org_id: { ... }
+      user_id: { ... }
+    }>
+    type?: string
+  }
+  confidence: number
+  matched_attributes: string[]
+}
+```
+
+### `UniquenessCriteriaListResponse`
+
+```ts
+type UniquenessCriteriaListResponse = {
+  items: Array<{
+    id: string // uuid
+    orgId: string
+    schema: string
+    matchRules: Array<{
+      name?: { ... }
+      attributes: { ... }
+      confidence: { ... }
+    }>
+    createdAt: string // date-time
+    updatedAt: string // date-time
+  }>
+}
+```
+
+### `UniquenessCriteria`
+
+Defines what makes an entity of a given schema unique within an organization.
+
+```ts
+type UniquenessCriteria = {
+  id: string // uuid
+  orgId: string
+  schema: string
+  matchRules: Array<{
+    name?: string
+    attributes: Array<{
+      attribute: { ... }
+    }>
+    confidence: number
+  }>
+  createdAt: string // date-time
+  updatedAt: string // date-time
+}
+```
+
+### `MatchRule`
+
+One way to identify the same entity. Evaluated in order; first rule whose attributes are all available and that returns hits wins.
+
+```ts
+type MatchRule = {
+  name?: string
+  attributes: Array<{
+    attribute: string
+  }>
+  confidence: number
+}
+```
+
+### `MatchAttribute`
+
+One attribute participating in a match rule. Wrapped as an object so per-attribute options can be added later.
+
+```ts
+type MatchAttribute = {
+  attribute: string
+}
+```
+
+### `UniquenessCriteriaCreateBody`
+
+```ts
+type UniquenessCriteriaCreateBody = {
+  schema: string
+  matchRules: Array<{
+    name?: string
+    attributes: Array<{
+      attribute: { ... }
+    }>
+    confidence: number
+  }>
+}
+```
+
+### `UniquenessCriteriaUpdateBody`
+
+```ts
+type UniquenessCriteriaUpdateBody = {
+  matchRules: Array<{
+    name?: string
+    attributes: Array<{
+      attribute: { ... }
+    }>
+    confidence: number
+  }>
+}
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.15.11",
+  "version": "2.15.12",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",

package/dist/chunk-X2SC4GW5.js

@@ -1,14 +0,0 @@
-import {
-  __commonJS
-} from "./chunk-YPSWSI3M.js";
-
-// src/definitions/deduplication-runtime.json
-var require_deduplication_runtime = __commonJS({
-  "src/definitions/deduplication-runtime.json"(exports, module) {
-    module.exports = { s: "https://deduplication.sls.epilot.io", o: [["deduplicate", "post", "/v1/deduplicate", null, 1], ["deduplicateAsync", "post", "/v1/deduplicate/job", null, 1], ["getDeduplicationJob", "get", "/v1/deduplicate/jobs/{jobId}", [["jobId", "p", true]]]] };
-  }
-});
-
-export {
-  require_deduplication_runtime
-};

package/dist/deduplication-G2ZY4NMX.js

@@ -1,7 +0,0 @@
-import "./chunk-YPSWSI3M.js";
-
-// src/docs/deduplication.json
-var deduplication_default = '# Deduplication API\n\n- **Base URL:** `https://deduplication.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/deduplication](https://docs.epilot.io/api/deduplication)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.deduplication.deduplicate(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/deduplication\'\n\nconst deduplicationClient = getClient()\nauthorize(deduplicationClient, () => \'<token>\')\nconst { data } = await deduplicationClient.deduplicate(...)\n```\n\n## Operations\n\n- [`deduplicate`](#deduplicate)\n- [`deduplicateAsync`](#deduplicateasync)\n- [`getDeduplicationJob`](#getdeduplicationjob)\n\n**Schemas**\n- [`DeduplicateRequestBody`](#deduplicaterequestbody)\n- [`DeduplicateRequestResponse`](#deduplicaterequestresponse)\n- [`Entity`](#entity)\n- [`DeduplicateAsyncResponse`](#deduplicateasyncresponse)\n- [`JobStatus`](#jobstatus)\n- [`DeduplicationJob`](#deduplicationjob)\n\n### `deduplicate`\n\nDeduplicates Entities\n\n`POST /v1/deduplicate`\n\n```ts\nconst { data } = await client.deduplicate(\n  null,\n  [\n    {\n      toKeep: \'string\',\n      toDelete: [\'string\']\n    }\n  ],\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "_id": "string",\n    "_org": "string",\n    "_schema": "string",\n    "_created_at": "1970-01-01T00:00:00.000Z",\n    "_updated_at": "1970-01-01T00:00:00.000Z",\n    "_created_by": "string",\n    "created_by": "string",\n    "_tags": ["string"],\n    "_acl": {},\n    "_owners": [\n      {\n        "org_id": "string",\n        "user_id": "string"\n      }\n    ],\n    "type": "string"\n  }\n]\n```\n\n</details>\n\n---\n\n### `deduplicateAsync`\n\nSubmits an async deduplication job. Returns a job ID immediately. Poll GET /v1/deduplicate/jobs/{jobId} for status.\n\n`POST /v1/deduplicate/job`\n\n```ts\nconst { data } = await client.deduplicateAsync(\n  null,\n  [\n    {\n      toKeep: \'string\',\n      toDelete: [\'string\']\n    }\n  ],\n)\n```\n\n---\n\n### `getDeduplicationJob`\n\nReturns the current status of an async deduplication job\n\n`GET /v1/deduplicate/jobs/{jobId}`\n\n```ts\nconst { data } = await client.getDeduplicationJob({\n  jobId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "jobId": "string",\n  "status": "pending",\n  "message": "string",\n  "result": [\n    {\n      "_id": "string",\n      "_org": "string",\n      "_schema": "string",\n      "_created_at": "1970-01-01T00:00:00.000Z",\n      "_updated_at": "1970-01-01T00:00:00.000Z",\n      "_created_by": "string",\n      "created_by": "string",\n      "_tags": ["string"],\n      "_acl": {},\n      "_owners": [\n        {\n          "org_id": "string",\n          "user_id": "string"\n        }\n      ],\n      "type": "string"\n    }\n  ],\n  "createdAt": "1970-01-01T00:00:00.000Z",\n  "updatedAt": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `DeduplicateRequestBody`\n\n```ts\ntype DeduplicateRequestBody = Array<{\n  toKeep: string\n  toDelete: string[]\n}>\n```\n\n### `DeduplicateRequestResponse`\n\n```ts\ntype DeduplicateRequestResponse = Array<{\n  _id: string\n  _org?: string\n  _schema?: string\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _created_by?: string | number\n  created_by?: string | number\n  _tags?: string[]\n  _acl?: Record<string, string[]>\n  _owners?: Array<{\n    org_id: string\n    user_id: string\n  }>\n  type?: string\n}>\n```\n\n### `Entity`\n\nBase Entity schema\n\n```ts\ntype Entity = {\n  _id: string\n  _org?: string\n  _schema?: string\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _created_by?: string | number\n  created_by?: string | number\n  _tags?: string[]\n  _acl?: Record<string, string[]>\n  _owners?: Array<{\n    org_id: string\n    user_id: string\n  }>\n  type?: string\n}\n```\n\n### `DeduplicateAsyncResponse`\n\nResponse returned immediately when a deduplication job is submitted\n\n```ts\ntype DeduplicateAsyncResponse = {\n  jobId: string\n  status: "pending" | "processing" | "completed" | "failed"\n  message: string\n}\n```\n\n### `JobStatus`\n\n```ts\ntype JobStatus = "pending" | "processing" | "completed" | "failed"\n```\n\n### `DeduplicationJob`\n\nRepresents an async deduplication job\n\n```ts\ntype DeduplicationJob = {\n  jobId: string\n  status: "pending" | "processing" | "completed" | "failed"\n  message?: string\n  result?: Array<{\n    _id: string\n    _org?: string\n    _schema?: string\n    _created_at?: string // date-time\n    _updated_at?: string // date-time\n    _created_by?: string | number\n    created_by?: string | number\n    _tags?: string[]\n    _acl?: Record<string, string[]>\n    _owners?: Array<{\n      org_id: { ... }\n      user_id: { ... }\n    }>\n    type?: string\n  }>\n  createdAt: string // date-time\n  updatedAt: string // date-time\n}\n```\n';
-export {
-  deduplication_default as default
-};

package/dist/deduplication-PKKTZAEA.cjs

@@ -1,7 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
-
-// src/docs/deduplication.json
-var deduplication_default = '# Deduplication API\n\n- **Base URL:** `https://deduplication.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/deduplication](https://docs.epilot.io/api/deduplication)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.deduplication.deduplicate(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/deduplication\'\n\nconst deduplicationClient = getClient()\nauthorize(deduplicationClient, () => \'<token>\')\nconst { data } = await deduplicationClient.deduplicate(...)\n```\n\n## Operations\n\n- [`deduplicate`](#deduplicate)\n- [`deduplicateAsync`](#deduplicateasync)\n- [`getDeduplicationJob`](#getdeduplicationjob)\n\n**Schemas**\n- [`DeduplicateRequestBody`](#deduplicaterequestbody)\n- [`DeduplicateRequestResponse`](#deduplicaterequestresponse)\n- [`Entity`](#entity)\n- [`DeduplicateAsyncResponse`](#deduplicateasyncresponse)\n- [`JobStatus`](#jobstatus)\n- [`DeduplicationJob`](#deduplicationjob)\n\n### `deduplicate`\n\nDeduplicates Entities\n\n`POST /v1/deduplicate`\n\n```ts\nconst { data } = await client.deduplicate(\n  null,\n  [\n    {\n      toKeep: \'string\',\n      toDelete: [\'string\']\n    }\n  ],\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "_id": "string",\n    "_org": "string",\n    "_schema": "string",\n    "_created_at": "1970-01-01T00:00:00.000Z",\n    "_updated_at": "1970-01-01T00:00:00.000Z",\n    "_created_by": "string",\n    "created_by": "string",\n    "_tags": ["string"],\n    "_acl": {},\n    "_owners": [\n      {\n        "org_id": "string",\n        "user_id": "string"\n      }\n    ],\n    "type": "string"\n  }\n]\n```\n\n</details>\n\n---\n\n### `deduplicateAsync`\n\nSubmits an async deduplication job. Returns a job ID immediately. Poll GET /v1/deduplicate/jobs/{jobId} for status.\n\n`POST /v1/deduplicate/job`\n\n```ts\nconst { data } = await client.deduplicateAsync(\n  null,\n  [\n    {\n      toKeep: \'string\',\n      toDelete: [\'string\']\n    }\n  ],\n)\n```\n\n---\n\n### `getDeduplicationJob`\n\nReturns the current status of an async deduplication job\n\n`GET /v1/deduplicate/jobs/{jobId}`\n\n```ts\nconst { data } = await client.getDeduplicationJob({\n  jobId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "jobId": "string",\n  "status": "pending",\n  "message": "string",\n  "result": [\n    {\n      "_id": "string",\n      "_org": "string",\n      "_schema": "string",\n      "_created_at": "1970-01-01T00:00:00.000Z",\n      "_updated_at": "1970-01-01T00:00:00.000Z",\n      "_created_by": "string",\n      "created_by": "string",\n      "_tags": ["string"],\n      "_acl": {},\n      "_owners": [\n        {\n          "org_id": "string",\n          "user_id": "string"\n        }\n      ],\n      "type": "string"\n    }\n  ],\n  "createdAt": "1970-01-01T00:00:00.000Z",\n  "updatedAt": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `DeduplicateRequestBody`\n\n```ts\ntype DeduplicateRequestBody = Array<{\n  toKeep: string\n  toDelete: string[]\n}>\n```\n\n### `DeduplicateRequestResponse`\n\n```ts\ntype DeduplicateRequestResponse = Array<{\n  _id: string\n  _org?: string\n  _schema?: string\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _created_by?: string | number\n  created_by?: string | number\n  _tags?: string[]\n  _acl?: Record<string, string[]>\n  _owners?: Array<{\n    org_id: string\n    user_id: string\n  }>\n  type?: string\n}>\n```\n\n### `Entity`\n\nBase Entity schema\n\n```ts\ntype Entity = {\n  _id: string\n  _org?: string\n  _schema?: string\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _created_by?: string | number\n  created_by?: string | number\n  _tags?: string[]\n  _acl?: Record<string, string[]>\n  _owners?: Array<{\n    org_id: string\n    user_id: string\n  }>\n  type?: string\n}\n```\n\n### `DeduplicateAsyncResponse`\n\nResponse returned immediately when a deduplication job is submitted\n\n```ts\ntype DeduplicateAsyncResponse = {\n  jobId: string\n  status: "pending" | "processing" | "completed" | "failed"\n  message: string\n}\n```\n\n### `JobStatus`\n\n```ts\ntype JobStatus = "pending" | "processing" | "completed" | "failed"\n```\n\n### `DeduplicationJob`\n\nRepresents an async deduplication job\n\n```ts\ntype DeduplicationJob = {\n  jobId: string\n  status: "pending" | "processing" | "completed" | "failed"\n  message?: string\n  result?: Array<{\n    _id: string\n    _org?: string\n    _schema?: string\n    _created_at?: string // date-time\n    _updated_at?: string // date-time\n    _created_by?: string | number\n    created_by?: string | number\n    _tags?: string[]\n    _acl?: Record<string, string[]>\n    _owners?: Array<{\n      org_id: { ... }\n      user_id: { ... }\n    }>\n    type?: string\n  }>\n  createdAt: string // date-time\n  updatedAt: string // date-time\n}\n```\n';
-
-
-exports.default = deduplication_default;