@epilot/sdk 2.20.23 → 2.20.25

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 (233) hide show
  1. package/dist/apis/access-token.cjs +6 -6
  2. package/dist/apis/access-token.js +1 -1
  3. package/dist/apis/address-suggestions.cjs +6 -6
  4. package/dist/apis/address-suggestions.js +1 -1
  5. package/dist/apis/address.cjs +6 -6
  6. package/dist/apis/address.js +1 -1
  7. package/dist/apis/ai-agents.cjs +6 -6
  8. package/dist/apis/ai-agents.js +1 -1
  9. package/dist/apis/app.cjs +6 -6
  10. package/dist/apis/app.js +1 -1
  11. package/dist/apis/audit-logs.cjs +6 -6
  12. package/dist/apis/audit-logs.js +1 -1
  13. package/dist/apis/automation.cjs +6 -6
  14. package/dist/apis/automation.js +1 -1
  15. package/dist/apis/billing.cjs +6 -6
  16. package/dist/apis/billing.js +1 -1
  17. package/dist/apis/blueprint-manifest.cjs +6 -6
  18. package/dist/apis/blueprint-manifest.js +1 -1
  19. package/dist/apis/calendar.cjs +6 -6
  20. package/dist/apis/calendar.js +1 -1
  21. package/dist/apis/chat.cjs +6 -6
  22. package/dist/apis/chat.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 +6 -6
  34. package/dist/apis/deduplication.js +1 -1
  35. package/dist/apis/design.cjs +6 -6
  36. package/dist/apis/design.js +1 -1
  37. package/dist/apis/document.cjs +6 -6
  38. package/dist/apis/document.js +1 -1
  39. package/dist/apis/email-settings.cjs +6 -6
  40. package/dist/apis/email-settings.js +1 -1
  41. package/dist/apis/email-template.cjs +6 -6
  42. package/dist/apis/email-template.js +1 -1
  43. package/dist/apis/entity-mapping.cjs +6 -6
  44. package/dist/apis/entity-mapping.d.cts +2 -2
  45. package/dist/apis/entity-mapping.d.ts +2 -2
  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.d.cts +2 -2
  59. package/dist/apis/integration-toolkit.d.ts +2 -2
  60. package/dist/apis/integration-toolkit.js +1 -1
  61. package/dist/apis/journey.cjs +6 -6
  62. package/dist/apis/journey.js +1 -1
  63. package/dist/apis/kanban.cjs +6 -6
  64. package/dist/apis/kanban.js +1 -1
  65. package/dist/apis/message.cjs +6 -6
  66. package/dist/apis/message.js +1 -1
  67. package/dist/apis/metering.cjs +6 -6
  68. package/dist/apis/metering.js +1 -1
  69. package/dist/apis/notes.cjs +6 -6
  70. package/dist/apis/notes.js +1 -1
  71. package/dist/apis/notification.cjs +6 -6
  72. package/dist/apis/notification.js +1 -1
  73. package/dist/apis/organization.cjs +6 -6
  74. package/dist/apis/organization.js +1 -1
  75. package/dist/apis/partner-directory.cjs +6 -6
  76. package/dist/apis/partner-directory.js +1 -1
  77. package/dist/apis/permissions.cjs +6 -6
  78. package/dist/apis/permissions.js +1 -1
  79. package/dist/apis/pricing-tier.cjs +6 -6
  80. package/dist/apis/pricing-tier.js +1 -1
  81. package/dist/apis/pricing.cjs +6 -6
  82. package/dist/apis/pricing.js +1 -1
  83. package/dist/apis/purpose.cjs +6 -6
  84. package/dist/apis/purpose.js +1 -1
  85. package/dist/apis/query.cjs +6 -6
  86. package/dist/apis/query.js +1 -1
  87. package/dist/apis/sandbox.cjs +6 -6
  88. package/dist/apis/sandbox.js +1 -1
  89. package/dist/apis/sharing.cjs +6 -6
  90. package/dist/apis/sharing.js +1 -1
  91. package/dist/apis/snapshot.cjs +6 -6
  92. package/dist/apis/snapshot.js +1 -1
  93. package/dist/apis/submission.cjs +6 -6
  94. package/dist/apis/submission.js +1 -1
  95. package/dist/apis/target.cjs +6 -6
  96. package/dist/apis/target.js +1 -1
  97. package/dist/apis/targeting.cjs +6 -6
  98. package/dist/apis/targeting.js +1 -1
  99. package/dist/apis/template-variables.cjs +6 -6
  100. package/dist/apis/template-variables.js +1 -1
  101. package/dist/apis/user.cjs +6 -6
  102. package/dist/apis/user.js +1 -1
  103. package/dist/apis/validation-rules.cjs +6 -6
  104. package/dist/apis/validation-rules.js +1 -1
  105. package/dist/apis/webhooks.cjs +6 -6
  106. package/dist/apis/webhooks.js +1 -1
  107. package/dist/apis/workflow-definition.cjs +6 -6
  108. package/dist/apis/workflow-definition.js +1 -1
  109. package/dist/apis/workflow.cjs +6 -6
  110. package/dist/apis/workflow.js +1 -1
  111. package/dist/{chunk-YCTBOY3T.cjs → chunk-PZ4TXAF5.cjs} +2 -2
  112. package/dist/{chunk-KZXOYL5D.js → chunk-X742W7MI.js} +2 -2
  113. package/dist/{entity-mapping-D67LJE74.js → entity-mapping-CBRH3VBZ.js} +1 -1
  114. package/dist/{entity-mapping-WFPSOXRK.cjs → entity-mapping-WE3QMZWA.cjs} +1 -1
  115. package/dist/{entity-mapping.d-CQv75o8M.d.cts → entity-mapping.d-8MtWa2_L.d.cts} +22 -0
  116. package/dist/{entity-mapping.d-CQv75o8M.d.ts → entity-mapping.d-8MtWa2_L.d.ts} +22 -0
  117. package/dist/index.cjs +8 -8
  118. package/dist/index.d.cts +2 -2
  119. package/dist/index.d.ts +2 -2
  120. package/dist/index.js +1 -1
  121. package/dist/integration-toolkit-FHPQSYLH.js +7 -0
  122. package/dist/integration-toolkit-YBZJK4IG.cjs +7 -0
  123. package/dist/{integration-toolkit.d-bhpB79pc.d.ts → integration-toolkit.d--hon4GPp.d.cts} +79 -26
  124. package/dist/{integration-toolkit.d-bhpB79pc.d.cts → integration-toolkit.d--hon4GPp.d.ts} +79 -26
  125. package/docs/entity-mapping.md +19 -0
  126. package/docs/integration-toolkit.md +19 -250
  127. package/package.json +1 -1
  128. package/definitions/access-token-runtime.json +0 -1
  129. package/definitions/access-token.json +0 -1025
  130. package/definitions/address-runtime.json +0 -1
  131. package/definitions/address-suggestions-runtime.json +0 -1
  132. package/definitions/address-suggestions.json +0 -582
  133. package/definitions/address.json +0 -578
  134. package/definitions/ai-agents-runtime.json +0 -1
  135. package/definitions/ai-agents.json +0 -2863
  136. package/definitions/app-runtime.json +0 -1
  137. package/definitions/app.json +0 -5994
  138. package/definitions/audit-logs-runtime.json +0 -1
  139. package/definitions/audit-logs.json +0 -305
  140. package/definitions/automation-runtime.json +0 -1
  141. package/definitions/automation.json +0 -5979
  142. package/definitions/billing-runtime.json +0 -1
  143. package/definitions/billing.json +0 -2394
  144. package/definitions/blueprint-manifest-runtime.json +0 -1
  145. package/definitions/blueprint-manifest.json +0 -7817
  146. package/definitions/calendar-runtime.json +0 -1
  147. package/definitions/calendar.json +0 -2904
  148. package/definitions/chat-runtime.json +0 -1
  149. package/definitions/chat.json +0 -2909
  150. package/definitions/configuration-hub-runtime.json +0 -1
  151. package/definitions/configuration-hub.json +0 -2250
  152. package/definitions/consent-runtime.json +0 -1
  153. package/definitions/consent.json +0 -344
  154. package/definitions/customer-portal-runtime.json +0 -1
  155. package/definitions/customer-portal.json +0 -21181
  156. package/definitions/dashboard-runtime.json +0 -1
  157. package/definitions/dashboard.json +0 -1355
  158. package/definitions/data-governance-runtime.json +0 -1
  159. package/definitions/data-governance.json +0 -1126
  160. package/definitions/deduplication-runtime.json +0 -1
  161. package/definitions/deduplication.json +0 -782
  162. package/definitions/design-runtime.json +0 -1
  163. package/definitions/design.json +0 -1827
  164. package/definitions/document-runtime.json +0 -1
  165. package/definitions/document.json +0 -758
  166. package/definitions/email-settings-runtime.json +0 -1
  167. package/definitions/email-settings.json +0 -3736
  168. package/definitions/email-template-runtime.json +0 -1
  169. package/definitions/email-template.json +0 -1441
  170. package/definitions/entity-mapping-runtime.json +0 -1
  171. package/definitions/entity-mapping.json +0 -1829
  172. package/definitions/entity-runtime.json +0 -1
  173. package/definitions/entity.json +0 -11546
  174. package/definitions/environments-runtime.json +0 -1
  175. package/definitions/environments.json +0 -988
  176. package/definitions/event-catalog-runtime.json +0 -1
  177. package/definitions/event-catalog.json +0 -2014
  178. package/definitions/file-runtime.json +0 -1
  179. package/definitions/file.json +0 -4298
  180. package/definitions/iban-runtime.json +0 -1
  181. package/definitions/iban.json +0 -132
  182. package/definitions/integration-toolkit-runtime.json +0 -1
  183. package/definitions/integration-toolkit.json +0 -13069
  184. package/definitions/journey-runtime.json +0 -1
  185. package/definitions/journey.json +0 -3586
  186. package/definitions/kanban-runtime.json +0 -1
  187. package/definitions/kanban.json +0 -1506
  188. package/definitions/message-runtime.json +0 -1
  189. package/definitions/message.json +0 -3667
  190. package/definitions/metering-runtime.json +0 -1
  191. package/definitions/metering.json +0 -3132
  192. package/definitions/notes-runtime.json +0 -1
  193. package/definitions/notes.json +0 -1698
  194. package/definitions/notification-runtime.json +0 -1
  195. package/definitions/notification.json +0 -1439
  196. package/definitions/organization-runtime.json +0 -1
  197. package/definitions/organization.json +0 -1192
  198. package/definitions/partner-directory-runtime.json +0 -1
  199. package/definitions/partner-directory.json +0 -2284
  200. package/definitions/permissions-runtime.json +0 -1
  201. package/definitions/permissions.json +0 -1598
  202. package/definitions/pricing-runtime.json +0 -1
  203. package/definitions/pricing-tier-runtime.json +0 -1
  204. package/definitions/pricing-tier.json +0 -105
  205. package/definitions/pricing.json +0 -14369
  206. package/definitions/purpose-runtime.json +0 -1
  207. package/definitions/purpose.json +0 -524
  208. package/definitions/query-runtime.json +0 -1
  209. package/definitions/query.json +0 -3178
  210. package/definitions/sandbox-runtime.json +0 -1
  211. package/definitions/sandbox.json +0 -453
  212. package/definitions/sharing-runtime.json +0 -1
  213. package/definitions/sharing.json +0 -956
  214. package/definitions/snapshot-runtime.json +0 -1
  215. package/definitions/snapshot.json +0 -1103
  216. package/definitions/submission-runtime.json +0 -1
  217. package/definitions/submission.json +0 -313
  218. package/definitions/targeting-runtime.json +0 -1
  219. package/definitions/targeting.json +0 -2285
  220. package/definitions/template-variables-runtime.json +0 -1
  221. package/definitions/template-variables.json +0 -1416
  222. package/definitions/user-runtime.json +0 -1
  223. package/definitions/user.json +0 -3051
  224. package/definitions/validation-rules-runtime.json +0 -1
  225. package/definitions/validation-rules.json +0 -2642
  226. package/definitions/webhooks-runtime.json +0 -1
  227. package/definitions/webhooks.json +0 -1875
  228. package/definitions/workflow-definition-runtime.json +0 -1
  229. package/definitions/workflow-definition.json +0 -3592
  230. package/definitions/workflow-runtime.json +0 -1
  231. package/definitions/workflow.json +0 -4669
  232. package/dist/integration-toolkit-GOFVOMNH.js +0 -7
  233. package/dist/integration-toolkit-XMM5LLK6.cjs +0 -7
@@ -1,7 +1,7 @@
1
1
  "use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
2
2
 
3
3
  // src/docs/entity-mapping.json
