@epilot/sdk 2.15.11 → 2.15.13

package/docs/app.md

@@ -1314,6 +1314,7 @@ const { data } = await client.listInstallations({
       "owner_org_id": "string",
       "enabled": true,
       "name": "string",
+      "icon_url": "string",
       "option_values": [
         {
           "component_id": "string",
@@ -1394,6 +1395,7 @@ const { data } = await client.getInstallation({
   "owner_org_id": "string",
   "enabled": true,
   "name": "string",
+  "icon_url": "string",
   "option_values": [
     {
       "component_id": "string",
@@ -1484,6 +1486,7 @@ const { data } = await client.install(
   "owner_org_id": "string",
   "enabled": true,
   "name": "string",
+  "icon_url": "string",
   "option_values": [
     {
       "component_id": "string",
@@ -1603,6 +1606,7 @@ const { data } = await client.promoteVersion({
   "owner_org_id": "string",
   "enabled": true,
   "name": "string",
+  "icon_url": "string",
   "option_values": [
     {
       "component_id": "string",
@@ -3418,6 +3422,7 @@ type Installation = {
   owner_org_id?: string
   enabled: boolean
   name: string
+  icon_url?: string
   option_values?: Array<{
     component_id: string
     options: Array<{

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.13",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",