@epilot/sdk 2.17.0 → 2.18.0

package/docs/integration-toolkit.md

@@ -220,6 +220,8 @@ const { data } = await integrationToolkitClient.acknowledgeTracking(...)
 - [`MappingSimulationWarning`](#mappingsimulationwarning)
 - [`EntityUpdate`](#entityupdate)
 - [`MeterReadingUpdate`](#meterreadingupdate)
+- [`EntityPruneScopeUpdate`](#entityprunescopeupdate)
+- [`MeterReadingPruneScopeUpdate`](#meterreadingprunescopeupdate)
 - [`IntegrationConfigurationV1`](#integrationconfigurationv1)
 - [`IntegrationObjectV1`](#integrationobjectv1)
 - [`IntegrationFieldV1`](#integrationfieldv1)
@@ -424,7 +426,14 @@ const { data } = await client.simulateMappingV2(
     {
       "entity_slug": "string",
       "unique_identifiers": {},
-      "attributes": {}
+      "attributes": {},
+      "pricing": {
+        "config": {},
+        "data": [
+          {}
+        ]
+      },
+      "mode": "upsert"
     }
   ],
   "meter_readings_updates": [
@@ -435,7 +444,35 @@ const { data } = await client.simulateMappingV2(
       "meter_counter": {
         "$entity_unique_ids": {}
       },
-      "attributes": {}
+      "attributes": {},
+      "mode": "upsert"
+    }
+  ],
+  "prune_scope_updates": [
+    {
+      "entity_slug": "string",
+      "scope": {
+        "scope_mode": "relations",
+        "schema": "string",
+        "unique_ids": {},
+        "query": {}
+      },
+      "keep_unique_ids": [
+        {}
+      ],
+      "deletion_mode": "delete"
+    }
+  ],
+  "meter_readings_prune_scope_updates": [
+    {
+      "meter": {
+        "$entity_unique_ids": {}
+      },
+      "meter_counter": {
+        "$entity_unique_ids": {}
+      },
+      "keep_external_ids": ["string"],
+      "source": "string"
     }
   ],
   "warnings": [
@@ -484,7 +521,14 @@ const { data } = await client.simulateMapping(
     {
       "entity_slug": "string",
       "unique_identifiers": {},
-      "attributes": {}
+      "attributes": {},
+      "pricing": {
+        "config": {},
+        "data": [
+          {}
+        ]
+      },
+      "mode": "upsert"
     }
   ],
   "meter_readings_updates": [
@@ -495,7 +539,35 @@ const { data } = await client.simulateMapping(
       "meter_counter": {
         "$entity_unique_ids": {}
       },
-      "attributes": {}
+      "attributes": {},
+      "mode": "upsert"
+    }
+  ],
+  "prune_scope_updates": [
+    {
+      "entity_slug": "string",
+      "scope": {
+        "scope_mode": "relations",
+        "schema": "string",
+        "unique_ids": {},
+        "query": {}
+      },
+      "keep_unique_ids": [
+        {}
+      ],
+      "deletion_mode": "delete"
+    }
+  ],
+  "meter_readings_prune_scope_updates": [
+    {
+      "meter": {
+        "$entity_unique_ids": {}
+      },
+      "meter_counter": {
+        "$entity_unique_ids": {}
+      },
+      "keep_external_ids": ["string"],
+      "source": "string"
     }
   ],
   "warnings": [
@@ -6933,6 +7005,11 @@ type MappingSimulationResponse = {
     entity_slug: string
     unique_identifiers: Record<string, unknown>
     attributes: Record<string, unknown>
+    pricing?: {
+      config: { ... }
+      data: { ... }
+    }
+    mode: "upsert" | "delete" | "purge"
   }>
   meter_readings_updates?: Array<{
     meter: {
@@ -6942,6 +7019,28 @@ type MappingSimulationResponse = {
       $entity_unique_ids?: { ... }
     }
     attributes: Record<string, unknown>
+    mode: "upsert" | "delete"
+  }>
+  prune_scope_updates?: Array<{
+    entity_slug: string
+    scope: {
+      scope_mode: { ... }
+      schema?: { ... }
+      unique_ids?: { ... }
+      query?: { ... }
+    }
+    keep_unique_ids: Record<string, unknown>[]
+    deletion_mode: "delete" | "purge"
+  }>
+  meter_readings_prune_scope_updates?: Array<{
+    meter: {
+      $entity_unique_ids: { ... }
+    }
+    meter_counter?: {
+      $entity_unique_ids?: { ... }
+    }
+    keep_external_ids: string[]
+    source?: string
   }>
   warnings?: Array<{
     entity_schema: string
@@ -6968,6 +7067,11 @@ type EntityUpdate = {
   entity_slug: string
   unique_identifiers: Record<string, unknown>
   attributes: Record<string, unknown>
+  pricing?: {
+    config: Record<string, unknown>
+    data: Record<string, unknown>[]
+  }
+  mode: "upsert" | "delete" | "purge"
 }
 ```
 
@@ -6982,6 +7086,42 @@ type MeterReadingUpdate = {
     $entity_unique_ids?: Record<string, unknown>
   }
   attributes: Record<string, unknown>
+  mode: "upsert" | "delete"
+}
+```
+
+### `EntityPruneScopeUpdate`
+
+A resolved entity prune scope. At runtime, entities of `entity_slug` found within `scope` whose unique identifiers are not listed in `keep_unique_ids` are removed using `deletion_mode`.
+
+```ts
+type EntityPruneScopeUpdate = {
+  entity_slug: string
+  scope: {
+    scope_mode: "relations" | "query"
+    schema?: string
+    unique_ids?: Record<string, unknown>
+    query?: Record<string, unknown>
+  }
+  keep_unique_ids: Record<string, unknown>[]
+  deletion_mode: "delete" | "purge"
+}
+```
+
+### `MeterReadingPruneScopeUpdate`
+
+A resolved meter reading prune scope. At runtime, readings of the given meter (+ counter) whose external ids are not listed in `keep_external_ids` are deleted.
+
+```ts
+type MeterReadingPruneScopeUpdate = {
+  meter: {
+    $entity_unique_ids: Record<string, unknown>
+  }
+  meter_counter?: {
+    $entity_unique_ids?: Record<string, unknown>
+  }
+  keep_external_ids: string[]
+  source?: string
 }
 ```
 

package/package.json

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

package/dist/deduplication-XYMFEQEE.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- [`detectDuplicates`](#detectduplicates)\n- [`listUniquenessCriteria`](#listuniquenesscriteria)\n- [`createUniquenessCriteria`](#createuniquenesscriteria)\n- [`getUniquenessCriteria`](#getuniquenesscriteria)\n- [`updateUniquenessCriteria`](#updateuniquenesscriteria)\n- [`deleteUniquenessCriteria`](#deleteuniquenesscriteria)\n\n**Schemas**\n- [`DeduplicateRequestBody`](#deduplicaterequestbody)\n- [`DeduplicateRequestResponse`](#deduplicaterequestresponse)\n- [`Entity`](#entity)\n- [`DeduplicateAsyncResponse`](#deduplicateasyncresponse)\n- [`JobStatus`](#jobstatus)\n- [`DeduplicationJob`](#deduplicationjob)\n- [`DetectDuplicatesRequestBody`](#detectduplicatesrequestbody)\n- [`DetectDuplicatesResponse`](#detectduplicatesresponse)\n- [`DetectedDuplicateMatch`](#detectedduplicatematch)\n- [`UniquenessCriteriaListResponse`](#uniquenesscriterialistresponse)\n- [`UniquenessCriteria`](#uniquenesscriteria)\n- [`MatchRule`](#matchrule)\n- [`MatchAttribute`](#matchattribute)\n- [`UniquenessCriteriaCreateBody`](#uniquenesscriteriacreatebody)\n- [`UniquenessCriteriaUpdateBody`](#uniquenesscriteriaupdatebody)\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### `detectDuplicates`\n\nDetects potential duplicate entities for the given entity using the schema\'s prioritized uniqueness rules. Returns matches with a confidence score.\n\n`POST /v1/detect-duplicates`\n\n```ts\nconst { data } = await client.detectDuplicates(\n  null,\n  {\n    schema: \'string\',\n    entity: {}\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "matches": [\n    {\n      "entity": {\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      "confidence": 0,\n      "matched_attributes": ["string"]\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `listUniquenessCriteria`\n\nLists UniquenessCriteria for the requesting organization. Optionally filtered by schema.\n\n`GET /v1/uniqueness-criteria`\n\n```ts\nconst { data } = await client.listUniquenessCriteria({\n  schema: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "items": [\n    {\n      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "orgId": "string",\n      "schema": "string",\n      "matchRules": [\n        {\n          "name": "string",\n          "attributes": [\n            {\n              "attribute": "string"\n            }\n          ],\n          "confidence": 0\n        }\n      ],\n      "createdAt": "1970-01-01T00:00:00.000Z",\n      "updatedAt": "1970-01-01T00:00:00.000Z"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createUniquenessCriteria`\n\nCreates a new UniquenessCriteria record.\n\n`POST /v1/uniqueness-criteria`\n\n```ts\nconst { data } = await client.createUniquenessCriteria(\n  null,\n  {\n    schema: \'string\',\n    matchRules: [\n      {\n        name: \'string\',\n        attributes: [\n          {\n            attribute: \'string\'\n          }\n        ],\n        confidence: 0\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "orgId": "string",\n  "schema": "string",\n  "matchRules": [\n    {\n      "name": "string",\n      "attributes": [\n        {\n          "attribute": "string"\n        }\n      ],\n      "confidence": 0\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### `getUniquenessCriteria`\n\nFetch a single UniquenessCriteria record.\n\n`GET /v1/uniqueness-criteria/{schema}`\n\n```ts\nconst { data } = await client.getUniquenessCriteria({\n  schema: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "orgId": "string",\n  "schema": "string",\n  "matchRules": [\n    {\n      "name": "string",\n      "attributes": [\n        {\n          "attribute": "string"\n        }\n      ],\n      "confidence": 0\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### `updateUniquenessCriteria`\n\nReplace the matchRules on an existing UniquenessCriteria record.\n\n`PUT /v1/uniqueness-criteria/{schema}`\n\n```ts\nconst { data } = await client.updateUniquenessCriteria(\n  {\n    schema: \'example\',\n  },\n  {\n    matchRules: [\n      {\n        name: \'string\',\n        attributes: [\n          {\n            attribute: \'string\'\n          }\n        ],\n        confidence: 0\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "orgId": "string",\n  "schema": "string",\n  "matchRules": [\n    {\n      "name": "string",\n      "attributes": [\n        {\n          "attribute": "string"\n        }\n      ],\n      "confidence": 0\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### `deleteUniquenessCriteria`\n\nDelete a UniquenessCriteria record.\n\n`DELETE /v1/uniqueness-criteria/{schema}`\n\n```ts\nconst { data } = await client.deleteUniquenessCriteria({\n  schema: \'example\',\n})\n```\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\n### `DetectDuplicatesRequestBody`\n\n```ts\ntype DetectDuplicatesRequestBody = {\n  schema: string\n  entity: Record<string, unknown>\n}\n```\n\n### `DetectDuplicatesResponse`\n\n```ts\ntype DetectDuplicatesResponse = {\n  matches: Array<{\n    entity: {\n      _id: { ... }\n      _org?: { ... }\n      _schema?: { ... }\n      _created_at?: { ... }\n      _updated_at?: { ... }\n      _created_by?: { ... }\n      created_by?: { ... }\n      _tags?: { ... }\n      _acl?: { ... }\n      _owners?: { ... }\n      type?: { ... }\n    }\n    confidence: number\n    matched_attributes: string[]\n  }>\n}\n```\n\n### `DetectedDuplicateMatch`\n\n```ts\ntype DetectedDuplicateMatch = {\n  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: { ... }\n      user_id: { ... }\n    }>\n    type?: string\n  }\n  confidence: number\n  matched_attributes: string[]\n}\n```\n\n### `UniquenessCriteriaListResponse`\n\n```ts\ntype UniquenessCriteriaListResponse = {\n  items: Array<{\n    id: string // uuid\n    orgId: string\n    schema: string\n    matchRules: Array<{\n      name?: { ... }\n      attributes: { ... }\n      confidence: { ... }\n    }>\n    createdAt: string // date-time\n    updatedAt: string // date-time\n  }>\n}\n```\n\n### `UniquenessCriteria`\n\nDefines what makes an entity of a given schema unique within an organization.\n\n```ts\ntype UniquenessCriteria = {\n  id: string // uuid\n  orgId: string\n  schema: string\n  matchRules: Array<{\n    name?: string\n    attributes: Array<{\n      attribute: { ... }\n    }>\n    confidence: number\n  }>\n  createdAt: string // date-time\n  updatedAt: string // date-time\n}\n```\n\n### `MatchRule`\n\nOne way to identify the same entity. Evaluated in order; first rule whose attributes are all available and that returns hits wins.\n\n```ts\ntype MatchRule = {\n  name?: string\n  attributes: Array<{\n    attribute: string\n  }>\n  confidence: number\n}\n```\n\n### `MatchAttribute`\n\nOne attribute participating in a match rule. Wrapped as an object so per-attribute options can be added later.\n\n```ts\ntype MatchAttribute = {\n  attribute: string\n}\n```\n\n### `UniquenessCriteriaCreateBody`\n\n```ts\ntype UniquenessCriteriaCreateBody = {\n  schema: string\n  matchRules: Array<{\n    name?: string\n    attributes: Array<{\n      attribute: { ... }\n    }>\n    confidence: number\n  }>\n}\n```\n\n### `UniquenessCriteriaUpdateBody`\n\n```ts\ntype UniquenessCriteriaUpdateBody = {\n  matchRules: Array<{\n    name?: string\n    attributes: Array<{\n      attribute: { ... }\n    }>\n    confidence: number\n  }>\n}\n```\n';
-
-
-exports.default = deduplication_default;

package/dist/deduplication-YYNT5C3M.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- [`detectDuplicates`](#detectduplicates)\n- [`listUniquenessCriteria`](#listuniquenesscriteria)\n- [`createUniquenessCriteria`](#createuniquenesscriteria)\n- [`getUniquenessCriteria`](#getuniquenesscriteria)\n- [`updateUniquenessCriteria`](#updateuniquenesscriteria)\n- [`deleteUniquenessCriteria`](#deleteuniquenesscriteria)\n\n**Schemas**\n- [`DeduplicateRequestBody`](#deduplicaterequestbody)\n- [`DeduplicateRequestResponse`](#deduplicaterequestresponse)\n- [`Entity`](#entity)\n- [`DeduplicateAsyncResponse`](#deduplicateasyncresponse)\n- [`JobStatus`](#jobstatus)\n- [`DeduplicationJob`](#deduplicationjob)\n- [`DetectDuplicatesRequestBody`](#detectduplicatesrequestbody)\n- [`DetectDuplicatesResponse`](#detectduplicatesresponse)\n- [`DetectedDuplicateMatch`](#detectedduplicatematch)\n- [`UniquenessCriteriaListResponse`](#uniquenesscriterialistresponse)\n- [`UniquenessCriteria`](#uniquenesscriteria)\n- [`MatchRule`](#matchrule)\n- [`MatchAttribute`](#matchattribute)\n- [`UniquenessCriteriaCreateBody`](#uniquenesscriteriacreatebody)\n- [`UniquenessCriteriaUpdateBody`](#uniquenesscriteriaupdatebody)\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### `detectDuplicates`\n\nDetects potential duplicate entities for the given entity using the schema\'s prioritized uniqueness rules. Returns matches with a confidence score.\n\n`POST /v1/detect-duplicates`\n\n```ts\nconst { data } = await client.detectDuplicates(\n  null,\n  {\n    schema: \'string\',\n    entity: {}\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "matches": [\n    {\n      "entity": {\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      "confidence": 0,\n      "matched_attributes": ["string"]\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `listUniquenessCriteria`\n\nLists UniquenessCriteria for the requesting organization. Optionally filtered by schema.\n\n`GET /v1/uniqueness-criteria`\n\n```ts\nconst { data } = await client.listUniquenessCriteria({\n  schema: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "items": [\n    {\n      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "orgId": "string",\n      "schema": "string",\n      "matchRules": [\n        {\n          "name": "string",\n          "attributes": [\n            {\n              "attribute": "string"\n            }\n          ],\n          "confidence": 0\n        }\n      ],\n      "createdAt": "1970-01-01T00:00:00.000Z",\n      "updatedAt": "1970-01-01T00:00:00.000Z"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createUniquenessCriteria`\n\nCreates a new UniquenessCriteria record.\n\n`POST /v1/uniqueness-criteria`\n\n```ts\nconst { data } = await client.createUniquenessCriteria(\n  null,\n  {\n    schema: \'string\',\n    matchRules: [\n      {\n        name: \'string\',\n        attributes: [\n          {\n            attribute: \'string\'\n          }\n        ],\n        confidence: 0\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "orgId": "string",\n  "schema": "string",\n  "matchRules": [\n    {\n      "name": "string",\n      "attributes": [\n        {\n          "attribute": "string"\n        }\n      ],\n      "confidence": 0\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### `getUniquenessCriteria`\n\nFetch a single UniquenessCriteria record.\n\n`GET /v1/uniqueness-criteria/{schema}`\n\n```ts\nconst { data } = await client.getUniquenessCriteria({\n  schema: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "orgId": "string",\n  "schema": "string",\n  "matchRules": [\n    {\n      "name": "string",\n      "attributes": [\n        {\n          "attribute": "string"\n        }\n      ],\n      "confidence": 0\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### `updateUniquenessCriteria`\n\nReplace the matchRules on an existing UniquenessCriteria record.\n\n`PUT /v1/uniqueness-criteria/{schema}`\n\n```ts\nconst { data } = await client.updateUniquenessCriteria(\n  {\n    schema: \'example\',\n  },\n  {\n    matchRules: [\n      {\n        name: \'string\',\n        attributes: [\n          {\n            attribute: \'string\'\n          }\n        ],\n        confidence: 0\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "orgId": "string",\n  "schema": "string",\n  "matchRules": [\n    {\n      "name": "string",\n      "attributes": [\n        {\n          "attribute": "string"\n        }\n      ],\n      "confidence": 0\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### `deleteUniquenessCriteria`\n\nDelete a UniquenessCriteria record.\n\n`DELETE /v1/uniqueness-criteria/{schema}`\n\n```ts\nconst { data } = await client.deleteUniquenessCriteria({\n  schema: \'example\',\n})\n```\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\n### `DetectDuplicatesRequestBody`\n\n```ts\ntype DetectDuplicatesRequestBody = {\n  schema: string\n  entity: Record<string, unknown>\n}\n```\n\n### `DetectDuplicatesResponse`\n\n```ts\ntype DetectDuplicatesResponse = {\n  matches: Array<{\n    entity: {\n      _id: { ... }\n      _org?: { ... }\n      _schema?: { ... }\n      _created_at?: { ... }\n      _updated_at?: { ... }\n      _created_by?: { ... }\n      created_by?: { ... }\n      _tags?: { ... }\n      _acl?: { ... }\n      _owners?: { ... }\n      type?: { ... }\n    }\n    confidence: number\n    matched_attributes: string[]\n  }>\n}\n```\n\n### `DetectedDuplicateMatch`\n\n```ts\ntype DetectedDuplicateMatch = {\n  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: { ... }\n      user_id: { ... }\n    }>\n    type?: string\n  }\n  confidence: number\n  matched_attributes: string[]\n}\n```\n\n### `UniquenessCriteriaListResponse`\n\n```ts\ntype UniquenessCriteriaListResponse = {\n  items: Array<{\n    id: string // uuid\n    orgId: string\n    schema: string\n    matchRules: Array<{\n      name?: { ... }\n      attributes: { ... }\n      confidence: { ... }\n    }>\n    createdAt: string // date-time\n    updatedAt: string // date-time\n  }>\n}\n```\n\n### `UniquenessCriteria`\n\nDefines what makes an entity of a given schema unique within an organization.\n\n```ts\ntype UniquenessCriteria = {\n  id: string // uuid\n  orgId: string\n  schema: string\n  matchRules: Array<{\n    name?: string\n    attributes: Array<{\n      attribute: { ... }\n    }>\n    confidence: number\n  }>\n  createdAt: string // date-time\n  updatedAt: string // date-time\n}\n```\n\n### `MatchRule`\n\nOne way to identify the same entity. Evaluated in order; first rule whose attributes are all available and that returns hits wins.\n\n```ts\ntype MatchRule = {\n  name?: string\n  attributes: Array<{\n    attribute: string\n  }>\n  confidence: number\n}\n```\n\n### `MatchAttribute`\n\nOne attribute participating in a match rule. Wrapped as an object so per-attribute options can be added later.\n\n```ts\ntype MatchAttribute = {\n  attribute: string\n}\n```\n\n### `UniquenessCriteriaCreateBody`\n\n```ts\ntype UniquenessCriteriaCreateBody = {\n  schema: string\n  matchRules: Array<{\n    name?: string\n    attributes: Array<{\n      attribute: { ... }\n    }>\n    confidence: number\n  }>\n}\n```\n\n### `UniquenessCriteriaUpdateBody`\n\n```ts\ntype UniquenessCriteriaUpdateBody = {\n  matchRules: Array<{\n    name?: string\n    attributes: Array<{\n      attribute: { ... }\n    }>\n    confidence: number\n  }>\n}\n```\n';
-export {
-  deduplication_default as default
-};