4
- var entity_mapping_default = '# Entity Mapping API\n\n- **Base URL:** `https://entity-mapping.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/entity-mapping](https://docs.epilot.io/api/entity-mapping)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.entityMapping.storeConfig(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/entity-mapping\'\n\nconst entityMappingClient = getClient()\nauthorize(entityMappingClient, () => \'<token>\')\nconst { data } = await entityMappingClient.storeConfig(...)\n```\n\n## Operations\n\n**mappings**\n- [`storeConfig`](#storeconfig)\n- [`getConfig`](#getconfig)\n- [`deleteConfig`](#deleteconfig)\n- [`getAllVersions`](#getallversions)\n- [`storeNewVersion`](#storenewversion)\n- [`getConfigVersion`](#getconfigversion)\n- [`executeMapping`](#executemapping)\n- [`searchConfigs`](#searchconfigs)\n- [`queryMappingHistory`](#querymappinghistory)\n- [`executeRelations`](#executerelations)\n- [`getMappingConfig`](#getmappingconfig)\n- [`putMappingConfig`](#putmappingconfig)\n\n**Schemas**\n- [`SearchMappingReq`](#searchmappingreq)\n- [`MappingConfigsResp`](#mappingconfigsresp)\n- [`MappingConfigs`](#mappingconfigs)\n- [`MappingConfig`](#mappingconfig)\n- [`MappingConfigV2`](#mappingconfigv2)\n- [`MappingConfigCommonFields`](#mappingconfigcommonfields)\n- [`Owner`](#owner)\n- [`ExecuteRelationsReq`](#executerelationsreq)\n- [`ExecuteRelationsResp`](#executerelationsresp)\n- [`NewRelationItem`](#newrelationitem)\n- [`RelationItem`](#relationitem)\n- [`ExecuteMappingReq`](#executemappingreq)\n- [`ExecuteMappingResp`](#executemappingresp)\n- [`MappingFailure`](#mappingfailure)\n- [`MappingWarning`](#mappingwarning)\n- [`Entity`](#entity)\n- [`EntityRef`](#entityref)\n- [`SourceConfig`](#sourceconfig)\n- [`JourneyRef`](#journeyref)\n- [`Loop_Index_String`](#loop_index_string)\n- [`TargetConfig`](#targetconfig)\n- [`MapCondition`](#mapcondition)\n- [`ConditionNode`](#conditionnode)\n- [`RelationAttribute`](#relationattribute)\n- [`GraphContextEntry`](#graphcontextentry)\n- [`GraphSeed`](#graphseed)\n- [`GraphDefinition`](#graphdefinition)\n- [`GraphNode`](#graphnode)\n- [`GraphNodeFilter`](#graphnodefilter)\n- [`GraphEdge`](#graphedge)\n- [`MappingAttributeV2`](#mappingattributev2)\n- [`AttributeOrigin`](#attributeorigin)\n- [`OperationNode`](#operationnode)\n- [`OperationObjectNode`](#operationobjectnode)\n- [`PrimitiveJSONValue`](#primitivejsonvalue)\n- [`RandomOperation`](#randomoperation)\n- [`MappingAttribute`](#mappingattribute)\n- [`MappingAttributeMode`](#mappingattributemode)\n- [`SetValueMapper`](#setvaluemapper)\n- [`CopyValueMapper`](#copyvaluemapper)\n- [`AppendValueMapper`](#appendvaluemapper)\n- [`MappingHistoryResp`](#mappinghistoryresp)\n- [`MappingHistoryEntry`](#mappinghistoryentry)\n- [`MappingSource`](#mappingsource)\n- [`MappingSourceProperty`](#mappingsourceproperty)\n- [`MappingSourceTargetType`](#mappingsourcetargettype)\n\n### `storeConfig`\n\nStore new MappingConfig\n\n`POST /v1/mappings`\n\n```ts\nconst { data } = await client.storeConfig(\n {\n with_id: \'example\',\n },\n {\n id: \'string\',\n source: {\n type: \'journey\',\n config: {\n journey_id: \'string\'\n }\n },\n targets: [\n {\n id: \'string\',\n name: \'string\',\n allow_failure: true,\n target_schema: \'string\',\n target_unique: [\'string\'],\n use_uniqueness_criteria: false,\n loop_config: { /* ... */ },\n conditionMode: \'oneOf\',\n conditions: [ /* ... */ ],\n mapping_attributes: [ /* ... */ ],\n relation_attributes: [ /* ... */ ],\n linkback_relation_attribute: \'mapped_entities\',\n linkback_relation_tags: [\'string\'],\n graph_context: [ /* ... */ ]\n }\n ],\n created_at: \'1970-01-01T00:00:00.000Z\',\n updated_at: \'1970-01-01T00:00:00.000Z\',\n created_by: {\n type: \'user\',\n org_id: \'string\',\n user_id: \'string\'\n },\n last_updated_by: {\n type: \'user\',\n org_id: \'string\',\n user_id: \'string\'\n },\n org_id: \'66\',\n version: 2\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "source": {\n "type": "journey",\n "config": {\n "journey_id": "string"\n }\n },\n "targets": [\n {\n "id": "string",\n "name": "string",\n "allow_failure": true,\n "target_schema": "string",\n "target_unique": ["string"],\n "use_uniqueness_criteria": false,\n "loop_config": {},\n "conditionMode": "oneOf",\n "conditions": [],\n "mapping_attributes": [],\n "relation_attributes": [],\n "linkback_relation_attribute": "mapped_entities",\n "linkback_relation_tags": ["string"],\n "graph_context": []\n }\n ],\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "created_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "last_updated_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "org_id": "66",\n "version": 2\n}\n```\n\n</details>\n\n---\n\n### `getConfig`\n\nGet latest version of a mapping config by id\n\n`GET /v1/mappings/{id}`\n\n```ts\nconst { data } = await client.getConfig({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "source": {\n "type": "journey",\n "config": {\n "journey_id": "string"\n }\n },\n "targets": [\n {\n "id": "string",\n "name": "string",\n "allow_failure": true,\n "target_schema": "string",\n "target_unique": ["string"],\n "use_uniqueness_criteria": false,\n "loop_config": {},\n "conditionMode": "oneOf",\n "conditions": [],\n "mapping_attributes": [],\n "relation_attributes": [],\n "linkback_relation_attribute": "mapped_entities",\n "linkback_relation_tags": ["string"],\n "graph_context": []\n }\n ],\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "created_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "last_updated_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "org_id": "66",\n "version": 2\n}\n```\n\n</details>\n\n---\n\n### `deleteConfig`\n\nDelete entity mapping config\n\n`DELETE /v1/mappings/{id}`\n\n```ts\nconst { data } = await client.deleteConfig({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "source": {\n "type": "journey",\n "config": {\n "journey_id": "string"\n }\n },\n "targets": [\n {\n "id": "string",\n "name": "string",\n "allow_failure": true,\n "target_schema": "string",\n "target_unique": ["string"],\n "use_uniqueness_criteria": false,\n "loop_config": {},\n "conditionMode": "oneOf",\n "conditions": [],\n "mapping_attributes": [],\n "relation_attributes": [],\n "linkback_relation_attribute": "mapped_entities",\n "linkback_relation_tags": ["string"],\n "graph_context": []\n }\n ],\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "created_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "last_updated_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "org_id": "66",\n "version": 2\n}\n```\n\n</details>\n\n---\n\n### `getAllVersions`\n\nGet all version of MappingConfig\n\n`GET /v1/mappings/{id}/versions`\n\n```ts\nconst { data } = await client.getAllVersions({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "configs": [\n {\n "id": "string",\n "source": {},\n "targets": [],\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "created_by": {},\n "last_updated_by": {},\n "org_id": "66",\n "version": 2\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `storeNewVersion`\n\nStore new version of MappingConfig\n\n`POST /v1/mappings/{id}/versions`\n\n```ts\nconst { data } = await client.storeNewVersion(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n id: \'string\',\n source: {\n type: \'journey\',\n config: {\n journey_id: \'string\'\n }\n },\n targets: [\n {\n id: \'string\',\n name: \'string\',\n allow_failure: true,\n target_schema: \'string\',\n target_unique: [\'string\'],\n use_uniqueness_criteria: false,\n loop_config: { /* ... */ },\n conditionMode: \'oneOf\',\n conditions: [ /* ... */ ],\n mapping_attributes: [ /* ... */ ],\n relation_attributes: [ /* ... */ ],\n linkback_relation_attribute: \'mapped_entities\',\n linkback_relation_tags: [\'string\'],\n graph_context: [ /* ... */ ]\n }\n ],\n created_at: \'1970-01-01T00:00:00.000Z\',\n updated_at: \'1970-01-01T00:00:00.000Z\',\n created_by: {\n type: \'user\',\n org_id: \'string\',\n user_id: \'string\'\n },\n last_updated_by: {\n type: \'user\',\n org_id: \'string\',\n user_id: \'string\'\n },\n org_id: \'66\',\n version: 2\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "source": {\n "type": "journey",\n "config": {\n "journey_id": "string"\n }\n },\n "targets": [\n {\n "id": "string",\n "name": "string",\n "allow_failure": true,\n "target_schema": "string",\n "target_unique": ["string"],\n "use_uniqueness_criteria": false,\n "loop_config": {},\n "conditionMode": "oneOf",\n "conditions": [],\n "mapping_attributes": [],\n "relation_attributes": [],\n "linkback_relation_attribute": "mapped_entities",\n "linkback_relation_tags": ["string"],\n "graph_context": []\n }\n ],\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "created_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "last_updated_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "org_id": "66",\n "version": 2\n}\n```\n\n</details>\n\n---\n\n### `getConfigVersion`\n\nGet specific version of a mapping config by id & version\n\n`GET /v1/mappings/{id}/versions/{version}`\n\n```ts\nconst { data } = await client.getConfigVersion({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n version: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "source": {\n "type": "journey",\n "config": {\n "journey_id": "string"\n }\n },\n "targets": [\n {\n "id": "string",\n "name": "string",\n "allow_failure": true,\n "target_schema": "string",\n "target_unique": ["string"],\n "use_uniqueness_criteria": false,\n "loop_config": {},\n "conditionMode": "oneOf",\n "conditions": [],\n "mapping_attributes": [],\n "relation_attributes": [],\n "linkback_relation_attribute": "mapped_entities",\n "linkback_relation_tags": ["string"],\n "graph_context": []\n }\n ],\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "created_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "last_updated_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "org_id": "66",\n "version": 2\n}\n```\n\n</details>\n\n---\n\n### `executeMapping`\n\nExecute entity mapping based on a config\n\n`POST /v1/mappings:execute`\n\n```ts\nconst { data } = await client.executeMapping(\n {\n preview_mode: true,\n },\n {\n source_ref: {\n entity_id: \'string\',\n entity_schema: \'submission\'\n },\n loop_ref: {\n entity_id: \'string\',\n entity_schema: \'submission\'\n },\n targets: [\n {\n id: \'string\',\n name: \'string\',\n allow_failure: true,\n target_schema: \'string\',\n target_unique: [\'string\'],\n use_uniqueness_criteria: false,\n loop_config: { /* ... */ },\n conditionMode: \'oneOf\',\n conditions: [ /* ... */ ],\n mapping_attributes: [ /* ... */ ],\n relation_attributes: [ /* ... */ ],\n linkback_relation_attribute: \'mapped_entities\',\n linkback_relation_tags: [\'string\'],\n graph_context: [ /* ... */ ]\n }\n ]\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "mapped_entities": [\n {\n "_id": "string",\n "_schema": "string",\n "_title": "string",\n "_org": "string",\n "_tags": ["string"],\n "_created_at": "string",\n "_updated_at": "string",\n "required": {}\n }\n ],\n "failures": [\n {\n "target": {},\n "error": {}\n }\n ],\n "warnings": [\n {\n "explanation": "string",\n "context": "string",\n "id": "string"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `searchConfigs`\n\nSearch mapping configs\n\n`POST /v1/mappings:search`\n\n```ts\nconst { data } = await client.searchConfigs(\n null,\n {\n source: {\n type: \'journey\',\n config: {\n journey_id: \'string\'\n }\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "source": {\n "type": "journey",\n "config": {\n "journey_id": "string"\n }\n },\n "targets": [\n {\n "id": "string",\n "name": "string",\n "allow_failure": true,\n "target_schema": "string",\n "target_unique": ["string"],\n "use_uniqueness_criteria": false,\n "loop_config": {},\n "conditionMode": "oneOf",\n "conditions": [],\n "mapping_attributes": [],\n "relation_attributes": [],\n "linkback_relation_attribute": "mapped_entities",\n "linkback_relation_tags": ["string"],\n "graph_context": []\n }\n ],\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "created_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "last_updated_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "org_id": "66",\n "version": 2\n}\n```\n\n</details>\n\n---\n\n### `queryMappingHistory`\n\nGet the Mapping History\n\n`GET /v1/mappings/history`\n\n```ts\nconst { data } = await client.queryMappingHistory({\n from: \'example\',\n to: \'example\',\n targetEntityId: \'example\',\n sourceEntityId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{}\n```\n\n</details>\n\n---\n\n### `executeRelations`\n\nExecute relation mapping between source entity and target entities\n\n`POST /v1/relations:execute`\n\n```ts\nconst { data } = await client.executeRelations(\n null,\n {\n source_ref: {\n entity_id: \'string\',\n entity_schema: \'submission\'\n },\n target: {\n main_entity_ref: {\n entity_id: \'string\',\n entity_schema: \'submission\'\n },\n relation_attributes: [\n {\n target: \'string\',\n target_tags: [\'string\'],\n target_tags_include_source: false,\n target_entity_tags: [\'string\'],\n override_with_source_filter: false,\n source_filter: {\n limit: 0,\n schema: \'string\',\n attribute: \'string\',\n relation_tag: \'string\',\n tag: \'string\',\n self: false\n },\n related_to: {},\n mode: \'append\',\n origin: \'system_recommendation\'\n }\n ],\n linkback: {\n attribute: \'mapped_entities\',\n relation_tags: [\'string\']\n }\n },\n additional_relations: [\n {\n entity_id: \'string\',\n attribute: \'string\'\n }\n ]\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "relations": [\n {\n "source_entity_id": "string",\n "target_entity_id": "string",\n "relation_attr": "string",\n "tags": ["string"]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getMappingConfig`\n\nGet latest version of a mapping config by id V2\n\n`GET /v2/mappings/{id}`\n\n```ts\nconst { data } = await client.getMappingConfig({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "source": {\n "type": "journey",\n "config": {\n "journey_id": "string"\n }\n },\n "targets": [\n {\n "id": "string",\n "name": "string",\n "allow_failure": true,\n "target_schema": "string",\n "target_unique": ["string"],\n "use_uniqueness_criteria": false,\n "loop_config": {},\n "conditionMode": "oneOf",\n "conditions": [],\n "mapping_attributes": [],\n "relation_attributes": [],\n "linkback_relation_attribute": "mapped_entities",\n "linkback_relation_tags": ["string"],\n "graph_context": []\n }\n ],\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "created_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "last_updated_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "org_id": "66",\n "version": 2\n}\n```\n\n</details>\n\n---\n\n### `putMappingConfig`\n\nStores new version of entity mapping config\n\n`PUT /v2/mappings/{id}`\n\n```ts\nconst { data } = await client.putMappingConfig(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n id: \'string\',\n source: {\n type: \'journey\',\n config: {\n journey_id: \'string\'\n }\n },\n targets: [\n {\n id: \'string\',\n name: \'string\',\n allow_failure: true,\n target_schema: \'string\',\n target_unique: [\'string\'],\n use_uniqueness_criteria: false,\n loop_config: { /* ... */ },\n conditionMode: \'oneOf\',\n conditions: [ /* ... */ ],\n mapping_attributes: [ /* ... */ ],\n relation_attributes: [ /* ... */ ],\n linkback_relation_attribute: \'mapped_entities\',\n linkback_relation_tags: [\'string\'],\n graph_context: [ /* ... */ ]\n }\n ],\n created_at: \'1970-01-01T00:00:00.000Z\',\n updated_at: \'1970-01-01T00:00:00.000Z\',\n created_by: {\n type: \'user\',\n org_id: \'string\',\n user_id: \'string\'\n },\n last_updated_by: {\n type: \'user\',\n org_id: \'string\',\n user_id: \'string\'\n },\n org_id: \'66\',\n version: 2\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "source": {\n "type": "journey",\n "config": {\n "journey_id": "string"\n }\n },\n "targets": [\n {\n "id": "string",\n "name": "string",\n "allow_failure": true,\n "target_schema": "string",\n "target_unique": ["string"],\n "use_uniqueness_criteria": false,\n "loop_config": {},\n "conditionMode": "oneOf",\n "conditions": [],\n "mapping_attributes": [],\n "relation_attributes": [],\n "linkback_relation_attribute": "mapped_entities",\n "linkback_relation_tags": ["string"],\n "graph_context": []\n }\n ],\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "created_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "last_updated_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "org_id": "66",\n "version": 2\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `SearchMappingReq`\n\n```ts\ntype SearchMappingReq = {\n source?: {\n type?: "journey" | "entity"\n config?: {\n journey_id?: { ... }\n } | {\n entity_id: { ... }\n entity_schema?: { ... }\n }\n }\n}\n```\n\n### `MappingConfigsResp`\n\n```ts\ntype MappingConfigsResp = {\n configs: Array<{\n id: string\n source: {\n type?: { ... }\n config?: { ... }\n }\n targets: Array<{\n id?: { ... }\n name?: { ... }\n allow_failure?: { ... }\n target_schema: { ... }\n target_unique?: { ... }\n use_uniqueness_criteria?: { ... }\n loop_config?: { ... }\n conditionMode?: { ... }\n conditions?: { ... }\n mapping_attributes: { ... }\n relation_attributes?: { ... }\n linkback_relation_attribute?: { ... }\n linkback_relation_tags?: { ... }\n graph_context?: { ... }\n }>\n created_at?: string // date-time\n updated_at?: string // date-time\n created_by?: {\n type: { ... }\n org_id?: { ... }\n user_id?: { ... }\n }\n last_updated_by?: {\n type: { ... }\n org_id?: { ... }\n user_id?: { ... }\n }\n org_id?: string\n version?: number\n }>\n}\n```\n\n### `MappingConfigs`\n\n```ts\ntype MappingConfigs = Array<{\n id: string\n source: {\n type?: "journey" | "entity"\n config?: {\n journey_id?: { ... }\n } | {\n entity_id: { ... }\n entity_schema?: { ... }\n }\n }\n targets: Array<{\n id?: string\n name?: string\n allow_failure?: boolean\n target_schema: string\n target_unique?: string[]\n use_uniqueness_criteria?: boolean\n loop_config?: {\n source_path?: { ... }\n length?: { ... }\n }\n conditionMode?: "oneOf" | "anyOf" | "allOf"\n conditions?: Array<{\n _exists?: { ... }\n _equals?: { ... }\n _not_exists?: { ... }\n _any_of?: { ... }\n }>\n mapping_attributes: Array<{\n target: { ... }\n operation: { ... }\n origin?: { ... }\n } | {\n mode: { ... }\n target: { ... }\n value: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source?: { ... }\n value_json: { ... }\n target_unique?: { ... }\n }>\n relation_attributes?: Array<{\n target: { ... }\n target_tags?: { ... }\n target_tags_include_source?: { ... }\n target_entity_tags?: { ... }\n override_with_source_filter?: { ... }\n source_filter?: { ... }\n related_to?: { ... }\n mode: { ... }\n origin?: { ... }\n }>\n linkback_relation_attribute?: string\n linkback_relation_tags?: string[]\n graph_context?: Array<{\n seed: { ... }\n graph: { ... }\n }>\n }>\n created_at?: string // date-time\n updated_at?: string // date-time\n created_by?: {\n type: "user" | "internal_service"\n org_id?: string\n user_id?: string\n }\n last_updated_by?: {\n type: "user" | "internal_service"\n org_id?: string\n user_id?: string\n }\n org_id?: string\n version?: number\n}>\n```\n\n### `MappingConfig`\n\n```ts\ntype MappingConfig = {\n id: string\n source: {\n type?: "journey" | "entity"\n config?: {\n journey_id?: { ... }\n } | {\n entity_id: { ... }\n entity_schema?: { ... }\n }\n }\n targets: Array<{\n id?: string\n name?: string\n allow_failure?: boolean\n target_schema: string\n target_unique?: string[]\n use_uniqueness_criteria?: boolean\n loop_config?: {\n source_path?: { ... }\n length?: { ... }\n }\n conditionMode?: "oneOf" | "anyOf" | "allOf"\n conditions?: Array<{\n _exists?: { ... }\n _equals?: { ... }\n _not_exists?: { ... }\n _any_of?: { ... }\n }>\n mapping_attributes: Array<{\n target: { ... }\n operation: { ... }\n origin?: { ... }\n } | {\n mode: { ... }\n target: { ... }\n value: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source?: { ... }\n value_json: { ... }\n target_unique?: { ... }\n }>\n relation_attributes?: Array<{\n target: { ... }\n target_tags?: { ... }\n target_tags_include_source?: { ... }\n target_entity_tags?: { ... }\n override_with_source_filter?: { ... }\n source_filter?: { ... }\n related_to?: { ... }\n mode: { ... }\n origin?: { ... }\n }>\n linkback_relation_attribute?: string\n linkback_relation_tags?: string[]\n graph_context?: Array<{\n seed: { ... }\n graph: { ... }\n }>\n }>\n created_at?: string // date-time\n updated_at?: string // date-time\n created_by?: {\n type: "user" | "internal_service"\n org_id?: string\n user_id?: string\n }\n last_updated_by?: {\n type: "user" | "internal_service"\n org_id?: string\n user_id?: string\n }\n org_id?: string\n version?: number\n}\n```\n\n### `MappingConfigV2`\n\n```ts\ntype MappingConfigV2 = {\n id: string\n source: {\n type?: "journey" | "entity"\n config?: {\n journey_id?: { ... }\n } | {\n entity_id: { ... }\n entity_schema?: { ... }\n }\n }\n targets: Array<{\n id?: string\n name?: string\n allow_failure?: boolean\n target_schema: string\n target_unique?: string[]\n use_uniqueness_criteria?: boolean\n loop_config?: {\n source_path?: { ... }\n length?: { ... }\n }\n conditionMode?: "oneOf" | "anyOf" | "allOf"\n conditions?: Array<{\n _exists?: { ... }\n _equals?: { ... }\n _not_exists?: { ... }\n _any_of?: { ... }\n }>\n mapping_attributes: Array<{\n target: { ... }\n operation: { ... }\n origin?: { ... }\n } | {\n mode: { ... }\n target: { ... }\n value: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source?: { ... }\n value_json: { ... }\n target_unique?: { ... }\n }>\n relation_attributes?: Array<{\n target: { ... }\n target_tags?: { ... }\n target_tags_include_source?: { ... }\n target_entity_tags?: { ... }\n override_with_source_filter?: { ... }\n source_filter?: { ... }\n related_to?: { ... }\n mode: { ... }\n origin?: { ... }\n }>\n linkback_relation_attribute?: string\n linkback_relation_tags?: string[]\n graph_context?: Array<{\n seed: { ... }\n graph: { ... }\n }>\n }>\n created_at?: string // date-time\n updated_at?: string // date-time\n created_by?: {\n type: "user" | "internal_service"\n org_id?: string\n user_id?: string\n }\n last_updated_by?: {\n type: "user" | "internal_service"\n org_id?: string\n user_id?: string\n }\n org_id?: string\n version?: number\n}\n```\n\n### `MappingConfigCommonFields`\n\n```ts\ntype MappingConfigCommonFields = {\n id: string\n source: {\n type?: "journey" | "entity"\n config?: {\n journey_id?: { ... }\n } | {\n entity_id: { ... }\n entity_schema?: { ... }\n }\n }\n targets: Array<{\n id?: string\n name?: string\n allow_failure?: boolean\n target_schema: string\n target_unique?: string[]\n use_uniqueness_criteria?: boolean\n loop_config?: {\n source_path?: { ... }\n length?: { ... }\n }\n conditionMode?: "oneOf" | "anyOf" | "allOf"\n conditions?: Array<{\n _exists?: { ... }\n _equals?: { ... }\n _not_exists?: { ... }\n _any_of?: { ... }\n }>\n mapping_attributes: Array<{\n target: { ... }\n operation: { ... }\n origin?: { ... }\n } | {\n mode: { ... }\n target: { ... }\n value: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source?: { ... }\n value_json: { ... }\n target_unique?: { ... }\n }>\n relation_attributes?: Array<{\n target: { ... }\n target_tags?: { ... }\n target_tags_include_source?: { ... }\n target_entity_tags?: { ... }\n override_with_source_filter?: { ... }\n source_filter?: { ... }\n related_to?: { ... }\n mode: { ... }\n origin?: { ... }\n }>\n linkback_relation_attribute?: string\n linkback_relation_tags?: string[]\n graph_context?: Array<{\n seed: { ... }\n graph: { ... }\n }>\n }>\n created_at?: string // date-time\n updated_at?: string // date-time\n created_by?: {\n type: "user" | "internal_service"\n org_id?: string\n user_id?: string\n }\n last_updated_by?: {\n type: "user" | "internal_service"\n org_id?: string\n user_id?: string\n }\n}\n```\n\n### `Owner`\n\n```ts\ntype Owner = {\n type: "user" | "internal_service"\n org_id?: string\n user_id?: string\n}\n```\n\n### `ExecuteRelationsReq`\n\nBuild relations between a source entity and one or more target entities, dynamically identified\n\n```ts\ntype ExecuteRelationsReq = {\n source_ref: {\n entity_id: string\n entity_schema?: string\n }\n target?: {\n main_entity_ref: {\n entity_id: { ... }\n entity_schema?: { ... }\n }\n relation_attributes: Array<{\n target: { ... }\n target_tags?: { ... }\n target_tags_include_source?: { ... }\n target_entity_tags?: { ... }\n override_with_source_filter?: { ... }\n source_filter?: { ... }\n related_to?: { ... }\n mode: { ... }\n origin?: { ... }\n }>\n linkback?: {\n attribute: { ... }\n relation_tags: { ... }\n }\n }\n additional_relations?: Array<{\n entity_id: string\n attribute: string\n }>\n}\n```\n\n### `ExecuteRelationsResp`\n\n```ts\ntype ExecuteRelationsResp = {\n relations?: Array<{\n source_entity_id: string\n target_entity_id: string\n relation_attr: string\n tags?: string[]\n }>\n}\n```\n\n### `NewRelationItem`\n\n```ts\ntype NewRelationItem = {\n source_entity_id: string\n target_entity_id: string\n relation_attr: string\n tags?: string[]\n}\n```\n\n### `RelationItem`\n\n```ts\ntype RelationItem = {\n entity_id: string\n attribute: string\n}\n```\n\n### `ExecuteMappingReq`\n\nPass either source or source_entity\n\n```ts\ntype ExecuteMappingReq = {\n source_ref: {\n entity_id: string\n entity_schema?: string\n }\n loop_ref?: {\n entity_id: string\n entity_schema?: string\n }\n targets: Array<{\n id?: string\n name?: string\n allow_failure?: boolean\n target_schema: string\n target_unique?: string[]\n use_uniqueness_criteria?: boolean\n loop_config?: {\n source_path?: { ... }\n length?: { ... }\n }\n conditionMode?: "oneOf" | "anyOf" | "allOf"\n conditions?: Array<{\n _exists?: { ... }\n _equals?: { ... }\n _not_exists?: { ... }\n _any_of?: { ... }\n }>\n mapping_attributes: Array<{\n target: { ... }\n operation: { ... }\n origin?: { ... }\n } | {\n mode: { ... }\n target: { ... }\n value: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source?: { ... }\n value_json: { ... }\n target_unique?: { ... }\n }>\n relation_attributes?: Array<{\n target: { ... }\n target_tags?: { ... }\n target_tags_include_source?: { ... }\n target_entity_tags?: { ... }\n override_with_source_filter?: { ... }\n source_filter?: { ... }\n related_to?: { ... }\n mode: { ... }\n origin?: { ... }\n }>\n linkback_relation_attribute?: string\n linkback_relation_tags?: string[]\n graph_context?: Array<{\n seed: { ... }\n graph: { ... }\n }>\n }>\n}\n```\n\n### `ExecuteMappingResp`\n\n```ts\ntype ExecuteMappingResp = {\n mapped_entities: Array<{\n _id?: string\n _schema?: string\n _title?: string\n _org?: string\n _tags?: string[]\n _created_at?: string\n _updated_at?: string\n required?: unknown\n }>\n failures?: Array<{\n target?: {\n id?: { ... }\n name?: { ... }\n allow_failure?: { ... }\n target_schema: { ... }\n target_unique?: { ... }\n use_uniqueness_criteria?: { ... }\n loop_config?: { ... }\n conditionMode?: { ... }\n conditions?: { ... }\n mapping_attributes: { ... }\n relation_attributes?: { ... }\n linkback_relation_attribute?: { ... }\n linkback_relation_tags?: { ... }\n graph_context?: { ... }\n }\n error?: {\n isSilent?: { ... }\n message?: { ... }\n }\n }>\n warnings?: Array<{\n explanation: string\n context?: string\n id?: string\n }>\n}\n```\n\n### `MappingFailure`\n\n```ts\ntype MappingFailure = {\n target?: {\n id?: string\n name?: string\n allow_failure?: boolean\n target_schema: string\n target_unique?: string[]\n use_uniqueness_criteria?: boolean\n loop_config?: {\n source_path?: { ... }\n length?: { ... }\n }\n conditionMode?: "oneOf" | "anyOf" | "allOf"\n conditions?: Array<{\n _exists?: { ... }\n _equals?: { ... }\n _not_exists?: { ... }\n _any_of?: { ... }\n }>\n mapping_attributes: Array<{\n target: { ... }\n operation: { ... }\n origin?: { ... }\n } | {\n mode: { ... }\n target: { ... }\n value: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source?: { ... }\n value_json: { ... }\n target_unique?: { ... }\n }>\n relation_attributes?: Array<{\n target: { ... }\n target_tags?: { ... }\n target_tags_include_source?: { ... }\n target_entity_tags?: { ... }\n override_with_source_filter?: { ... }\n source_filter?: { ... }\n related_to?: { ... }\n mode: { ... }\n origin?: { ... }\n }>\n linkback_relation_attribute?: string\n linkback_relation_tags?: string[]\n graph_context?: Array<{\n seed: { ... }\n graph: { ... }\n }>\n }\n error?: {\n isSilent?: boolean\n message?: string\n }\n}\n```\n\n### `MappingWarning`\n\n```ts\ntype MappingWarning = {\n explanation: string\n context?: string\n id?: string\n}\n```\n\n### `Entity`\n\n```ts\ntype Entity = {\n _id?: string\n _schema?: string\n _title?: string\n _org?: string\n _tags?: string[]\n _created_at?: string\n _updated_at?: string\n required?: unknown\n}\n```\n\n### `EntityRef`\n\n```ts\ntype EntityRef = {\n entity_id: string\n entity_schema?: string\n}\n```\n\n### `SourceConfig`\n\n```ts\ntype SourceConfig = {\n type?: "journey" | "entity"\n config?: {\n journey_id?: string\n } | {\n entity_id: string\n entity_schema?: string\n }\n}\n```\n\n### `JourneyRef`\n\n```ts\ntype JourneyRef = {\n journey_id?: string\n}\n```\n\n### `Loop_Index_String`\n\nThis string value will be replaced with the value of the loop index, when mapping in loop mode\n\n```ts\ntype Loop_Index_String = "##LOOP_INDEX##"\n```\n\n### `TargetConfig`\n\n```ts\ntype TargetConfig = {\n id?: string\n name?: string\n allow_failure?: boolean\n target_schema: string\n target_unique?: string[]\n use_uniqueness_criteria?: boolean\n loop_config?: {\n source_path?: string\n length?: number\n }\n conditionMode?: "oneOf" | "anyOf" | "allOf"\n conditions?: Array<{\n _exists?: {\n source?: { ... }\n value?: { ... }\n }\n _equals?: {\n source?: { ... }\n value?: { ... }\n }\n _not_exists?: {\n source?: { ... }\n value?: { ... }\n }\n _any_of?: {\n source?: { ... }\n value?: { ... }\n }\n }>\n mapping_attributes: Array<{\n target: string\n operation: {\n _set?: { ... }\n _append?: { ... }\n _prepend?: { ... }\n _uniq?: { ... }\n _retain_old_values?: { ... }\n _copy?: { ... }\n _template?: { ... }\n _random?: { ... }\n _each?: { ... }\n _as?: { ... }\n _map?: { ... }\n } | string | boolean | number | Record<string, unknown> | unknown[]\n origin?: "system_recommendation" | "user_manually" | "entity_updating_system_recommendation"\n } | {\n mode: "copy_if_exists" | "append_if_exists" | "set_value"\n target: string\n value: unknown\n } | {\n mode: "copy_if_exists" | "append_if_exists" | "set_value"\n target: string\n source: string\n } | {\n mode: "copy_if_exists" | "append_if_exists" | "set_value"\n target: string\n source?: string\n value_json: string\n target_unique?: string[]\n }>\n relation_attributes?: Array<{\n target: string\n target_tags?: string[]\n target_tags_include_source?: boolean\n target_entity_tags?: string[]\n override_with_source_filter?: boolean\n source_filter?: {\n limit?: { ... }\n schema?: { ... }\n attribute?: { ... }\n relation_tag?: { ... }\n tag?: { ... }\n self?: { ... }\n }\n related_to?: Record<string, unknown>\n mode: "append" | "prepend" | "set"\n origin?: "system_recommendation" | "user_manually" | "entity_updating_system_recommendation"\n }>\n linkback_relation_attribute?: string\n linkback_relation_tags?: string[]\n graph_context?: Array<{\n seed: {\n entity_id: { ... }\n node_id: { ... }\n }\n graph: {\n nodes: { ... }\n edges: { ... }\n }\n }>\n}\n```\n\n### `MapCondition`\n\n```ts\ntype MapCondition = {\n _exists?: {\n source?: string\n value?: string | number | object | object[]\n }\n _equals?: {\n source?: string\n value?: string | number | object | object[]\n }\n _not_exists?: {\n source?: string\n value?: string | number | object | object[]\n }\n _any_of?: {\n source?: string\n value?: string | number | object | object[]\n }\n}\n```\n\n### `ConditionNode`\n\n```ts\ntype ConditionNode = {\n source?: string\n value?: string | number | object | object[]\n}\n```\n\n### `RelationAttribute`\n\n```ts\ntype RelationAttribute = {\n target: string\n target_tags?: string[]\n target_tags_include_source?: boolean\n target_entity_tags?: string[]\n override_with_source_filter?: boolean\n source_filter?: {\n limit?: number\n schema?: string\n attribute?: string\n relation_tag?: string\n tag?: string\n self?: boolean\n }\n related_to?: Record<string, unknown>\n mode: "append" | "prepend" | "set"\n origin?: "system_recommendation" | "user_manually" | "entity_updating_system_recommendation"\n}\n```\n\n### `GraphContextEntry`\n\nOne multi-hop graph lookup against entity-api\'s `POST /v1/entity:graph`, resolved during\ngraph_context enrichment (before mapping_attributes are evaluated). Every node in `graph.nodes`\nis merged into sourceContext under its own `id`, so listing several nodes here costs one\nentity-api call, not one p\n\n```ts\ntype GraphContextEntry = {\n seed: {\n entity_id: string\n node_id: string\n }\n graph: {\n nodes: Array<{\n id: { ... }\n schema: { ... }\n cardinality?: { ... }\n fields?: { ... }\n filter?: { ... }\n }>\n edges: Array<{\n from: { ... }\n to: { ... }\n }>\n }\n}\n```\n\n### `GraphSeed`\n\nMirrors entity-api\'s GraphSeed (see entity-api openapi.yml) - the entity the graph traversal starts from.\n\n```ts\ntype GraphSeed = {\n entity_id: string\n node_id: string\n}\n```\n\n### `GraphDefinition`\n\nMirrors entity-api\'s GraphDefinition (see entity-api openapi.yml) - the shape of the graph to traverse.\n\n```ts\ntype GraphDefinition = {\n nodes: Array<{\n id: string\n schema: string\n cardinality?: "one" | "many"\n fields?: string[]\n filter?: Array<{\n attribute: { ... }\n value: { ... }\n }>\n }>\n edges: Array<{\n from: string\n to: string\n }>\n}\n```\n\n### `GraphNode`\n\nMirrors entity-api\'s GraphNode (see entity-api openapi.yml).\n\n```ts\ntype GraphNode = {\n id: string\n schema: string\n cardinality?: "one" | "many"\n fields?: string[]\n filter?: Array<{\n attribute: string\n value: string | number | boolean\n }>\n}\n```\n\n### `GraphNodeFilter`\n\nMirrors entity-api\'s GraphNodeFilter (see entity-api openapi.yml).\n\n```ts\ntype GraphNodeFilter = {\n attribute: string\n value: string | number | boolean\n}\n```\n\n### `GraphEdge`\n\nMirrors entity-api\'s GraphEdge (see entity-api openapi.yml).\n\n```ts\ntype GraphEdge = {\n from: string\n to: string\n}\n```\n\n### `MappingAttributeV2`\n\n```ts\ntype MappingAttributeV2 = {\n target: string\n operation: {\n _set?: string | boolean | number | Record<string, unknown> | unknown[]\n _append?: unknown\n _prepend?: unknown\n _uniq?: boolean | string[]\n _retain_old_values?: boolean\n _copy?: string\n _template?: string\n _random?: {\n type: { ... }\n } | {\n type: { ... }\n min?: { ... }\n max?: { ... }\n }\n _each?: string\n _as?: string\n _map?: {\n _set?: { ... }\n _append?: { ... }\n _prepend?: { ... }\n _uniq?: { ... }\n _retain_old_values?: { ... }\n _copy?: { ... }\n _template?: { ... }\n _random?: { ... }\n _each?: { ... }\n _as?: { ... }\n _map?: { ... }\n } | string | boolean | number | Record<string, unknown> | unknown[]\n } | string | boolean | number | Record<string, unknown> | unknown[]\n origin?: "system_recommendation" | "user_manually" | "entity_updating_system_recommendation"\n}\n```\n\n### `AttributeOrigin`\n\nOrigin of an attribute.\n\n```ts\ntype AttributeOrigin = "system_recommendation" | "user_manually" | "entity_updating_system_recommendation"\n```\n\n### `OperationNode`\n\nMapping operation nodes are either primitive values or operation node objects\n\n```ts\ntype OperationNode = {\n _set?: string | boolean | number | Record<string, unknown> | unknown[]\n _append?: unknown\n _prepend?: unknown\n _uniq?: boolean | string[]\n _retain_old_values?: boolean\n _copy?: string\n _template?: string\n _random?: {\n type: "uuid" | "nanoid"\n } | {\n type: "number"\n min?: number\n max?: number\n }\n _each?: string\n _as?: string\n _map?: {\n _set?: string | boolean | number | Record<string, unknown> | unknown[]\n _append?: unknown\n _prepend?: unknown\n _uniq?: boolean | string[]\n _retain_old_values?: boolean\n _copy?: string\n _template?: string\n _random?: {\n type: { ... }\n } | {\n type: { ... }\n min?: { ... }\n max?: { ... }\n }\n _each?: string\n _as?: string\n _map?: {\n _set?: { ... }\n _append?: { ... }\n _prepend?: { ... }\n _uniq?: { ... }\n _retain_old_values?: { ... }\n _copy?: { ... }\n _template?: { ... }\n _random?: { ... }\n _each?: { ... }\n _as?: { ... }\n _map?: { ... }\n } | string | boolean | number | Record<string, unknown> | unknown[]\n } | string | boolean | number | Record<string, unknown> | unknown[]\n} | string | boolean | number | Record<string, unknown> | unknown[]\n```\n\n### `OperationObjectNode`\n\n```ts\ntype OperationObjectNode = {\n _set?: string | boolean | number | Record<string, unknown> | unknown[]\n _append?: unknown\n _prepend?: unknown\n _uniq?: boolean | string[]\n _retain_old_values?: boolean\n _copy?: string\n _template?: string\n _random?: {\n type: "uuid" | "nanoid"\n } | {\n type: "number"\n min?: number\n max?: number\n }\n _each?: string\n _as?: string\n _map?: {\n _set?: string | boolean | number | Record<string, unknown> | unknown[]\n _append?: unknown\n _prepend?: unknown\n _uniq?: boolean | string[]\n _retain_old_values?: boolean\n _copy?: string\n _template?: string\n _random?: {\n type: { ... }\n } | {\n type: { ... }\n min?: { ... }\n max?: { ... }\n }\n _each?: string\n _as?: string\n _map?: {\n _set?: { ... }\n _append?: { ... }\n _prepend?: { ... }\n _uniq?: { ... }\n _retain_old_values?: { ... }\n _copy?: { ... }\n _template?: { ... }\n _random?: { ... }\n _each?: { ... }\n _as?: { ... }\n _map?: { ... }\n } | string | boolean | number | Record<string, unknown> | unknown[]\n } | string | boolean | number | Record<string, unknown> | unknown[]\n}\n```\n\n### `PrimitiveJSONValue`\n\nRepresents any primitive JSON value\n\n```ts\ntype PrimitiveJSONValue = string | boolean | number | Record<string, unknown> | unknown[]\n```\n\n### `RandomOperation`\n\n```ts\ntype RandomOperation = {\n type: "uuid" | "nanoid"\n} | {\n type: "number"\n min?: number\n max?: number\n}\n```\n\n### `MappingAttribute`\n\n```ts\ntype MappingAttribute = {\n mode: "copy_if_exists" | "append_if_exists" | "set_value"\n target: string\n value: unknown\n} | {\n mode: "copy_if_exists" | "append_if_exists" | "set_value"\n target: string\n source: string\n} | {\n mode: "copy_if_exists" | "append_if_exists" | "set_value"\n target: string\n source?: string\n value_json: string\n target_unique?: string[]\n}\n```\n\n### `MappingAttributeMode`\n\n- copy_if_exists - it replaces the target attribute with the source value - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute. - set_value - it sets a value to a predefined value. Must be used togethe\n\n```ts\ntype MappingAttributeMode = "copy_if_exists" | "append_if_exists" | "set_value"\n```\n\n### `SetValueMapper`\n\n```ts\ntype SetValueMapper = {\n mode: "copy_if_exists" | "append_if_exists" | "set_value"\n target: string\n value: unknown\n}\n```\n\n### `CopyValueMapper`\n\n```ts\ntype CopyValueMapper = {\n mode: "copy_if_exists" | "append_if_exists" | "set_value"\n target: string\n source: string\n}\n```\n\n### `AppendValueMapper`\n\n```ts\ntype AppendValueMapper = {\n mode: "copy_if_exists" | "append_if_exists" | "set_value"\n target: string\n source?: string\n value_json: string\n target_unique?: string[]\n}\n```\n\n### `MappingHistoryResp`\n\n```ts\ntype MappingHistoryResp = {\n results: Array<{\n id: string\n timestamp: string // ISO datetime\n source_entity_snapshot: {\n _id?: { ... }\n _schema?: { ... }\n _title?: { ... }\n _org?: { ... }\n _tags?: { ... }\n _created_at?: { ... }\n _updated_at?: { ... }\n required?: { ... }\n }\n mapped_entities_snapshot: Array<{\n _id?: { ... }\n _schema?: { ... }\n _title?: { ... }\n _org?: { ... }\n _tags?: { ... }\n _created_at?: { ... }\n _updated_at?: { ... }\n required?: { ... }\n }>\n target_configs_snapshot: Array<{\n id?: { ... }\n name?: { ... }\n allow_failure?: { ... }\n target_schema: { ... }\n target_unique?: { ... }\n use_uniqueness_criteria?: { ... }\n loop_config?: { ... }\n conditionMode?: { ... }\n conditions?: { ... }\n mapping_attributes: { ... }\n relation_attributes?: { ... }\n linkback_relation_attribute?: { ... }\n linkback_relation_tags?: { ... }\n graph_context?: { ... }\n }>\n }>\n}\n```\n\n### `MappingHistoryEntry`\n\n```ts\ntype MappingHistoryEntry = {\n id: string\n timestamp: string // ISO datetime\n source_entity_snapshot: {\n _id?: string\n _schema?: string\n _title?: string\n _org?: string\n _tags?: string[]\n _created_at?: string\n _updated_at?: string\n required?: unknown\n }\n mapped_entities_snapshot: Array<{\n _id?: string\n _schema?: string\n _title?: string\n _org?: string\n _tags?: string[]\n _created_at?: string\n _updated_at?: string\n required?: unknown\n }>\n target_configs_snapshot: Array<{\n id?: string\n name?: string\n allow_failure?: boolean\n target_schema: string\n target_unique?: string[]\n use_uniqueness_criteria?: boolean\n loop_config?: {\n source_path?: { ... }\n length?: { ... }\n }\n conditionMode?: "oneOf" | "anyOf" | "allOf"\n conditions?: Array<{\n _exists?: { ... }\n _equals?: { ... }\n _not_exists?: { ... }\n _any_of?: { ... }\n }>\n mapping_attributes: Array<{\n target: { ... }\n operation: { ... }\n origin?: { ... }\n } | {\n mode: { ... }\n target: { ... }\n value: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source?: { ... }\n value_json: { ... }\n target_unique?: { ... }\n }>\n relation_attributes?: Array<{\n target: { ... }\n target_tags?: { ... }\n target_tags_include_source?: { ... }\n target_entity_tags?: { ... }\n override_with_source_filter?: { ... }\n source_filter?: { ... }\n related_to?: { ... }\n mode: { ... }\n origin?: { ... }\n }>\n linkback_relation_attribute?: string\n linkback_relation_tags?: string[]\n graph_context?: Array<{\n seed: { ... }\n graph: { ... }\n }>\n }>\n}\n```\n\n### `MappingSource`\n\n```ts\ntype MappingSource = {\n key: string\n sub_properties?: Array<{\n value: string\n label: string\n initial_target_value?: string\n possible_target_types?: "string" | "date" | "datetime" | "boolean" | "number" | "image" | "file" | "address" | "email" | "phone" | "select" | "multiselect" | "payment" | "link" | "currency" | "sequence" | "relation" | "array"[]\n raw?: boolean\n }>\n source_type: string\n group?: string\n possible_target_types?: "string" | "date" | "datetime" | "boolean" | "number" | "image" | "file" | "address" | "email" | "phone" | "select" | "multiselect" | "payment" | "link" | "currency" | "sequence" | "relation" | "array"[]\n initial_relation?: {\n target: string\n target_tags?: string[]\n target_tags_include_source?: boolean\n target_entity_tags?: string[]\n override_with_source_filter?: boolean\n source_filter?: {\n limit?: { ... }\n schema?: { ... }\n attribute?: { ... }\n relation_tag?: { ... }\n tag?: { ... }\n self?: { ... }\n }\n related_to?: Record<string, unknown>\n mode: "append" | "prepend" | "set"\n origin?: "system_recommendation" | "user_manually" | "entity_updating_system_recommendation"\n }\n title: string\n sub_title?: string\n repeatable?: boolean\n target_settings?: {\n allowed_ui_actions?: "schema-select" | "attribute-select" | "target-delete" | "target-add" | "target"[]\n locked?: "each" | "first" | "system_recommendation"\n isSingleTarget?: boolean\n visibility?: {\n mode: { ... }\n if: { ... }\n message?: { ... }\n }\n }\n}\n```\n\n### `MappingSourceProperty`\n\n```ts\ntype MappingSourceProperty = {\n value: string\n label: string\n initial_target_value?: string\n possible_target_types?: "string" | "date" | "datetime" | "boolean" | "number" | "image" | "file" | "address" | "email" | "phone" | "select" | "multiselect" | "payment" | "link" | "currency" | "sequence" | "relation" | "array"[]\n raw?: boolean\n}\n```\n\n### `MappingSourceTargetType`\n\n```ts\ntype MappingSourceTargetType = "string" | "date" | "datetime" | "boolean" | "number" | "image" | "file" | "address" | "email" | "phone" | "select" | "multiselect" | "payment" | "link" | "currency" | "sequence" | "relation" | "array"\n```\n';
4
+ var entity_mapping_default = '# Entity Mapping API\n\n- **Base URL:** `https://entity-mapping.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/entity-mapping](https://docs.epilot.io/api/entity-mapping)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.entityMapping.storeConfig(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/entity-mapping\'\n\nconst entityMappingClient = getClient()\nauthorize(entityMappingClient, () => \'<token>\')\nconst { data } = await entityMappingClient.storeConfig(...)\n```\n\n## Operations\n\n**mappings**\n- [`storeConfig`](#storeconfig)\n- [`getConfig`](#getconfig)\n- [`deleteConfig`](#deleteconfig)\n- [`getAllVersions`](#getallversions)\n- [`storeNewVersion`](#storenewversion)\n- [`getConfigVersion`](#getconfigversion)\n- [`executeMapping`](#executemapping)\n- [`searchConfigs`](#searchconfigs)\n- [`queryMappingHistory`](#querymappinghistory)\n- [`executeRelations`](#executerelations)\n- [`getMappingConfig`](#getmappingconfig)\n- [`putMappingConfig`](#putmappingconfig)\n\n**Schemas**\n- [`SearchMappingReq`](#searchmappingreq)\n- [`MappingConfigsResp`](#mappingconfigsresp)\n- [`MappingConfigs`](#mappingconfigs)\n- [`MappingConfig`](#mappingconfig)\n- [`MappingConfigV2`](#mappingconfigv2)\n- [`MappingConfigCommonFields`](#mappingconfigcommonfields)\n- [`Owner`](#owner)\n- [`ExecuteRelationsReq`](#executerelationsreq)\n- [`ExecuteRelationsResp`](#executerelationsresp)\n- [`NewRelationItem`](#newrelationitem)\n- [`RelationItem`](#relationitem)\n- [`ExecuteMappingReq`](#executemappingreq)\n- [`ExecuteMappingResp`](#executemappingresp)\n- [`MappingFailure`](#mappingfailure)\n- [`MappingWarning`](#mappingwarning)\n- [`Entity`](#entity)\n- [`EntityRef`](#entityref)\n- [`SourceConfig`](#sourceconfig)\n- [`JourneyRef`](#journeyref)\n- [`Loop_Index_String`](#loop_index_string)\n- [`TargetConfig`](#targetconfig)\n- [`MapCondition`](#mapcondition)\n- [`ConditionNode`](#conditionnode)\n- [`RelationAttribute`](#relationattribute)\n- [`GraphContextEntry`](#graphcontextentry)\n- [`GraphSeed`](#graphseed)\n- [`GraphDefinition`](#graphdefinition)\n- [`GraphNode`](#graphnode)\n- [`GraphNodeFilter`](#graphnodefilter)\n- [`GraphEdge`](#graphedge)\n- [`MappingAttributeV2`](#mappingattributev2)\n- [`AttributeOrigin`](#attributeorigin)\n- [`OperationNode`](#operationnode)\n- [`OperationObjectNode`](#operationobjectnode)\n- [`PrimitiveJSONValue`](#primitivejsonvalue)\n- [`RandomOperation`](#randomoperation)\n- [`MappingAttribute`](#mappingattribute)\n- [`MappingAttributeMode`](#mappingattributemode)\n- [`SetValueMapper`](#setvaluemapper)\n- [`CopyValueMapper`](#copyvaluemapper)\n- [`AppendValueMapper`](#appendvaluemapper)\n- [`MappingHistoryResp`](#mappinghistoryresp)\n- [`MappingHistoryEntry`](#mappinghistoryentry)\n- [`MappingSource`](#mappingsource)\n- [`MappingSourceProperty`](#mappingsourceproperty)\n- [`MappingSourceTargetType`](#mappingsourcetargettype)\n\n### `storeConfig`\n\nStore new MappingConfig\n\n`POST /v1/mappings`\n\n```ts\nconst { data } = await client.storeConfig(\n {\n with_id: \'example\',\n },\n {\n id: \'string\',\n source: {\n type: \'journey\',\n config: {\n journey_id: \'string\'\n }\n },\n targets: [\n {\n id: \'string\',\n name: \'string\',\n allow_failure: true,\n target_schema: \'string\',\n target_unique: [\'string\'],\n use_uniqueness_criteria: false,\n loop_config: { /* ... */ },\n conditionMode: \'oneOf\',\n conditions: [ /* ... */ ],\n mapping_attributes: [ /* ... */ ],\n relation_attributes: [ /* ... */ ],\n linkback_relation_attribute: \'mapped_entities\',\n linkback_relation_tags: [\'string\'],\n graph_context: [ /* ... */ ]\n }\n ],\n created_at: \'1970-01-01T00:00:00.000Z\',\n updated_at: \'1970-01-01T00:00:00.000Z\',\n created_by: {\n type: \'user\',\n org_id: \'string\',\n user_id: \'string\'\n },\n last_updated_by: {\n type: \'user\',\n org_id: \'string\',\n user_id: \'string\'\n },\n org_id: \'66\',\n version: 2\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "source": {\n "type": "journey",\n "config": {\n "journey_id": "string"\n }\n },\n "targets": [\n {\n "id": "string",\n "name": "string",\n "allow_failure": true,\n "target_schema": "string",\n "target_unique": ["string"],\n "use_uniqueness_criteria": false,\n "loop_config": {},\n "conditionMode": "oneOf",\n "conditions": [],\n "mapping_attributes": [],\n "relation_attributes": [],\n "linkback_relation_attribute": "mapped_entities",\n "linkback_relation_tags": ["string"],\n "graph_context": []\n }\n ],\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "created_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "last_updated_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "org_id": "66",\n "version": 2\n}\n```\n\n</details>\n\n---\n\n### `getConfig`\n\nGet latest version of a mapping config by id\n\n`GET /v1/mappings/{id}`\n\n```ts\nconst { data } = await client.getConfig({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "source": {\n "type": "journey",\n "config": {\n "journey_id": "string"\n }\n },\n "targets": [\n {\n "id": "string",\n "name": "string",\n "allow_failure": true,\n "target_schema": "string",\n "target_unique": ["string"],\n "use_uniqueness_criteria": false,\n "loop_config": {},\n "conditionMode": "oneOf",\n "conditions": [],\n "mapping_attributes": [],\n "relation_attributes": [],\n "linkback_relation_attribute": "mapped_entities",\n "linkback_relation_tags": ["string"],\n "graph_context": []\n }\n ],\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "created_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "last_updated_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "org_id": "66",\n "version": 2\n}\n```\n\n</details>\n\n---\n\n### `deleteConfig`\n\nDelete entity mapping config\n\n`DELETE /v1/mappings/{id}`\n\n```ts\nconst { data } = await client.deleteConfig({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "source": {\n "type": "journey",\n "config": {\n "journey_id": "string"\n }\n },\n "targets": [\n {\n "id": "string",\n "name": "string",\n "allow_failure": true,\n "target_schema": "string",\n "target_unique": ["string"],\n "use_uniqueness_criteria": false,\n "loop_config": {},\n "conditionMode": "oneOf",\n "conditions": [],\n "mapping_attributes": [],\n "relation_attributes": [],\n "linkback_relation_attribute": "mapped_entities",\n "linkback_relation_tags": ["string"],\n "graph_context": []\n }\n ],\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "created_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "last_updated_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "org_id": "66",\n "version": 2\n}\n```\n\n</details>\n\n---\n\n### `getAllVersions`\n\nGet all version of MappingConfig\n\n`GET /v1/mappings/{id}/versions`\n\n```ts\nconst { data } = await client.getAllVersions({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "configs": [\n {\n "id": "string",\n "source": {},\n "targets": [],\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "created_by": {},\n "last_updated_by": {},\n "org_id": "66",\n "version": 2\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `storeNewVersion`\n\nStore new version of MappingConfig\n\n`POST /v1/mappings/{id}/versions`\n\n```ts\nconst { data } = await client.storeNewVersion(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n id: \'string\',\n source: {\n type: \'journey\',\n config: {\n journey_id: \'string\'\n }\n },\n targets: [\n {\n id: \'string\',\n name: \'string\',\n allow_failure: true,\n target_schema: \'string\',\n target_unique: [\'string\'],\n use_uniqueness_criteria: false,\n loop_config: { /* ... */ },\n conditionMode: \'oneOf\',\n conditions: [ /* ... */ ],\n mapping_attributes: [ /* ... */ ],\n relation_attributes: [ /* ... */ ],\n linkback_relation_attribute: \'mapped_entities\',\n linkback_relation_tags: [\'string\'],\n graph_context: [ /* ... */ ]\n }\n ],\n created_at: \'1970-01-01T00:00:00.000Z\',\n updated_at: \'1970-01-01T00:00:00.000Z\',\n created_by: {\n type: \'user\',\n org_id: \'string\',\n user_id: \'string\'\n },\n last_updated_by: {\n type: \'user\',\n org_id: \'string\',\n user_id: \'string\'\n },\n org_id: \'66\',\n version: 2\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "source": {\n "type": "journey",\n "config": {\n "journey_id": "string"\n }\n },\n "targets": [\n {\n "id": "string",\n "name": "string",\n "allow_failure": true,\n "target_schema": "string",\n "target_unique": ["string"],\n "use_uniqueness_criteria": false,\n "loop_config": {},\n "conditionMode": "oneOf",\n "conditions": [],\n "mapping_attributes": [],\n "relation_attributes": [],\n "linkback_relation_attribute": "mapped_entities",\n "linkback_relation_tags": ["string"],\n "graph_context": []\n }\n ],\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "created_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "last_updated_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "org_id": "66",\n "version": 2\n}\n```\n\n</details>\n\n---\n\n### `getConfigVersion`\n\nGet specific version of a mapping config by id & version\n\n`GET /v1/mappings/{id}/versions/{version}`\n\n```ts\nconst { data } = await client.getConfigVersion({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n version: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "source": {\n "type": "journey",\n "config": {\n "journey_id": "string"\n }\n },\n "targets": [\n {\n "id": "string",\n "name": "string",\n "allow_failure": true,\n "target_schema": "string",\n "target_unique": ["string"],\n "use_uniqueness_criteria": false,\n "loop_config": {},\n "conditionMode": "oneOf",\n "conditions": [],\n "mapping_attributes": [],\n "relation_attributes": [],\n "linkback_relation_attribute": "mapped_entities",\n "linkback_relation_tags": ["string"],\n "graph_context": []\n }\n ],\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "created_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "last_updated_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "org_id": "66",\n "version": 2\n}\n```\n\n</details>\n\n---\n\n### `executeMapping`\n\nExecute entity mapping based on a config\n\n`POST /v1/mappings:execute`\n\n```ts\nconst { data } = await client.executeMapping(\n {\n preview_mode: true,\n },\n {\n source_ref: {\n entity_id: \'string\',\n entity_schema: \'submission\'\n },\n loop_ref: {\n entity_id: \'string\',\n entity_schema: \'submission\'\n },\n targets: [\n {\n id: \'string\',\n name: \'string\',\n allow_failure: true,\n target_schema: \'string\',\n target_unique: [\'string\'],\n use_uniqueness_criteria: false,\n loop_config: { /* ... */ },\n conditionMode: \'oneOf\',\n conditions: [ /* ... */ ],\n mapping_attributes: [ /* ... */ ],\n relation_attributes: [ /* ... */ ],\n linkback_relation_attribute: \'mapped_entities\',\n linkback_relation_tags: [\'string\'],\n graph_context: [ /* ... */ ]\n }\n ]\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "mapped_entities": [\n {\n "_id": "string",\n "_schema": "string",\n "_title": "string",\n "_org": "string",\n "_tags": ["string"],\n "_created_at": "string",\n "_updated_at": "string",\n "required": {}\n }\n ],\n "failures": [\n {\n "target": {},\n "error": {}\n }\n ],\n "warnings": [\n {\n "explanation": "string",\n "context": "string",\n "id": "string"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `searchConfigs`\n\nSearch mapping configs\n\n`POST /v1/mappings:search`\n\n```ts\nconst { data } = await client.searchConfigs(\n null,\n {\n source: {\n type: \'journey\',\n config: {\n journey_id: \'string\'\n }\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "source": {\n "type": "journey",\n "config": {\n "journey_id": "string"\n }\n },\n "targets": [\n {\n "id": "string",\n "name": "string",\n "allow_failure": true,\n "target_schema": "string",\n "target_unique": ["string"],\n "use_uniqueness_criteria": false,\n "loop_config": {},\n "conditionMode": "oneOf",\n "conditions": [],\n "mapping_attributes": [],\n "relation_attributes": [],\n "linkback_relation_attribute": "mapped_entities",\n "linkback_relation_tags": ["string"],\n "graph_context": []\n }\n ],\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "created_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "last_updated_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "org_id": "66",\n "version": 2\n}\n```\n\n</details>\n\n---\n\n### `queryMappingHistory`\n\nGet the Mapping History\n\n`GET /v1/mappings/history`\n\n```ts\nconst { data } = await client.queryMappingHistory({\n from: \'example\',\n to: \'example\',\n targetEntityId: \'example\',\n sourceEntityId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{}\n```\n\n</details>\n\n---\n\n### `executeRelations`\n\nExecute relation mapping between source entity and target entities\n\n`POST /v1/relations:execute`\n\n```ts\nconst { data } = await client.executeRelations(\n null,\n {\n source_ref: {\n entity_id: \'string\',\n entity_schema: \'submission\'\n },\n target: {\n main_entity_ref: {\n entity_id: \'string\',\n entity_schema: \'submission\'\n },\n relation_attributes: [\n {\n target: \'string\',\n target_tags: [\'string\'],\n target_tags_include_source: false,\n target_entity_tags: [\'string\'],\n override_with_source_filter: false,\n source_filter: {\n limit: 0,\n schema: \'string\',\n attribute: \'string\',\n relation_tag: \'string\',\n tag: \'string\',\n self: false\n },\n related_to: {},\n mode: \'append\',\n origin: \'system_recommendation\'\n }\n ],\n linkback: {\n attribute: \'mapped_entities\',\n relation_tags: [\'string\']\n }\n },\n additional_relations: [\n {\n entity_id: \'string\',\n attribute: \'string\'\n }\n ]\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "relations": [\n {\n "source_entity_id": "string",\n "target_entity_id": "string",\n "relation_attr": "string",\n "tags": ["string"]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getMappingConfig`\n\nGet latest version of a mapping config by id V2\n\n`GET /v2/mappings/{id}`\n\n```ts\nconst { data } = await client.getMappingConfig({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "source": {\n "type": "journey",\n "config": {\n "journey_id": "string"\n }\n },\n "targets": [\n {\n "id": "string",\n "name": "string",\n "allow_failure": true,\n "target_schema": "string",\n "target_unique": ["string"],\n "use_uniqueness_criteria": false,\n "loop_config": {},\n "conditionMode": "oneOf",\n "conditions": [],\n "mapping_attributes": [],\n "relation_attributes": [],\n "linkback_relation_attribute": "mapped_entities",\n "linkback_relation_tags": ["string"],\n "graph_context": []\n }\n ],\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "created_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "last_updated_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "org_id": "66",\n "version": 2\n}\n```\n\n</details>\n\n---\n\n### `putMappingConfig`\n\nStores new version of entity mapping config\n\n`PUT /v2/mappings/{id}`\n\n```ts\nconst { data } = await client.putMappingConfig(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n id: \'string\',\n source: {\n type: \'journey\',\n config: {\n journey_id: \'string\'\n }\n },\n targets: [\n {\n id: \'string\',\n name: \'string\',\n allow_failure: true,\n target_schema: \'string\',\n target_unique: [\'string\'],\n use_uniqueness_criteria: false,\n loop_config: { /* ... */ },\n conditionMode: \'oneOf\',\n conditions: [ /* ... */ ],\n mapping_attributes: [ /* ... */ ],\n relation_attributes: [ /* ... */ ],\n linkback_relation_attribute: \'mapped_entities\',\n linkback_relation_tags: [\'string\'],\n graph_context: [ /* ... */ ]\n }\n ],\n created_at: \'1970-01-01T00:00:00.000Z\',\n updated_at: \'1970-01-01T00:00:00.000Z\',\n created_by: {\n type: \'user\',\n org_id: \'string\',\n user_id: \'string\'\n },\n last_updated_by: {\n type: \'user\',\n org_id: \'string\',\n user_id: \'string\'\n },\n org_id: \'66\',\n version: 2\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "source": {\n "type": "journey",\n "config": {\n "journey_id": "string"\n }\n },\n "targets": [\n {\n "id": "string",\n "name": "string",\n "allow_failure": true,\n "target_schema": "string",\n "target_unique": ["string"],\n "use_uniqueness_criteria": false,\n "loop_config": {},\n "conditionMode": "oneOf",\n "conditions": [],\n "mapping_attributes": [],\n "relation_attributes": [],\n "linkback_relation_attribute": "mapped_entities",\n "linkback_relation_tags": ["string"],\n "graph_context": []\n }\n ],\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "created_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "last_updated_by": {\n "type": "user",\n "org_id": "string",\n "user_id": "string"\n },\n "org_id": "66",\n "version": 2\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `SearchMappingReq`\n\n```ts\ntype SearchMappingReq = {\n source?: {\n type?: "journey" | "entity"\n config?: {\n journey_id?: { ... }\n } | {\n entity_id: { ... }\n entity_schema?: { ... }\n }\n }\n}\n```\n\n### `MappingConfigsResp`\n\n```ts\ntype MappingConfigsResp = {\n configs: Array<{\n id: string\n source: {\n type?: { ... }\n config?: { ... }\n }\n targets: Array<{\n id?: { ... }\n name?: { ... }\n allow_failure?: { ... }\n target_schema: { ... }\n target_unique?: { ... }\n use_uniqueness_criteria?: { ... }\n loop_config?: { ... }\n conditionMode?: { ... }\n conditions?: { ... }\n mapping_attributes: { ... }\n relation_attributes?: { ... }\n linkback_relation_attribute?: { ... }\n linkback_relation_tags?: { ... }\n graph_context?: { ... }\n }>\n created_at?: string // date-time\n updated_at?: string // date-time\n created_by?: {\n type: { ... }\n org_id?: { ... }\n user_id?: { ... }\n }\n last_updated_by?: {\n type: { ... }\n org_id?: { ... }\n user_id?: { ... }\n }\n org_id?: string\n version?: number\n }>\n}\n```\n\n### `MappingConfigs`\n\n```ts\ntype MappingConfigs = Array<{\n id: string\n source: {\n type?: "journey" | "entity"\n config?: {\n journey_id?: { ... }\n } | {\n entity_id: { ... }\n entity_schema?: { ... }\n }\n }\n targets: Array<{\n id?: string\n name?: string\n allow_failure?: boolean\n target_schema: string\n target_unique?: string[]\n use_uniqueness_criteria?: boolean\n loop_config?: {\n source_path?: { ... }\n source_type?: { ... }\n filter_tags?: { ... }\n length?: { ... }\n }\n conditionMode?: "oneOf" | "anyOf" | "allOf"\n conditions?: Array<{\n _exists?: { ... }\n _equals?: { ... }\n _not_exists?: { ... }\n _any_of?: { ... }\n }>\n mapping_attributes: Array<{\n target: { ... }\n operation: { ... }\n origin?: { ... }\n } | {\n mode: { ... }\n target: { ... }\n value: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source?: { ... }\n value_json: { ... }\n target_unique?: { ... }\n }>\n relation_attributes?: Array<{\n target: { ... }\n target_tags?: { ... }\n target_tags_include_source?: { ... }\n target_entity_tags?: { ... }\n override_with_source_filter?: { ... }\n source_filter?: { ... }\n related_to?: { ... }\n mode: { ... }\n origin?: { ... }\n }>\n linkback_relation_attribute?: string\n linkback_relation_tags?: string[]\n graph_context?: Array<{\n seed: { ... }\n graph: { ... }\n }>\n }>\n created_at?: string // date-time\n updated_at?: string // date-time\n created_by?: {\n type: "user" | "internal_service"\n org_id?: string\n user_id?: string\n }\n last_updated_by?: {\n type: "user" | "internal_service"\n org_id?: string\n user_id?: string\n }\n org_id?: string\n version?: number\n}>\n```\n\n### `MappingConfig`\n\n```ts\ntype MappingConfig = {\n id: string\n source: {\n type?: "journey" | "entity"\n config?: {\n journey_id?: { ... }\n } | {\n entity_id: { ... }\n entity_schema?: { ... }\n }\n }\n targets: Array<{\n id?: string\n name?: string\n allow_failure?: boolean\n target_schema: string\n target_unique?: string[]\n use_uniqueness_criteria?: boolean\n loop_config?: {\n source_path?: { ... }\n source_type?: { ... }\n filter_tags?: { ... }\n length?: { ... }\n }\n conditionMode?: "oneOf" | "anyOf" | "allOf"\n conditions?: Array<{\n _exists?: { ... }\n _equals?: { ... }\n _not_exists?: { ... }\n _any_of?: { ... }\n }>\n mapping_attributes: Array<{\n target: { ... }\n operation: { ... }\n origin?: { ... }\n } | {\n mode: { ... }\n target: { ... }\n value: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source?: { ... }\n value_json: { ... }\n target_unique?: { ... }\n }>\n relation_attributes?: Array<{\n target: { ... }\n target_tags?: { ... }\n target_tags_include_source?: { ... }\n target_entity_tags?: { ... }\n override_with_source_filter?: { ... }\n source_filter?: { ... }\n related_to?: { ... }\n mode: { ... }\n origin?: { ... }\n }>\n linkback_relation_attribute?: string\n linkback_relation_tags?: string[]\n graph_context?: Array<{\n seed: { ... }\n graph: { ... }\n }>\n }>\n created_at?: string // date-time\n updated_at?: string // date-time\n created_by?: {\n type: "user" | "internal_service"\n org_id?: string\n user_id?: string\n }\n last_updated_by?: {\n type: "user" | "internal_service"\n org_id?: string\n user_id?: string\n }\n org_id?: string\n version?: number\n}\n```\n\n### `MappingConfigV2`\n\n```ts\ntype MappingConfigV2 = {\n id: string\n source: {\n type?: "journey" | "entity"\n config?: {\n journey_id?: { ... }\n } | {\n entity_id: { ... }\n entity_schema?: { ... }\n }\n }\n targets: Array<{\n id?: string\n name?: string\n allow_failure?: boolean\n target_schema: string\n target_unique?: string[]\n use_uniqueness_criteria?: boolean\n loop_config?: {\n source_path?: { ... }\n source_type?: { ... }\n filter_tags?: { ... }\n length?: { ... }\n }\n conditionMode?: "oneOf" | "anyOf" | "allOf"\n conditions?: Array<{\n _exists?: { ... }\n _equals?: { ... }\n _not_exists?: { ... }\n _any_of?: { ... }\n }>\n mapping_attributes: Array<{\n target: { ... }\n operation: { ... }\n origin?: { ... }\n } | {\n mode: { ... }\n target: { ... }\n value: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source?: { ... }\n value_json: { ... }\n target_unique?: { ... }\n }>\n relation_attributes?: Array<{\n target: { ... }\n target_tags?: { ... }\n target_tags_include_source?: { ... }\n target_entity_tags?: { ... }\n override_with_source_filter?: { ... }\n source_filter?: { ... }\n related_to?: { ... }\n mode: { ... }\n origin?: { ... }\n }>\n linkback_relation_attribute?: string\n linkback_relation_tags?: string[]\n graph_context?: Array<{\n seed: { ... }\n graph: { ... }\n }>\n }>\n created_at?: string // date-time\n updated_at?: string // date-time\n created_by?: {\n type: "user" | "internal_service"\n org_id?: string\n user_id?: string\n }\n last_updated_by?: {\n type: "user" | "internal_service"\n org_id?: string\n user_id?: string\n }\n org_id?: string\n version?: number\n}\n```\n\n### `MappingConfigCommonFields`\n\n```ts\ntype MappingConfigCommonFields = {\n id: string\n source: {\n type?: "journey" | "entity"\n config?: {\n journey_id?: { ... }\n } | {\n entity_id: { ... }\n entity_schema?: { ... }\n }\n }\n targets: Array<{\n id?: string\n name?: string\n allow_failure?: boolean\n target_schema: string\n target_unique?: string[]\n use_uniqueness_criteria?: boolean\n loop_config?: {\n source_path?: { ... }\n source_type?: { ... }\n filter_tags?: { ... }\n length?: { ... }\n }\n conditionMode?: "oneOf" | "anyOf" | "allOf"\n conditions?: Array<{\n _exists?: { ... }\n _equals?: { ... }\n _not_exists?: { ... }\n _any_of?: { ... }\n }>\n mapping_attributes: Array<{\n target: { ... }\n operation: { ... }\n origin?: { ... }\n } | {\n mode: { ... }\n target: { ... }\n value: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source?: { ... }\n value_json: { ... }\n target_unique?: { ... }\n }>\n relation_attributes?: Array<{\n target: { ... }\n target_tags?: { ... }\n target_tags_include_source?: { ... }\n target_entity_tags?: { ... }\n override_with_source_filter?: { ... }\n source_filter?: { ... }\n related_to?: { ... }\n mode: { ... }\n origin?: { ... }\n }>\n linkback_relation_attribute?: string\n linkback_relation_tags?: string[]\n graph_context?: Array<{\n seed: { ... }\n graph: { ... }\n }>\n }>\n created_at?: string // date-time\n updated_at?: string // date-time\n created_by?: {\n type: "user" | "internal_service"\n org_id?: string\n user_id?: string\n }\n last_updated_by?: {\n type: "user" | "internal_service"\n org_id?: string\n user_id?: string\n }\n}\n```\n\n### `Owner`\n\n```ts\ntype Owner = {\n type: "user" | "internal_service"\n org_id?: string\n user_id?: string\n}\n```\n\n### `ExecuteRelationsReq`\n\nBuild relations between a source entity and one or more target entities, dynamically identified\n\n```ts\ntype ExecuteRelationsReq = {\n source_ref: {\n entity_id: string\n entity_schema?: string\n }\n target?: {\n main_entity_ref: {\n entity_id: { ... }\n entity_schema?: { ... }\n }\n relation_attributes: Array<{\n target: { ... }\n target_tags?: { ... }\n target_tags_include_source?: { ... }\n target_entity_tags?: { ... }\n override_with_source_filter?: { ... }\n source_filter?: { ... }\n related_to?: { ... }\n mode: { ... }\n origin?: { ... }\n }>\n linkback?: {\n attribute: { ... }\n relation_tags: { ... }\n }\n }\n additional_relations?: Array<{\n entity_id: string\n attribute: string\n }>\n}\n```\n\n### `ExecuteRelationsResp`\n\n```ts\ntype ExecuteRelationsResp = {\n relations?: Array<{\n source_entity_id: string\n target_entity_id: string\n relation_attr: string\n tags?: string[]\n }>\n}\n```\n\n### `NewRelationItem`\n\n```ts\ntype NewRelationItem = {\n source_entity_id: string\n target_entity_id: string\n relation_attr: string\n tags?: string[]\n}\n```\n\n### `RelationItem`\n\n```ts\ntype RelationItem = {\n entity_id: string\n attribute: string\n}\n```\n\n### `ExecuteMappingReq`\n\nPass either source or source_entity\n\n```ts\ntype ExecuteMappingReq = {\n source_ref: {\n entity_id: string\n entity_schema?: string\n }\n loop_ref?: {\n entity_id: string\n entity_schema?: string\n }\n targets: Array<{\n id?: string\n name?: string\n allow_failure?: boolean\n target_schema: string\n target_unique?: string[]\n use_uniqueness_criteria?: boolean\n loop_config?: {\n source_path?: { ... }\n source_type?: { ... }\n filter_tags?: { ... }\n length?: { ... }\n }\n conditionMode?: "oneOf" | "anyOf" | "allOf"\n conditions?: Array<{\n _exists?: { ... }\n _equals?: { ... }\n _not_exists?: { ... }\n _any_of?: { ... }\n }>\n mapping_attributes: Array<{\n target: { ... }\n operation: { ... }\n origin?: { ... }\n } | {\n mode: { ... }\n target: { ... }\n value: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source?: { ... }\n value_json: { ... }\n target_unique?: { ... }\n }>\n relation_attributes?: Array<{\n target: { ... }\n target_tags?: { ... }\n target_tags_include_source?: { ... }\n target_entity_tags?: { ... }\n override_with_source_filter?: { ... }\n source_filter?: { ... }\n related_to?: { ... }\n mode: { ... }\n origin?: { ... }\n }>\n linkback_relation_attribute?: string\n linkback_relation_tags?: string[]\n graph_context?: Array<{\n seed: { ... }\n graph: { ... }\n }>\n }>\n}\n```\n\n### `ExecuteMappingResp`\n\n```ts\ntype ExecuteMappingResp = {\n mapped_entities: Array<{\n _id?: string\n _schema?: string\n _title?: string\n _org?: string\n _tags?: string[]\n _created_at?: string\n _updated_at?: string\n required?: unknown\n }>\n failures?: Array<{\n target?: {\n id?: { ... }\n name?: { ... }\n allow_failure?: { ... }\n target_schema: { ... }\n target_unique?: { ... }\n use_uniqueness_criteria?: { ... }\n loop_config?: { ... }\n conditionMode?: { ... }\n conditions?: { ... }\n mapping_attributes: { ... }\n relation_attributes?: { ... }\n linkback_relation_attribute?: { ... }\n linkback_relation_tags?: { ... }\n graph_context?: { ... }\n }\n error?: {\n isSilent?: { ... }\n message?: { ... }\n }\n }>\n warnings?: Array<{\n explanation: string\n context?: string\n id?: string\n }>\n}\n```\n\n### `MappingFailure`\n\n```ts\ntype MappingFailure = {\n target?: {\n id?: string\n name?: string\n allow_failure?: boolean\n target_schema: string\n target_unique?: string[]\n use_uniqueness_criteria?: boolean\n loop_config?: {\n source_path?: { ... }\n source_type?: { ... }\n filter_tags?: { ... }\n length?: { ... }\n }\n conditionMode?: "oneOf" | "anyOf" | "allOf"\n conditions?: Array<{\n _exists?: { ... }\n _equals?: { ... }\n _not_exists?: { ... }\n _any_of?: { ... }\n }>\n mapping_attributes: Array<{\n target: { ... }\n operation: { ... }\n origin?: { ... }\n } | {\n mode: { ... }\n target: { ... }\n value: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source?: { ... }\n value_json: { ... }\n target_unique?: { ... }\n }>\n relation_attributes?: Array<{\n target: { ... }\n target_tags?: { ... }\n target_tags_include_source?: { ... }\n target_entity_tags?: { ... }\n override_with_source_filter?: { ... }\n source_filter?: { ... }\n related_to?: { ... }\n mode: { ... }\n origin?: { ... }\n }>\n linkback_relation_attribute?: string\n linkback_relation_tags?: string[]\n graph_context?: Array<{\n seed: { ... }\n graph: { ... }\n }>\n }\n error?: {\n isSilent?: boolean\n message?: string\n }\n}\n```\n\n### `MappingWarning`\n\n```ts\ntype MappingWarning = {\n explanation: string\n context?: string\n id?: string\n}\n```\n\n### `Entity`\n\n```ts\ntype Entity = {\n _id?: string\n _schema?: string\n _title?: string\n _org?: string\n _tags?: string[]\n _created_at?: string\n _updated_at?: string\n required?: unknown\n}\n```\n\n### `EntityRef`\n\n```ts\ntype EntityRef = {\n entity_id: string\n entity_schema?: string\n}\n```\n\n### `SourceConfig`\n\n```ts\ntype SourceConfig = {\n type?: "journey" | "entity"\n config?: {\n journey_id?: string\n } | {\n entity_id: string\n entity_schema?: string\n }\n}\n```\n\n### `JourneyRef`\n\n```ts\ntype JourneyRef = {\n journey_id?: string\n}\n```\n\n### `Loop_Index_String`\n\nThis string value will be replaced with the value of the loop index, when mapping in loop mode\n\n```ts\ntype Loop_Index_String = "##LOOP_INDEX##"\n```\n\n### `TargetConfig`\n\n```ts\ntype TargetConfig = {\n id?: string\n name?: string\n allow_failure?: boolean\n target_schema: string\n target_unique?: string[]\n use_uniqueness_criteria?: boolean\n loop_config?: {\n source_path?: string\n source_type?: "journey-multi-select" | "journey-file-upload"\n filter_tags?: string[]\n length?: number\n }\n conditionMode?: "oneOf" | "anyOf" | "allOf"\n conditions?: Array<{\n _exists?: {\n source?: { ... }\n value?: { ... }\n }\n _equals?: {\n source?: { ... }\n value?: { ... }\n }\n _not_exists?: {\n source?: { ... }\n value?: { ... }\n }\n _any_of?: {\n source?: { ... }\n value?: { ... }\n }\n }>\n mapping_attributes: Array<{\n target: string\n operation: {\n _set?: { ... }\n _append?: { ... }\n _prepend?: { ... }\n _uniq?: { ... }\n _retain_old_values?: { ... }\n _copy?: { ... }\n _template?: { ... }\n _random?: { ... }\n _each?: { ... }\n _as?: { ... }\n _map?: { ... }\n } | string | boolean | number | Record<string, unknown> | unknown[]\n origin?: "system_recommendation" | "user_manually" | "entity_updating_system_recommendation"\n } | {\n mode: "copy_if_exists" | "append_if_exists" | "set_value"\n target: string\n value: unknown\n } | {\n mode: "copy_if_exists" | "append_if_exists" | "set_value"\n target: string\n source: string\n } | {\n mode: "copy_if_exists" | "append_if_exists" | "set_value"\n target: string\n source?: string\n value_json: string\n target_unique?: string[]\n }>\n relation_attributes?: Array<{\n target: string\n target_tags?: string[]\n target_tags_include_source?: boolean\n target_entity_tags?: string[]\n override_with_source_filter?: boolean\n source_filter?: {\n limit?: { ... }\n schema?: { ... }\n attribute?: { ... }\n relation_tag?: { ... }\n tag?: { ... }\n self?: { ... }\n }\n related_to?: Record<string, unknown>\n mode: "append" | "prepend" | "set"\n origin?: "system_recommendation" | "user_manually" | "entity_updating_system_recommendation"\n }>\n linkback_relation_attribute?: string\n linkback_relation_tags?: string[]\n graph_context?: Array<{\n seed: {\n entity_id: { ... }\n node_id: { ... }\n }\n graph: {\n nodes: { ... }\n edges: { ... }\n }\n }>\n}\n```\n\n### `MapCondition`\n\n```ts\ntype MapCondition = {\n _exists?: {\n source?: string\n value?: string | number | object | object[]\n }\n _equals?: {\n source?: string\n value?: string | number | object | object[]\n }\n _not_exists?: {\n source?: string\n value?: string | number | object | object[]\n }\n _any_of?: {\n source?: string\n value?: string | number | object | object[]\n }\n}\n```\n\n### `ConditionNode`\n\n```ts\ntype ConditionNode = {\n source?: string\n value?: string | number | object | object[]\n}\n```\n\n### `RelationAttribute`\n\n```ts\ntype RelationAttribute = {\n target: string\n target_tags?: string[]\n target_tags_include_source?: boolean\n target_entity_tags?: string[]\n override_with_source_filter?: boolean\n source_filter?: {\n limit?: number\n schema?: string\n attribute?: string\n relation_tag?: string\n tag?: string\n self?: boolean\n }\n related_to?: Record<string, unknown>\n mode: "append" | "prepend" | "set"\n origin?: "system_recommendation" | "user_manually" | "entity_updating_system_recommendation"\n}\n```\n\n### `GraphContextEntry`\n\nOne multi-hop graph lookup against entity-api\'s `POST /v1/entity:graph`, resolved during\ngraph_context enrichment (before mapping_attributes are evaluated). Every node in `graph.nodes`\nis merged into sourceContext under its own `id`, so listing several nodes here costs one\nentity-api call, not one p\n\n```ts\ntype GraphContextEntry = {\n seed: {\n entity_id: string\n node_id: string\n }\n graph: {\n nodes: Array<{\n id: { ... }\n schema: { ... }\n cardinality?: { ... }\n fields?: { ... }\n filter?: { ... }\n optional?: { ... }\n }>\n edges: Array<{\n from: { ... }\n to: { ... }\n }>\n }\n}\n```\n\n### `GraphSeed`\n\nMirrors entity-api\'s GraphSeed (see entity-api openapi.yml) - the entity the graph traversal starts from.\n\n```ts\ntype GraphSeed = {\n entity_id: string\n node_id: string\n}\n```\n\n### `GraphDefinition`\n\nMirrors entity-api\'s GraphDefinition (see entity-api openapi.yml) - the shape of the graph to traverse.\n\n```ts\ntype GraphDefinition = {\n nodes: Array<{\n id: string\n schema: string\n cardinality?: "one" | "many"\n fields?: string[]\n filter?: Array<{\n attribute: { ... }\n value: { ... }\n }>\n optional?: boolean\n }>\n edges: Array<{\n from: string\n to: string\n }>\n}\n```\n\n### `GraphNode`\n\nMirrors entity-api\'s GraphNode (see entity-api openapi.yml).\n\n```ts\ntype GraphNode = {\n id: string\n schema: string\n cardinality?: "one" | "many"\n fields?: string[]\n filter?: Array<{\n attribute: string\n value: string | number | boolean\n }>\n optional?: boolean\n}\n```\n\n### `GraphNodeFilter`\n\nMirrors entity-api\'s GraphNodeFilter (see entity-api openapi.yml).\n\n```ts\ntype GraphNodeFilter = {\n attribute: string\n value: string | number | boolean\n}\n```\n\n### `GraphEdge`\n\nMirrors entity-api\'s GraphEdge (see entity-api openapi.yml).\n\n```ts\ntype GraphEdge = {\n from: string\n to: string\n}\n```\n\n### `MappingAttributeV2`\n\n```ts\ntype MappingAttributeV2 = {\n target: string\n operation: {\n _set?: string | boolean | number | Record<string, unknown> | unknown[]\n _append?: unknown\n _prepend?: unknown\n _uniq?: boolean | string[]\n _retain_old_values?: boolean\n _copy?: string\n _template?: string\n _random?: {\n type: { ... }\n } | {\n type: { ... }\n min?: { ... }\n max?: { ... }\n }\n _each?: string\n _as?: string\n _map?: {\n _set?: { ... }\n _append?: { ... }\n _prepend?: { ... }\n _uniq?: { ... }\n _retain_old_values?: { ... }\n _copy?: { ... }\n _template?: { ... }\n _random?: { ... }\n _each?: { ... }\n _as?: { ... }\n _map?: { ... }\n } | string | boolean | number | Record<string, unknown> | unknown[]\n } | string | boolean | number | Record<string, unknown> | unknown[]\n origin?: "system_recommendation" | "user_manually" | "entity_updating_system_recommendation"\n}\n```\n\n### `AttributeOrigin`\n\nOrigin of an attribute.\n\n```ts\ntype AttributeOrigin = "system_recommendation" | "user_manually" | "entity_updating_system_recommendation"\n```\n\n### `OperationNode`\n\nMapping operation nodes are either primitive values or operation node objects\n\n```ts\ntype OperationNode = {\n _set?: string | boolean | number | Record<string, unknown> | unknown[]\n _append?: unknown\n _prepend?: unknown\n _uniq?: boolean | string[]\n _retain_old_values?: boolean\n _copy?: string\n _template?: string\n _random?: {\n type: "uuid" | "nanoid"\n } | {\n type: "number"\n min?: number\n max?: number\n }\n _each?: string\n _as?: string\n _map?: {\n _set?: string | boolean | number | Record<string, unknown> | unknown[]\n _append?: unknown\n _prepend?: unknown\n _uniq?: boolean | string[]\n _retain_old_values?: boolean\n _copy?: string\n _template?: string\n _random?: {\n type: { ... }\n } | {\n type: { ... }\n min?: { ... }\n max?: { ... }\n }\n _each?: string\n _as?: string\n _map?: {\n _set?: { ... }\n _append?: { ... }\n _prepend?: { ... }\n _uniq?: { ... }\n _retain_old_values?: { ... }\n _copy?: { ... }\n _template?: { ... }\n _random?: { ... }\n _each?: { ... }\n _as?: { ... }\n _map?: { ... }\n } | string | boolean | number | Record<string, unknown> | unknown[]\n } | string | boolean | number | Record<string, unknown> | unknown[]\n} | string | boolean | number | Record<string, unknown> | unknown[]\n```\n\n### `OperationObjectNode`\n\n```ts\ntype OperationObjectNode = {\n _set?: string | boolean | number | Record<string, unknown> | unknown[]\n _append?: unknown\n _prepend?: unknown\n _uniq?: boolean | string[]\n _retain_old_values?: boolean\n _copy?: string\n _template?: string\n _random?: {\n type: "uuid" | "nanoid"\n } | {\n type: "number"\n min?: number\n max?: number\n }\n _each?: string\n _as?: string\n _map?: {\n _set?: string | boolean | number | Record<string, unknown> | unknown[]\n _append?: unknown\n _prepend?: unknown\n _uniq?: boolean | string[]\n _retain_old_values?: boolean\n _copy?: string\n _template?: string\n _random?: {\n type: { ... }\n } | {\n type: { ... }\n min?: { ... }\n max?: { ... }\n }\n _each?: string\n _as?: string\n _map?: {\n _set?: { ... }\n _append?: { ... }\n _prepend?: { ... }\n _uniq?: { ... }\n _retain_old_values?: { ... }\n _copy?: { ... }\n _template?: { ... }\n _random?: { ... }\n _each?: { ... }\n _as?: { ... }\n _map?: { ... }\n } | string | boolean | number | Record<string, unknown> | unknown[]\n } | string | boolean | number | Record<string, unknown> | unknown[]\n}\n```\n\n### `PrimitiveJSONValue`\n\nRepresents any primitive JSON value\n\n```ts\ntype PrimitiveJSONValue = string | boolean | number | Record<string, unknown> | unknown[]\n```\n\n### `RandomOperation`\n\n```ts\ntype RandomOperation = {\n type: "uuid" | "nanoid"\n} | {\n type: "number"\n min?: number\n max?: number\n}\n```\n\n### `MappingAttribute`\n\n```ts\ntype MappingAttribute = {\n mode: "copy_if_exists" | "append_if_exists" | "set_value"\n target: string\n value: unknown\n} | {\n mode: "copy_if_exists" | "append_if_exists" | "set_value"\n target: string\n source: string\n} | {\n mode: "copy_if_exists" | "append_if_exists" | "set_value"\n target: string\n source?: string\n value_json: string\n target_unique?: string[]\n}\n```\n\n### `MappingAttributeMode`\n\n- copy_if_exists - it replaces the target attribute with the source value - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute. - set_value - it sets a value to a predefined value. Must be used togethe\n\n```ts\ntype MappingAttributeMode = "copy_if_exists" | "append_if_exists" | "set_value"\n```\n\n### `SetValueMapper`\n\n```ts\ntype SetValueMapper = {\n mode: "copy_if_exists" | "append_if_exists" | "set_value"\n target: string\n value: unknown\n}\n```\n\n### `CopyValueMapper`\n\n```ts\ntype CopyValueMapper = {\n mode: "copy_if_exists" | "append_if_exists" | "set_value"\n target: string\n source: string\n}\n```\n\n### `AppendValueMapper`\n\n```ts\ntype AppendValueMapper = {\n mode: "copy_if_exists" | "append_if_exists" | "set_value"\n target: string\n source?: string\n value_json: string\n target_unique?: string[]\n}\n```\n\n### `MappingHistoryResp`\n\n```ts\ntype MappingHistoryResp = {\n results: Array<{\n id: string\n timestamp: string // ISO datetime\n source_entity_snapshot: {\n _id?: { ... }\n _schema?: { ... }\n _title?: { ... }\n _org?: { ... }\n _tags?: { ... }\n _created_at?: { ... }\n _updated_at?: { ... }\n required?: { ... }\n }\n mapped_entities_snapshot: Array<{\n _id?: { ... }\n _schema?: { ... }\n _title?: { ... }\n _org?: { ... }\n _tags?: { ... }\n _created_at?: { ... }\n _updated_at?: { ... }\n required?: { ... }\n }>\n target_configs_snapshot: Array<{\n id?: { ... }\n name?: { ... }\n allow_failure?: { ... }\n target_schema: { ... }\n target_unique?: { ... }\n use_uniqueness_criteria?: { ... }\n loop_config?: { ... }\n conditionMode?: { ... }\n conditions?: { ... }\n mapping_attributes: { ... }\n relation_attributes?: { ... }\n linkback_relation_attribute?: { ... }\n linkback_relation_tags?: { ... }\n graph_context?: { ... }\n }>\n }>\n}\n```\n\n### `MappingHistoryEntry`\n\n```ts\ntype MappingHistoryEntry = {\n id: string\n timestamp: string // ISO datetime\n source_entity_snapshot: {\n _id?: string\n _schema?: string\n _title?: string\n _org?: string\n _tags?: string[]\n _created_at?: string\n _updated_at?: string\n required?: unknown\n }\n mapped_entities_snapshot: Array<{\n _id?: string\n _schema?: string\n _title?: string\n _org?: string\n _tags?: string[]\n _created_at?: string\n _updated_at?: string\n required?: unknown\n }>\n target_configs_snapshot: Array<{\n id?: string\n name?: string\n allow_failure?: boolean\n target_schema: string\n target_unique?: string[]\n use_uniqueness_criteria?: boolean\n loop_config?: {\n source_path?: { ... }\n source_type?: { ... }\n filter_tags?: { ... }\n length?: { ... }\n }\n conditionMode?: "oneOf" | "anyOf" | "allOf"\n conditions?: Array<{\n _exists?: { ... }\n _equals?: { ... }\n _not_exists?: { ... }\n _any_of?: { ... }\n }>\n mapping_attributes: Array<{\n target: { ... }\n operation: { ... }\n origin?: { ... }\n } | {\n mode: { ... }\n target: { ... }\n value: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source: { ... }\n } | {\n mode: { ... }\n target: { ... }\n source?: { ... }\n value_json: { ... }\n target_unique?: { ... }\n }>\n relation_attributes?: Array<{\n target: { ... }\n target_tags?: { ... }\n target_tags_include_source?: { ... }\n target_entity_tags?: { ... }\n override_with_source_filter?: { ... }\n source_filter?: { ... }\n related_to?: { ... }\n mode: { ... }\n origin?: { ... }\n }>\n linkback_relation_attribute?: string\n linkback_relation_tags?: string[]\n graph_context?: Array<{\n seed: { ... }\n graph: { ... }\n }>\n }>\n}\n```\n\n### `MappingSource`\n\n```ts\ntype MappingSource = {\n key: string\n sub_properties?: Array<{\n value: string\n label: string\n initial_target_value?: string\n possible_target_types?: "string" | "date" | "datetime" | "boolean" | "number" | "image" | "file" | "address" | "email" | "phone" | "select" | "multiselect" | "payment" | "link" | "currency" | "sequence" | "relation" | "array"[]\n raw?: boolean\n }>\n source_type: string\n group?: string\n possible_target_types?: "string" | "date" | "datetime" | "boolean" | "number" | "image" | "file" | "address" | "email" | "phone" | "select" | "multiselect" | "payment" | "link" | "currency" | "sequence" | "relation" | "array"[]\n initial_relation?: {\n target: string\n target_tags?: string[]\n target_tags_include_source?: boolean\n target_entity_tags?: string[]\n override_with_source_filter?: boolean\n source_filter?: {\n limit?: { ... }\n schema?: { ... }\n attribute?: { ... }\n relation_tag?: { ... }\n tag?: { ... }\n self?: { ... }\n }\n related_to?: Record<string, unknown>\n mode: "append" | "prepend" | "set"\n origin?: "system_recommendation" | "user_manually" | "entity_updating_system_recommendation"\n }\n title: string\n sub_title?: string\n repeatable?: boolean\n target_settings?: {\n allowed_ui_actions?: "schema-select" | "attribute-select" | "target-delete" | "target-add" | "target"[]\n locked?: "each" | "first" | "system_recommendation"\n isSingleTarget?: boolean\n visibility?: {\n mode: { ... }\n if: { ... }\n message?: { ... }\n }\n }\n}\n```\n\n### `MappingSourceProperty`\n\n```ts\ntype MappingSourceProperty = {\n value: string\n label: string\n initial_target_value?: string\n possible_target_types?: "string" | "date" | "datetime" | "boolean" | "number" | "image" | "file" | "address" | "email" | "phone" | "select" | "multiselect" | "payment" | "link" | "currency" | "sequence" | "relation" | "array"[]\n raw?: boolean\n}\n```\n\n### `MappingSourceTargetType`\n\n```ts\ntype MappingSourceTargetType = "string" | "date" | "datetime" | "boolean" | "number" | "image" | "file" | "address" | "email" | "phone" | "select" | "multiselect" | "payment" | "link" | "currency" | "sequence" | "relation" | "array"\n```\n';
5
5
 
