@epilot/sdk 2.17.0 → 2.17.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (129) hide show
  1. package/definitions/deduplication-runtime.json +1 -1
  2. package/definitions/deduplication.json +80 -4
  3. package/dist/apis/access-token.cjs +6 -6
  4. package/dist/apis/access-token.js +1 -1
  5. package/dist/apis/address-suggestions.cjs +6 -6
  6. package/dist/apis/address-suggestions.js +1 -1
  7. package/dist/apis/address.cjs +6 -6
  8. package/dist/apis/address.js +1 -1
  9. package/dist/apis/ai-agents.cjs +6 -6
  10. package/dist/apis/ai-agents.js +1 -1
  11. package/dist/apis/app.cjs +6 -6
  12. package/dist/apis/app.js +1 -1
  13. package/dist/apis/audit-logs.cjs +6 -6
  14. package/dist/apis/audit-logs.js +1 -1
  15. package/dist/apis/automation.cjs +6 -6
  16. package/dist/apis/automation.js +1 -1
  17. package/dist/apis/billing.cjs +6 -6
  18. package/dist/apis/billing.js +1 -1
  19. package/dist/apis/blueprint-manifest.cjs +6 -6
  20. package/dist/apis/blueprint-manifest.js +1 -1
  21. package/dist/apis/calendar.cjs +6 -6
  22. package/dist/apis/calendar.js +1 -1
  23. package/dist/apis/configuration-hub.cjs +6 -6
  24. package/dist/apis/configuration-hub.js +1 -1
  25. package/dist/apis/consent.cjs +6 -6
  26. package/dist/apis/consent.js +1 -1
  27. package/dist/apis/customer-portal.cjs +6 -6
  28. package/dist/apis/customer-portal.js +1 -1
  29. package/dist/apis/dashboard.cjs +6 -6
  30. package/dist/apis/dashboard.js +1 -1
  31. package/dist/apis/data-governance.cjs +6 -6
  32. package/dist/apis/data-governance.js +1 -1
  33. package/dist/apis/deduplication.cjs +8 -8
  34. package/dist/apis/deduplication.d.cts +2 -2
  35. package/dist/apis/deduplication.d.ts +2 -2
  36. package/dist/apis/deduplication.js +2 -2
  37. package/dist/apis/design.cjs +6 -6
  38. package/dist/apis/design.js +1 -1
  39. package/dist/apis/document.cjs +6 -6
  40. package/dist/apis/document.js +1 -1
  41. package/dist/apis/email-settings.cjs +6 -6
  42. package/dist/apis/email-settings.js +1 -1
  43. package/dist/apis/email-template.cjs +6 -6
  44. package/dist/apis/email-template.js +1 -1
  45. package/dist/apis/entity-mapping.cjs +6 -6
  46. package/dist/apis/entity-mapping.js +1 -1
  47. package/dist/apis/entity.cjs +6 -6
  48. package/dist/apis/entity.js +1 -1
  49. package/dist/apis/environments.cjs +6 -6
  50. package/dist/apis/environments.js +1 -1
  51. package/dist/apis/event-catalog.cjs +6 -6
  52. package/dist/apis/event-catalog.js +1 -1
  53. package/dist/apis/file.cjs +6 -6
  54. package/dist/apis/file.js +1 -1
  55. package/dist/apis/iban.cjs +6 -6
  56. package/dist/apis/iban.js +1 -1
  57. package/dist/apis/integration-toolkit.cjs +6 -6
  58. package/dist/apis/integration-toolkit.js +1 -1
  59. package/dist/apis/journey.cjs +6 -6
  60. package/dist/apis/journey.js +1 -1
  61. package/dist/apis/kanban.cjs +6 -6
  62. package/dist/apis/kanban.js +1 -1
  63. package/dist/apis/message.cjs +6 -6
  64. package/dist/apis/message.js +1 -1
  65. package/dist/apis/metering.cjs +6 -6
  66. package/dist/apis/metering.js +1 -1
  67. package/dist/apis/notes.cjs +6 -6
  68. package/dist/apis/notes.js +1 -1
  69. package/dist/apis/notification.cjs +6 -6
  70. package/dist/apis/notification.js +1 -1
  71. package/dist/apis/organization.cjs +6 -6
  72. package/dist/apis/organization.js +1 -1
  73. package/dist/apis/partner-directory.cjs +6 -6
  74. package/dist/apis/partner-directory.js +1 -1
  75. package/dist/apis/permissions.cjs +6 -6
  76. package/dist/apis/permissions.js +1 -1
  77. package/dist/apis/pricing-tier.cjs +6 -6
  78. package/dist/apis/pricing-tier.js +1 -1
  79. package/dist/apis/pricing.cjs +6 -6
  80. package/dist/apis/pricing.js +1 -1
  81. package/dist/apis/purpose.cjs +6 -6
  82. package/dist/apis/purpose.js +1 -1
  83. package/dist/apis/query.cjs +6 -6
  84. package/dist/apis/query.js +1 -1
  85. package/dist/apis/sandbox.cjs +6 -6
  86. package/dist/apis/sandbox.js +1 -1
  87. package/dist/apis/sharing.cjs +6 -6
  88. package/dist/apis/sharing.js +1 -1
  89. package/dist/apis/snapshot.cjs +6 -6
  90. package/dist/apis/snapshot.js +1 -1
  91. package/dist/apis/submission.cjs +6 -6
  92. package/dist/apis/submission.js +1 -1
  93. package/dist/apis/target.cjs +6 -6
  94. package/dist/apis/target.js +1 -1
  95. package/dist/apis/targeting.cjs +6 -6
  96. package/dist/apis/targeting.js +1 -1
  97. package/dist/apis/template-variables.cjs +6 -6
  98. package/dist/apis/template-variables.js +1 -1
  99. package/dist/apis/user.cjs +6 -6
  100. package/dist/apis/user.js +1 -1
  101. package/dist/apis/validation-rules.cjs +6 -6
  102. package/dist/apis/validation-rules.js +1 -1
  103. package/dist/apis/webhooks.cjs +6 -6
  104. package/dist/apis/webhooks.js +1 -1
  105. package/dist/apis/workflow-definition.cjs +6 -6
  106. package/dist/apis/workflow-definition.js +1 -1
  107. package/dist/apis/workflow.cjs +6 -6
  108. package/dist/apis/workflow.js +1 -1
  109. package/dist/{chunk-TNIQ67SK.cjs → chunk-56SO5YDQ.cjs} +2 -2
  110. package/dist/{chunk-CKD3HAHW.js → chunk-5B7KMWW3.js} +1 -1
  111. package/dist/{chunk-TWI3P2QA.cjs → chunk-BEJ5NIRC.cjs} +1 -1
  112. package/dist/{chunk-VJKGGDHF.js → chunk-OGOMIUCZ.js} +2 -2
  113. package/dist/deduplication-FFW7L6P5.cjs +7 -0
  114. package/dist/deduplication-JNS7SSUR.js +7 -0
  115. package/dist/{deduplication-runtime-5TJHUSQN.js → deduplication-runtime-52CD6PA3.js} +1 -1
  116. package/dist/{deduplication-runtime-ZKX6LN5P.cjs → deduplication-runtime-FU24WISY.cjs} +2 -2
  117. package/dist/{deduplication.d-DaUo5gZo.d.ts → deduplication.d-Cueh8bDD.d.cts} +151 -2
  118. package/dist/{deduplication.d-DaUo5gZo.d.cts → deduplication.d-Cueh8bDD.d.ts} +151 -2
  119. package/dist/index.cjs +10 -10
  120. package/dist/index.d.cts +1 -1
  121. package/dist/index.d.ts +1 -1
  122. package/dist/index.js +2 -2
  123. package/dist/js-yaml-DLCVPJ7G.js +0 -0
  124. package/docs/deduplication.md +88 -35
  125. package/package.json +11 -12
  126. package/definitions/focus-pocus-runtime.json +0 -1
  127. package/definitions/focus-pocus.json +0 -757
  128. package/dist/deduplication-XYMFEQEE.cjs +0 -7
  129. package/dist/deduplication-YYNT5C3M.js +0 -7
@@ -1,7 +0,0 @@
1
- "use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
2
-
3
- // src/docs/deduplication.json
4
- 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';
5
-
6
-
7
- exports.default = deduplication_default;
@@ -1,7 +0,0 @@
1
- import "./chunk-YPSWSI3M.js";
2
-
3
- // src/docs/deduplication.json
4
- 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';
5
- export {
6
- deduplication_default as default
7
- };