6
6
 
7
7
  exports.default = entity_mapping_default;
@@ -222,6 +222,14 @@ declare namespace Components {
222
222
  *
223
223
  */
224
224
  filter?: /* Mirrors entity-api's GraphNodeFilter (see entity-api openapi.yml). */ GraphNodeFilter[];
225
+ /**
226
+ * Only meaningful for a node expected to resolve to a single entity (the seed node, or
227
+ * "cardinality: one"). When true, finding zero matching entities is not an error - the
228
+ * mapping proceeds without this node's data instead of failing. Finding more than one
229
+ * match still fails regardless of this flag; ambiguity is never silently accepted.
230
+ *
231
+ */
232
+ optional?: boolean;
225
233
  }
226
234
  /**
227
235
  * Mirrors entity-api's GraphNodeFilter (see entity-api openapi.yml).
@@ -684,6 +692,20 @@ declare namespace Components {
684
692
  * path to the array from the entity payload
685
693
  */
686
694
  source_path?: string;
695
+ /**
696
+ * Kind of journey block the loop iterates. 'journey-multi-select' (default) is a cards block with multi selection. 'journey-file-upload' is a file upload block: source_path points at the submission's `_files.$relation` array and `filter_tags` narrows it down to the block's files. Forwarded to the flow-level loop by the Automation Hub.
697
+ *
698
+ */
699
+ source_type?: "journey-multi-select" | "journey-file-upload";
700
+ /**
701
+ * Only iterate items of the array whose `_tags` contain every listed tag. Meant for relation arrays such as `submission._files.$relation`, where the journey tags each file relation with the upload block it came from. `##LOOP_INDEX##` keeps referring to the item's index in the unfiltered array.
702
+ *
703
+ * example:
704
+ * [
705
+ * "_hidden_ 2a4b1c3d-0000-4000-8000-000000000000 - Dokumente"
706
+ * ]
707
+ */
708
+ filter_tags?: string[];
687
709
  /**
688
710
  * a hard limit of how many times the loop is allowed to run.
689
711
  */
@@ -222,6 +222,14 @@ declare namespace Components {
222
222
  *
223
223
  */
224
224
  filter?: /* Mirrors entity-api's GraphNodeFilter (see entity-api openapi.yml). */ GraphNodeFilter[];
225
+ /**
226
+ * Only meaningful for a node expected to resolve to a single entity (the seed node, or
227
+ * "cardinality: one"). When true, finding zero matching entities is not an error - the
228
+ * mapping proceeds without this node's data instead of failing. Finding more than one
229
+ * match still fails regardless of this flag; ambiguity is never silently accepted.
230
+ *
231
+ */
232
+ optional?: boolean;
225
233
  }
226
234
  /**
227
235
  * Mirrors entity-api's GraphNodeFilter (see entity-api openapi.yml).
@@ -684,6 +692,20 @@ declare namespace Components {
684
692
  * path to the array from the entity payload
685
693
  */
686
694
  source_path?: string;
695
+ /**
696
+ * Kind of journey block the loop iterates. 'journey-multi-select' (default) is a cards block with multi selection. 'journey-file-upload' is a file upload block: source_path points at the submission's `_files.$relation` array and `filter_tags` narrows it down to the block's files. Forwarded to the flow-level loop by the Automation Hub.
697
+ *
698
+ */
699
+ source_type?: "journey-multi-select" | "journey-file-upload";
700
+ /**
701
+ * Only iterate items of the array whose `_tags` contain every listed tag. Meant for relation arrays such as `submission._files.$relation`, where the journey tags each file relation with the upload block it came from. `##LOOP_INDEX##` keeps referring to the item's index in the unfiltered array.
702
+ *
703
+ * example:
704
+ * [
705
+ * "_hidden_ 2a4b1c3d-0000-4000-8000-000000000000 - Dokumente"
706
+ * ]
707
+ */
708
+ filter_tags?: string[];
687
709
  /**
688
710
  * a hard limit of how many times the loop is allowed to run.
689
711
  */
package/dist/index.cjs CHANGED
@@ -161,7 +161,7 @@ var _chunkWOUASZJWcjs = require('./chunk-WOUASZJW.cjs');
161
161
 
162
162
 
163
163
 
164
- var _chunkYCTBOY3Tcjs = require('./chunk-YCTBOY3T.cjs');
164
+ var _chunkPZ4TXAF5cjs = require('./chunk-PZ4TXAF5.cjs');
165
165
 
166
166
 
167
167
  var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
@@ -228,7 +228,7 @@ var resolveClient = (params) => {
228
228
  }
229
229
  if (!entry.instance) {
230
230
  const definition = entry.loader();
231
- entry.instance = _chunkYCTBOY3Tcjs.createApiClient.call(void 0, {
231
+ entry.instance = _chunkPZ4TXAF5cjs.createApiClient.call(void 0, {
232
232
  definition,
233
233
  token: state.token,
234
234
  headers: state.globalHeaders,
@@ -261,7 +261,7 @@ var resetAllClients = (registry) => {
261
261
  };
262
262
 
263
263
  // src/apis/_registry.ts
264
- var expandDef = (mod) => _chunkYCTBOY3Tcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
264
+ var expandDef = (mod) => _chunkPZ4TXAF5cjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
265
265
  var registerBuiltinApis = (registry) => {
266
266
  registerApi({
267
267
  registry,
@@ -609,9 +609,9 @@ var createSDK = () => {
609
609
  const available = [...registry.keys()].join(", ");
610
610
  throw new Error(`Unknown API: "${name}". Available: ${available}`);
611
611
  }
612
- return _chunkYCTBOY3Tcjs.createApiHandle.call(void 0, {
612
+ return _chunkPZ4TXAF5cjs.createApiHandle.call(void 0, {
613
613
  resolveClient: () => resolveClient({ registry, name, state }),
614
- createClient: () => _chunkYCTBOY3Tcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
614
+ createClient: () => _chunkPZ4TXAF5cjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
615
615
  apiName: name
616
616
  });
617
617
  };
@@ -659,9 +659,9 @@ var createSDK = () => {
659
659
  return interceptorUse;
660
660
  }
661
661
  case "help":
662
- return (apiName) => _chunkYCTBOY3Tcjs.help.call(void 0, apiName);
662
+ return (apiName) => _chunkPZ4TXAF5cjs.help.call(void 0, apiName);
663
663
  case "openapi":
664
- return (apiName) => _chunkYCTBOY3Tcjs.openapi.call(void 0, apiName);
664
+ return (apiName) => _chunkPZ4TXAF5cjs.openapi.call(void 0, apiName);
665
665
  case "then":
666
666
  case "catch":
667
667
  case "finally":
@@ -691,4 +691,4 @@ var epilot = createSDK();
691
691
 
692
692
 
693
693
 
694
- exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkYCTBOY3Tcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkYCTBOY3Tcjs.help; exports.openapi = _chunkYCTBOY3Tcjs.openapi;
694
+ exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkPZ4TXAF5cjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkPZ4TXAF5cjs.help; exports.openapi = _chunkPZ4TXAF5cjs.openapi;
package/dist/index.d.cts CHANGED
@@ -25,12 +25,12 @@ import { C as Client$i } from './document.d-DN37pjdx.cjs';
25
25
  import { C as Client$j } from './email-settings.d-DViLYaOl.cjs';
26
26
  import { C as Client$k } from './email-template.d-gtQkdaXM.cjs';
27
27
  import { C as Client$l } from './entity.d-GfKqzFGA.cjs';
28
- import { C as Client$m } from './entity-mapping.d-CQv75o8M.cjs';
28
+ import { C as Client$m } from './entity-mapping.d-8MtWa2_L.cjs';
29
29
  import { C as Client$n } from './environments.d-qL1urwAq.cjs';
30
30
  import { C as Client$o } from './event-catalog.d-CCE1qmBN.cjs';
31
31
  import { C as Client$p } from './file.d-DELNV63w.cjs';
32
32
  import { C as Client$q } from './iban.d-BwdiGbxi.cjs';
33
- import { C as Client$r } from './integration-toolkit.d-bhpB79pc.cjs';
33
+ import { C as Client$r } from './integration-toolkit.d--hon4GPp.cjs';
34
34
  import { C as Client$s } from './journey.d-DvwLALwc.cjs';
35
35
  import { C as Client$t } from './kanban.d-BHnSRCYW.cjs';
36
36
  import { C as Client$u } from './message.d-DwnqO-Us.cjs';
package/dist/index.d.ts CHANGED
@@ -25,12 +25,12 @@ import { C as Client$i } from './document.d-DN37pjdx.js';
25
25
  import { C as Client$j } from './email-settings.d-DViLYaOl.js';
26
26
  import { C as Client$k } from './email-template.d-gtQkdaXM.js';
27
27
  import { C as Client$l } from './entity.d-GfKqzFGA.js';
28
- import { C as Client$m } from './entity-mapping.d-CQv75o8M.js';
28
+ import { C as Client$m } from './entity-mapping.d-8MtWa2_L.js';
29
29
  import { C as Client$n } from './environments.d-qL1urwAq.js';
30
30
  import { C as Client$o } from './event-catalog.d-CCE1qmBN.js';
31
31
  import { C as Client$p } from './file.d-DELNV63w.js';
32
32
  import { C as Client$q } from './iban.d-BwdiGbxi.js';
33
- import { C as Client$r } from './integration-toolkit.d-bhpB79pc.js';
33
+ import { C as Client$r } from './integration-toolkit.d--hon4GPp.js';
34
34
  import { C as Client$s } from './journey.d-DvwLALwc.js';
35
35
  import { C as Client$t } from './kanban.d-BHnSRCYW.js';
36
36
  import { C as Client$u } from './message.d-DwnqO-Us.js';
package/dist/index.js CHANGED
@@ -161,7 +161,7 @@ import {
161
161
  expand,
162
162
  help,
163
163
  openapi
164
- } from "./chunk-KZXOYL5D.js";
164
+ } from "./chunk-X742W7MI.js";
165
165
  import {
166
166
  __require
167
167
  } from "./chunk-YPSWSI3M.js";