@epilot/sdk 2.19.11-alpha.0 → 2.19.12

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 (152) hide show
  1. package/definitions/blueprint-manifest-runtime.json +1 -1
  2. package/definitions/blueprint-manifest.json +101 -2
  3. package/definitions/entity-mapping.json +189 -2
  4. package/definitions/environments.json +7 -7
  5. package/dist/apis/access-token.cjs +6 -6
  6. package/dist/apis/access-token.js +1 -1
  7. package/dist/apis/address-suggestions.cjs +6 -6
  8. package/dist/apis/address-suggestions.js +1 -1
  9. package/dist/apis/address.cjs +6 -6
  10. package/dist/apis/address.js +1 -1
  11. package/dist/apis/ai-agents.cjs +6 -6
  12. package/dist/apis/ai-agents.js +1 -1
  13. package/dist/apis/app.cjs +6 -6
  14. package/dist/apis/app.js +1 -1
  15. package/dist/apis/audit-logs.cjs +6 -6
  16. package/dist/apis/audit-logs.js +1 -1
  17. package/dist/apis/automation.cjs +6 -6
  18. package/dist/apis/automation.js +1 -1
  19. package/dist/apis/billing.cjs +6 -6
  20. package/dist/apis/billing.js +1 -1
  21. package/dist/apis/blueprint-manifest.cjs +8 -8
  22. package/dist/apis/blueprint-manifest.d.cts +2 -2
  23. package/dist/apis/blueprint-manifest.d.ts +2 -2
  24. package/dist/apis/blueprint-manifest.js +2 -2
  25. package/dist/apis/calendar.cjs +6 -6
  26. package/dist/apis/calendar.js +1 -1
  27. package/dist/apis/configuration-hub.cjs +6 -6
  28. package/dist/apis/configuration-hub.js +1 -1
  29. package/dist/apis/consent.cjs +6 -6
  30. package/dist/apis/consent.js +1 -1
  31. package/dist/apis/customer-portal.cjs +6 -6
  32. package/dist/apis/customer-portal.js +1 -1
  33. package/dist/apis/dashboard.cjs +6 -6
  34. package/dist/apis/dashboard.js +1 -1
  35. package/dist/apis/data-governance.cjs +6 -6
  36. package/dist/apis/data-governance.js +1 -1
  37. package/dist/apis/deduplication.cjs +6 -6
  38. package/dist/apis/deduplication.js +1 -1
  39. package/dist/apis/design.cjs +6 -6
  40. package/dist/apis/design.js +1 -1
  41. package/dist/apis/document.cjs +6 -6
  42. package/dist/apis/document.js +1 -1
  43. package/dist/apis/email-settings.cjs +6 -6
  44. package/dist/apis/email-settings.js +1 -1
  45. package/dist/apis/email-template.cjs +6 -6
  46. package/dist/apis/email-template.js +1 -1
  47. package/dist/apis/entity-mapping.cjs +6 -6
  48. package/dist/apis/entity-mapping.d.cts +2 -2
  49. package/dist/apis/entity-mapping.d.ts +2 -2
  50. package/dist/apis/entity-mapping.js +1 -1
  51. package/dist/apis/entity.cjs +14 -6
  52. package/dist/apis/entity.d.cts +8 -1
  53. package/dist/apis/entity.d.ts +8 -1
  54. package/dist/apis/entity.js +9 -1
  55. package/dist/apis/environments.cjs +6 -6
  56. package/dist/apis/environments.d.cts +2 -2
  57. package/dist/apis/environments.d.ts +2 -2
  58. package/dist/apis/environments.js +1 -1
  59. package/dist/apis/event-catalog.cjs +6 -6
  60. package/dist/apis/event-catalog.js +1 -1
  61. package/dist/apis/file.cjs +6 -6
  62. package/dist/apis/file.js +1 -1
  63. package/dist/apis/iban.cjs +6 -6
  64. package/dist/apis/iban.js +1 -1
  65. package/dist/apis/integration-toolkit.cjs +6 -6
  66. package/dist/apis/integration-toolkit.js +1 -1
  67. package/dist/apis/journey.cjs +6 -6
  68. package/dist/apis/journey.js +1 -1
  69. package/dist/apis/kanban.cjs +6 -6
  70. package/dist/apis/kanban.js +1 -1
  71. package/dist/apis/message.cjs +6 -6
  72. package/dist/apis/message.js +1 -1
  73. package/dist/apis/metering.cjs +6 -6
  74. package/dist/apis/metering.js +1 -1
  75. package/dist/apis/notes.cjs +6 -6
  76. package/dist/apis/notes.js +1 -1
  77. package/dist/apis/notification.cjs +6 -6
  78. package/dist/apis/notification.js +1 -1
  79. package/dist/apis/organization.cjs +6 -6
  80. package/dist/apis/organization.js +1 -1
  81. package/dist/apis/partner-directory.cjs +6 -6
  82. package/dist/apis/partner-directory.js +1 -1
  83. package/dist/apis/permissions.cjs +6 -6
  84. package/dist/apis/permissions.js +1 -1
  85. package/dist/apis/pricing-tier.cjs +6 -6
  86. package/dist/apis/pricing-tier.js +1 -1
  87. package/dist/apis/pricing.cjs +33 -6
  88. package/dist/apis/pricing.d.cts +32 -1
  89. package/dist/apis/pricing.d.ts +32 -1
  90. package/dist/apis/pricing.js +28 -1
  91. package/dist/apis/purpose.cjs +6 -6
  92. package/dist/apis/purpose.js +1 -1
  93. package/dist/apis/query.cjs +6 -6
  94. package/dist/apis/query.js +1 -1
  95. package/dist/apis/sandbox.cjs +6 -6
  96. package/dist/apis/sandbox.js +1 -1
  97. package/dist/apis/sharing.cjs +6 -6
  98. package/dist/apis/sharing.js +1 -1
  99. package/dist/apis/snapshot.cjs +6 -6
  100. package/dist/apis/snapshot.js +1 -1
  101. package/dist/apis/submission.cjs +6 -6
  102. package/dist/apis/submission.js +1 -1
  103. package/dist/apis/target.cjs +6 -6
  104. package/dist/apis/target.js +1 -1
  105. package/dist/apis/targeting.cjs +6 -6
  106. package/dist/apis/targeting.js +1 -1
  107. package/dist/apis/template-variables.cjs +6 -6
  108. package/dist/apis/template-variables.js +1 -1
  109. package/dist/apis/user.cjs +6 -6
  110. package/dist/apis/user.js +1 -1
  111. package/dist/apis/validation-rules.cjs +6 -6
  112. package/dist/apis/validation-rules.js +1 -1
  113. package/dist/apis/webhooks.cjs +6 -6
  114. package/dist/apis/webhooks.js +1 -1
  115. package/dist/apis/workflow-definition.cjs +6 -6
  116. package/dist/apis/workflow-definition.js +1 -1
  117. package/dist/apis/workflow.cjs +6 -6
  118. package/dist/apis/workflow.js +1 -1
  119. package/dist/bin/cli.js +1 -1
  120. package/dist/blueprint-manifest-SXG3M6B4.cjs +7 -0
  121. package/dist/blueprint-manifest-YU2UZLHV.js +7 -0
  122. package/dist/{blueprint-manifest-runtime-W526ROPG.js → blueprint-manifest-runtime-EQX7FPFC.js} +1 -1
  123. package/dist/{blueprint-manifest-runtime-N5EXZB2K.cjs → blueprint-manifest-runtime-Y63YPBU3.cjs} +2 -2
  124. package/dist/{blueprint-manifest.d-BVxmCeu7.d.cts → blueprint-manifest.d-B8YKYzSJ.d.cts} +191 -5
  125. package/dist/{blueprint-manifest.d-BVxmCeu7.d.ts → blueprint-manifest.d-B8YKYzSJ.d.ts} +191 -5
  126. package/dist/{chunk-3CVNMGIG.cjs → chunk-2AZIGIR2.cjs} +4 -4
  127. package/dist/{chunk-4Z6GRBDK.js → chunk-JGIBV65B.js} +1 -1
  128. package/dist/{chunk-Z54CI2VS.cjs → chunk-O2AM3DYP.cjs} +1 -1
  129. package/dist/{chunk-KSJGHUCG.js → chunk-X3SRAHIZ.js} +4 -4
  130. package/dist/entity-mapping-D67LJE74.js +7 -0
  131. package/dist/entity-mapping-WFPSOXRK.cjs +7 -0
  132. package/dist/{entity-mapping.d-DKSW3sfy.d.ts → entity-mapping.d-CQv75o8M.d.cts} +196 -3
  133. package/dist/{entity-mapping.d-DKSW3sfy.d.cts → entity-mapping.d-CQv75o8M.d.ts} +196 -3
  134. package/dist/environments-JP2CPDH2.cjs +7 -0
  135. package/dist/environments-PGRMZY5G.js +7 -0
  136. package/dist/{environments.d-CP2gV7vw.d.ts → environments.d-840_mC07.d.cts} +28 -28
  137. package/dist/{environments.d-CP2gV7vw.d.cts → environments.d-840_mC07.d.ts} +28 -28
  138. package/dist/index.cjs +10 -10
  139. package/dist/index.d.cts +3 -3
  140. package/dist/index.d.ts +3 -3
  141. package/dist/index.js +2 -2
  142. package/dist/{js-yaml-UPZKYVRY.js → js-yaml-DLCVPJ7G.js} +17 -15
  143. package/docs/blueprint-manifest.md +61 -11
  144. package/docs/entity-mapping.md +354 -852
  145. package/docs/environments.md +14 -14
  146. package/package.json +11 -12
  147. package/dist/blueprint-manifest-4IAJOK2O.cjs +0 -7
  148. package/dist/blueprint-manifest-U6SC54EI.js +0 -7
  149. package/dist/entity-mapping-7J3IAGKQ.js +0 -7
  150. package/dist/entity-mapping-ZNMFCUKK.cjs +0 -7
  151. package/dist/environments-3VKW3GPN.cjs +0 -7
  152. package/dist/environments-SBUZ6QSC.js +0 -7
@@ -1,8 +1,6 @@
1
1
  import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
2
2
 
3
3
  /* Auto-copied from entity-mapping-client */
4
- /* eslint-disable */
5
-
6
4
 
7
5
 
8
6
  declare namespace Components {
@@ -92,6 +90,14 @@ declare namespace Components {
92
90
  * A reference (id and schema) to the entity to be used as source.
93
91
  */
94
92
  source_ref: EntityRef;
93
+ /**
94
+ * Reference to the current iteration's entity when running inside a flow loop.
95
+ * When set, its fields and relations are merged into the source context;
96
+ * on schema conflicts the loop entity wins, so paths like `<schema>._id` resolve
97
+ * to the iteration entity rather than to a same-schema relation of the source.
98
+ *
99
+ */
100
+ loop_ref?: EntityRef;
95
101
  /**
96
102
  * Mapping Configuration to apply.
97
103
  */
@@ -139,6 +145,127 @@ declare namespace Components {
139
145
  export interface ExecuteRelationsResp {
140
146
  relations?: NewRelationItem[];
141
147
  }
148
+ /**
149
+ * One multi-hop graph lookup against entity-api's `POST /v1/entity:graph`, resolved during
150
+ * graph_context enrichment (before mapping_attributes are evaluated). Every node in `graph.nodes`
151
+ * is merged into sourceContext under its own `id`, so listing several nodes here costs one
152
+ * entity-api call, not one per node.
153
+ *
154
+ * If a node's `cardinality` is "one" (or it is the seed node), exactly one entity must be found
155
+ * for it: zero or multiple matches fail the mapping execution instead of silently mapping
156
+ * missing/wrong data. If "many" (the default), it resolves to an array - possibly empty - with no
157
+ * such failure. Each node's cardinality is validated independently.
158
+ *
159
+ * `seed.entity_id` and any `graph.nodes[].filter[].value` may contain `{{handlebars}}` placeholders
160
+ * (e.g. `{{contract._id}}`, `{{contract.origin_order}}`), resolved against the in-progress
161
+ * sourceContext (the source entity, its 1-hop relations, and any custom variables already
162
+ * resolved) before the graph query is sent.
163
+ *
164
+ */
165
+ export interface GraphContextEntry {
166
+ seed: /* Mirrors entity-api's GraphSeed (see entity-api openapi.yml) - the entity the graph traversal starts from. */ GraphSeed;
167
+ graph: /* Mirrors entity-api's GraphDefinition (see entity-api openapi.yml) - the shape of the graph to traverse. */ GraphDefinition;
168
+ }
169
+ /**
170
+ * Mirrors entity-api's GraphDefinition (see entity-api openapi.yml) - the shape of the graph to traverse.
171
+ */
172
+ export interface GraphDefinition {
173
+ nodes: /* Mirrors entity-api's GraphNode (see entity-api openapi.yml). */ GraphNode[];
174
+ edges: /* Mirrors entity-api's GraphEdge (see entity-api openapi.yml). */ GraphEdge[];
175
+ }
176
+ /**
177
+ * Mirrors entity-api's GraphEdge (see entity-api openapi.yml).
178
+ */
179
+ export interface GraphEdge {
180
+ /**
181
+ * Source node ID.
182
+ * example:
183
+ * contact
184
+ */
185
+ from: string;
186
+ /**
187
+ * Target node ID.
188
+ * example:
189
+ * order
190
+ */
191
+ to: string;
192
+ }
193
+ /**
194
+ * Mirrors entity-api's GraphNode (see entity-api openapi.yml).
195
+ */
196
+ export interface GraphNode {
197
+ /**
198
+ * Unique identifier for this node in the graph definition.
199
+ * example:
200
+ * contact
201
+ */
202
+ id: string;
203
+ /**
204
+ * Entity schema slug for this node.
205
+ * example:
206
+ * contact
207
+ */
208
+ schema: string;
209
+ /**
210
+ * "one": this node resolves to a single entity. "many" (default if unset): this node
211
+ * resolves to an array of entities.
212
+ *
213
+ */
214
+ cardinality?: "one" | "many";
215
+ /**
216
+ * Optional entity fields to include in the hydrated response for this node.
217
+ */
218
+ fields?: string[];
219
+ /**
220
+ * Narrows this node's traversal results to entities matching every filter (AND semantics).
221
+ * Useful for disambiguating among multiple entities reachable via the same graph edge.
222
+ *
223
+ */
224
+ filter?: /* Mirrors entity-api's GraphNodeFilter (see entity-api openapi.yml). */ GraphNodeFilter[];
225
+ }
226
+ /**
227
+ * Mirrors entity-api's GraphNodeFilter (see entity-api openapi.yml).
228
+ */
229
+ export interface GraphNodeFilter {
230
+ /**
231
+ * Entity attribute name to match against.
232
+ * example:
233
+ * order_number
234
+ */
235
+ attribute: string;
236
+ /**
237
+ * Literal value the attribute must exactly equal. Supports `{{handlebars}}` placeholders
238
+ * resolved against sourceContext when given as a string.
239
+ *
240
+ * example:
241
+ * {{contract.origin_order}}
242
+ */
243
+ value: /**
244
+ * Literal value the attribute must exactly equal. Supports `{{handlebars}}` placeholders
245
+ * resolved against sourceContext when given as a string.
246
+ *
247
+ * example:
248
+ * {{contract.origin_order}}
249
+ */
250
+ (string | null) | number | boolean;
251
+ }
252
+ /**
253
+ * Mirrors entity-api's GraphSeed (see entity-api openapi.yml) - the entity the graph traversal starts from.
254
+ */
255
+ export interface GraphSeed {
256
+ /**
257
+ * The id of the seed entity. Supports `{{handlebars}}` placeholders resolved against sourceContext.
258
+ * example:
259
+ * {{contract._id}}
260
+ */
261
+ entity_id: string;
262
+ /**
263
+ * The node ID in `graph.nodes` that corresponds to the seed entity.
264
+ * example:
265
+ * contact
266
+ */
267
+ node_id: string;
268
+ }
142
269
  export interface JourneyRef {
143
270
  journey_id?: string;
144
271
  }
@@ -396,6 +523,31 @@ declare namespace Components {
396
523
  * Generate random ids / numbers
397
524
  */
398
525
  _random?: RandomOperation;
526
+ /**
527
+ * Iterate over a source array. Use with _as and _map.
528
+ * The value is a path to resolve from the source entity context.
529
+ * Example: "submission.meterReadings"
530
+ *
531
+ * example:
532
+ * submission.meterReadings
533
+ */
534
+ _each?: string;
535
+ /**
536
+ * Name for the current iteration item in _each.
537
+ * Accessed as $<name> in _copy paths within _map.
538
+ * Example: "reading" (accessed as $reading)
539
+ *
540
+ * example:
541
+ * reading
542
+ */
543
+ _as?: string;
544
+ /**
545
+ * Operation to evaluate per _each iteration item.
546
+ * Can be any OperationNode, typically an object with _copy
547
+ * references to the $<_as name> alias.
548
+ *
549
+ */
550
+ _map?: /* Mapping operation nodes are either primitive values or operation node objects */ OperationNode;
399
551
  }
400
552
  export interface Owner {
401
553
  type: "user" | "internal_service";
@@ -428,6 +580,10 @@ declare namespace Components {
428
580
  * Include all relation tags (labels) present on the main entity relation
429
581
  */
430
582
  target_tags_include_source?: boolean;
583
+ /**
584
+ * Tags to add to the matched target entity's _tags array during mapping. Useful for assigning file collections to file entities.
585
+ */
586
+ target_entity_tags?: string[];
431
587
  /**
432
588
  * Whether to override the relation source_filter with the specified one
433
589
  */
@@ -515,6 +671,11 @@ declare namespace Components {
515
671
  * Unique key for target entity (see upsertEntity of Entity API)
516
672
  */
517
673
  target_unique?: string[];
674
+ /**
675
+ * Execution wire flag set per automation by automation-workers: resolve the target entity via the organization's global uniqueness criteria (deduplication-api) instead of target_unique. Never persisted in stored mapping configs.
676
+ *
677
+ */
678
+ use_uniqueness_criteria?: boolean;
518
679
  /**
519
680
  * contains config in case of running in loop mode
520
681
  */
@@ -566,6 +727,32 @@ declare namespace Components {
566
727
  * Relation tags (labels) to include in main entity linkback relation attribute
567
728
  */
568
729
  linkback_relation_tags?: string[];
730
+ /**
731
+ * Multi-hop entity graph lookups resolved before any mapping_attribute is evaluated. Each
732
+ * entry queries entity-api's `POST /v1/entity:graph` and merges every node's result into
733
+ * sourceContext under its own `graph.nodes[].id`, so mapping_attributes can `_copy`/`_template`
734
+ * from `<node id>.<field>`. A graph node's value overwrites any existing sourceContext key of
735
+ * the same name (a source entity field, a 1-hop relation, or another graph node).
736
+ *
737
+ */
738
+ graph_context?: /**
739
+ * One multi-hop graph lookup against entity-api's `POST /v1/entity:graph`, resolved during
740
+ * graph_context enrichment (before mapping_attributes are evaluated). Every node in `graph.nodes`
741
+ * is merged into sourceContext under its own `id`, so listing several nodes here costs one
742
+ * entity-api call, not one per node.
743
+ *
744
+ * If a node's `cardinality` is "one" (or it is the seed node), exactly one entity must be found
745
+ * for it: zero or multiple matches fail the mapping execution instead of silently mapping
746
+ * missing/wrong data. If "many" (the default), it resolves to an array - possibly empty - with no
747
+ * such failure. Each node's cardinality is validated independently.
748
+ *
749
+ * `seed.entity_id` and any `graph.nodes[].filter[].value` may contain `{{handlebars}}` placeholders
750
+ * (e.g. `{{contract._id}}`, `{{contract.origin_order}}`), resolved against the in-progress
751
+ * sourceContext (the source entity, its 1-hop relations, and any custom variables already
752
+ * resolved) before the graph query is sent.
753
+ *
754
+ */
755
+ GraphContextEntry[];
569
756
  }
570
757
  }
571
758
  }
@@ -1058,6 +1245,12 @@ type ExecuteMappingReq = Components.Schemas.ExecuteMappingReq;
1058
1245
  type ExecuteMappingResp = Components.Schemas.ExecuteMappingResp;
1059
1246
  type ExecuteRelationsReq = Components.Schemas.ExecuteRelationsReq;
1060
1247
  type ExecuteRelationsResp = Components.Schemas.ExecuteRelationsResp;
1248
+ type GraphContextEntry = Components.Schemas.GraphContextEntry;
1249
+ type GraphDefinition = Components.Schemas.GraphDefinition;
1250
+ type GraphEdge = Components.Schemas.GraphEdge;
1251
+ type GraphNode = Components.Schemas.GraphNode;
1252
+ type GraphNodeFilter = Components.Schemas.GraphNodeFilter;
1253
+ type GraphSeed = Components.Schemas.GraphSeed;
1061
1254
  type JourneyRef = Components.Schemas.JourneyRef;
1062
1255
  type Loop_Index_String = Components.Schemas.LoopIndexString;
1063
1256
  type MapCondition = Components.Schemas.MapCondition;
@@ -1089,4 +1282,4 @@ type SetValueMapper = Components.Schemas.SetValueMapper;
1089
1282
  type SourceConfig = Components.Schemas.SourceConfig;
1090
1283
  type TargetConfig = Components.Schemas.TargetConfig;
1091
1284
 
1092
- export { type AppendValueMapper as A, type OperationObjectNode as B, type Client as C, type Owner as D, type Entity as E, type PrimitiveJSONValue as F, type RelationAttribute as G, type RelationItem as H, type SetValueMapper as I, type JourneyRef as J, type SourceConfig as K, type Loop_Index_String as L, type MapCondition as M, type NewRelationItem as N, type OperationMethods as O, Paths as P, type RandomOperation as R, type SearchMappingReq as S, type TargetConfig as T, Components as a, type PathsDictionary as b, type AttributeOrigin as c, type ConditionNode as d, type CopyValueMapper as e, type EntityRef as f, type ExecuteMappingReq as g, type ExecuteMappingResp as h, type ExecuteRelationsReq as i, type ExecuteRelationsResp as j, type MappingAttribute as k, type MappingAttributeMode as l, type MappingAttributeV2 as m, type MappingConfig as n, type MappingConfigCommonFields as o, type MappingConfigV2 as p, type MappingConfigs as q, type MappingConfigsResp as r, type MappingFailure as s, type MappingHistoryEntry as t, type MappingHistoryResp as u, type MappingSource as v, type MappingSourceProperty as w, type MappingSourceTargetType as x, type MappingWarning as y, type OperationNode as z };
1285
+ export { type AppendValueMapper as A, type MappingSource as B, type Client as C, type MappingSourceProperty as D, type Entity as E, type MappingSourceTargetType as F, type GraphContextEntry as G, type MappingWarning as H, type OperationNode as I, type JourneyRef as J, type OperationObjectNode as K, type Loop_Index_String as L, type MapCondition as M, type NewRelationItem as N, type OperationMethods as O, Paths as P, type Owner as Q, type PrimitiveJSONValue as R, type RandomOperation as S, type RelationAttribute as T, type RelationItem as U, type SearchMappingReq as V, type SetValueMapper as W, type SourceConfig as X, type TargetConfig as Y, Components as a, type PathsDictionary as b, type AttributeOrigin as c, type ConditionNode as d, type CopyValueMapper as e, type EntityRef as f, type ExecuteMappingReq as g, type ExecuteMappingResp as h, type ExecuteRelationsReq as i, type ExecuteRelationsResp as j, type GraphDefinition as k, type GraphEdge as l, type GraphNode as m, type GraphNodeFilter as n, type GraphSeed as o, type MappingAttribute as p, type MappingAttributeMode as q, type MappingAttributeV2 as r, type MappingConfig as s, type MappingConfigCommonFields as t, type MappingConfigV2 as u, type MappingConfigs as v, type MappingConfigsResp as w, type MappingFailure as x, type MappingHistoryEntry as y, type MappingHistoryResp as z };
@@ -1,8 +1,6 @@
1
1
  import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
2
2
 
3
3
  /* Auto-copied from entity-mapping-client */
4
- /* eslint-disable */
5
-
6
4
 
7
5
 
8
6
  declare namespace Components {
@@ -92,6 +90,14 @@ declare namespace Components {
92
90
  * A reference (id and schema) to the entity to be used as source.
93
91
  */
94
92
  source_ref: EntityRef;
93
+ /**
94
+ * Reference to the current iteration's entity when running inside a flow loop.
95
+ * When set, its fields and relations are merged into the source context;
96
+ * on schema conflicts the loop entity wins, so paths like `<schema>._id` resolve
97
+ * to the iteration entity rather than to a same-schema relation of the source.
98
+ *
99
+ */
100
+ loop_ref?: EntityRef;
95
101
  /**
96
102
  * Mapping Configuration to apply.
97
103
  */
@@ -139,6 +145,127 @@ declare namespace Components {
139
145
  export interface ExecuteRelationsResp {
140
146
  relations?: NewRelationItem[];
141
147
  }
148
+ /**
149
+ * One multi-hop graph lookup against entity-api's `POST /v1/entity:graph`, resolved during
150
+ * graph_context enrichment (before mapping_attributes are evaluated). Every node in `graph.nodes`
151
+ * is merged into sourceContext under its own `id`, so listing several nodes here costs one
152
+ * entity-api call, not one per node.
153
+ *
154
+ * If a node's `cardinality` is "one" (or it is the seed node), exactly one entity must be found
155
+ * for it: zero or multiple matches fail the mapping execution instead of silently mapping
156
+ * missing/wrong data. If "many" (the default), it resolves to an array - possibly empty - with no
157
+ * such failure. Each node's cardinality is validated independently.
158
+ *
159
+ * `seed.entity_id` and any `graph.nodes[].filter[].value` may contain `{{handlebars}}` placeholders
160
+ * (e.g. `{{contract._id}}`, `{{contract.origin_order}}`), resolved against the in-progress
161
+ * sourceContext (the source entity, its 1-hop relations, and any custom variables already
162
+ * resolved) before the graph query is sent.
163
+ *
164
+ */
165
+ export interface GraphContextEntry {
166
+ seed: /* Mirrors entity-api's GraphSeed (see entity-api openapi.yml) - the entity the graph traversal starts from. */ GraphSeed;
167
+ graph: /* Mirrors entity-api's GraphDefinition (see entity-api openapi.yml) - the shape of the graph to traverse. */ GraphDefinition;
168
+ }
169
+ /**
170
+ * Mirrors entity-api's GraphDefinition (see entity-api openapi.yml) - the shape of the graph to traverse.
171
+ */
172
+ export interface GraphDefinition {
173
+ nodes: /* Mirrors entity-api's GraphNode (see entity-api openapi.yml). */ GraphNode[];
174
+ edges: /* Mirrors entity-api's GraphEdge (see entity-api openapi.yml). */ GraphEdge[];
175
+ }
176
+ /**
177
+ * Mirrors entity-api's GraphEdge (see entity-api openapi.yml).
178
+ */
179
+ export interface GraphEdge {
180
+ /**
181
+ * Source node ID.
182
+ * example:
183
+ * contact
184
+ */
185
+ from: string;
186
+ /**
187
+ * Target node ID.
188
+ * example:
189
+ * order
190
+ */
191
+ to: string;
192
+ }
193
+ /**
194
+ * Mirrors entity-api's GraphNode (see entity-api openapi.yml).
195
+ */
196
+ export interface GraphNode {
197
+ /**
198
+ * Unique identifier for this node in the graph definition.
199
+ * example:
200
+ * contact
201
+ */
202
+ id: string;
203
+ /**
204
+ * Entity schema slug for this node.
205
+ * example:
206
+ * contact
207
+ */
208
+ schema: string;
209
+ /**
210
+ * "one": this node resolves to a single entity. "many" (default if unset): this node
211
+ * resolves to an array of entities.
212
+ *
213
+ */
214
+ cardinality?: "one" | "many";
215
+ /**
216
+ * Optional entity fields to include in the hydrated response for this node.
217
+ */
218
+ fields?: string[];
219
+ /**
220
+ * Narrows this node's traversal results to entities matching every filter (AND semantics).
221
+ * Useful for disambiguating among multiple entities reachable via the same graph edge.
222
+ *
223
+ */
224
+ filter?: /* Mirrors entity-api's GraphNodeFilter (see entity-api openapi.yml). */ GraphNodeFilter[];
225
+ }
226
+ /**
227
+ * Mirrors entity-api's GraphNodeFilter (see entity-api openapi.yml).
228
+ */
229
+ export interface GraphNodeFilter {
230
+ /**
231
+ * Entity attribute name to match against.
232
+ * example:
233
+ * order_number
234
+ */
235
+ attribute: string;
236
+ /**
237
+ * Literal value the attribute must exactly equal. Supports `{{handlebars}}` placeholders
238
+ * resolved against sourceContext when given as a string.
239
+ *
240
+ * example:
241
+ * {{contract.origin_order}}
242
+ */
243
+ value: /**
244
+ * Literal value the attribute must exactly equal. Supports `{{handlebars}}` placeholders
245
+ * resolved against sourceContext when given as a string.
246
+ *
247
+ * example:
248
+ * {{contract.origin_order}}
249
+ */
250
+ (string | null) | number | boolean;
251
+ }
252
+ /**
253
+ * Mirrors entity-api's GraphSeed (see entity-api openapi.yml) - the entity the graph traversal starts from.
254
+ */
255
+ export interface GraphSeed {
256
+ /**
257
+ * The id of the seed entity. Supports `{{handlebars}}` placeholders resolved against sourceContext.
258
+ * example:
259
+ * {{contract._id}}
260
+ */
261
+ entity_id: string;
262
+ /**
263
+ * The node ID in `graph.nodes` that corresponds to the seed entity.
264
+ * example:
265
+ * contact
266
+ */
267
+ node_id: string;
268
+ }
142
269
  export interface JourneyRef {
143
270
  journey_id?: string;
144
271
  }
@@ -396,6 +523,31 @@ declare namespace Components {
396
523
  * Generate random ids / numbers
397
524
  */
398
525
  _random?: RandomOperation;
526
+ /**
527
+ * Iterate over a source array. Use with _as and _map.
528
+ * The value is a path to resolve from the source entity context.
529
+ * Example: "submission.meterReadings"
530
+ *
531
+ * example:
532
+ * submission.meterReadings
533
+ */
534
+ _each?: string;
535
+ /**
536
+ * Name for the current iteration item in _each.
537
+ * Accessed as $<name> in _copy paths within _map.
538
+ * Example: "reading" (accessed as $reading)
539
+ *
540
+ * example:
541
+ * reading
542
+ */
543
+ _as?: string;
544
+ /**
545
+ * Operation to evaluate per _each iteration item.
546
+ * Can be any OperationNode, typically an object with _copy
547
+ * references to the $<_as name> alias.
548
+ *
549
+ */
550
+ _map?: /* Mapping operation nodes are either primitive values or operation node objects */ OperationNode;
399
551
  }
400
552
  export interface Owner {
401
553
  type: "user" | "internal_service";
@@ -428,6 +580,10 @@ declare namespace Components {
428
580
  * Include all relation tags (labels) present on the main entity relation
429
581
  */
430
582
  target_tags_include_source?: boolean;
583
+ /**
584
+ * Tags to add to the matched target entity's _tags array during mapping. Useful for assigning file collections to file entities.
585
+ */
586
+ target_entity_tags?: string[];
431
587
  /**
432
588
  * Whether to override the relation source_filter with the specified one
433
589
  */
@@ -515,6 +671,11 @@ declare namespace Components {
515
671
  * Unique key for target entity (see upsertEntity of Entity API)
516
672
  */
517
673
  target_unique?: string[];
674
+ /**
675
+ * Execution wire flag set per automation by automation-workers: resolve the target entity via the organization's global uniqueness criteria (deduplication-api) instead of target_unique. Never persisted in stored mapping configs.
676
+ *
677
+ */
678
+ use_uniqueness_criteria?: boolean;
518
679
  /**
519
680
  * contains config in case of running in loop mode
520
681
  */
@@ -566,6 +727,32 @@ declare namespace Components {
566
727
  * Relation tags (labels) to include in main entity linkback relation attribute
567
728
  */
568
729
  linkback_relation_tags?: string[];
730
+ /**
731
+ * Multi-hop entity graph lookups resolved before any mapping_attribute is evaluated. Each
732
+ * entry queries entity-api's `POST /v1/entity:graph` and merges every node's result into
733
+ * sourceContext under its own `graph.nodes[].id`, so mapping_attributes can `_copy`/`_template`
734
+ * from `<node id>.<field>`. A graph node's value overwrites any existing sourceContext key of
735
+ * the same name (a source entity field, a 1-hop relation, or another graph node).
736
+ *
737
+ */
738
+ graph_context?: /**
739
+ * One multi-hop graph lookup against entity-api's `POST /v1/entity:graph`, resolved during
740
+ * graph_context enrichment (before mapping_attributes are evaluated). Every node in `graph.nodes`
741
+ * is merged into sourceContext under its own `id`, so listing several nodes here costs one
742
+ * entity-api call, not one per node.
743
+ *
744
+ * If a node's `cardinality` is "one" (or it is the seed node), exactly one entity must be found
745
+ * for it: zero or multiple matches fail the mapping execution instead of silently mapping
746
+ * missing/wrong data. If "many" (the default), it resolves to an array - possibly empty - with no
747
+ * such failure. Each node's cardinality is validated independently.
748
+ *
749
+ * `seed.entity_id` and any `graph.nodes[].filter[].value` may contain `{{handlebars}}` placeholders
750
+ * (e.g. `{{contract._id}}`, `{{contract.origin_order}}`), resolved against the in-progress
751
+ * sourceContext (the source entity, its 1-hop relations, and any custom variables already
752
+ * resolved) before the graph query is sent.
753
+ *
754
+ */
755
+ GraphContextEntry[];
569
756
  }
570
757
  }
571
758
  }
@@ -1058,6 +1245,12 @@ type ExecuteMappingReq = Components.Schemas.ExecuteMappingReq;
1058
1245
  type ExecuteMappingResp = Components.Schemas.ExecuteMappingResp;
1059
1246
  type ExecuteRelationsReq = Components.Schemas.ExecuteRelationsReq;
1060
1247
  type ExecuteRelationsResp = Components.Schemas.ExecuteRelationsResp;
1248
+ type GraphContextEntry = Components.Schemas.GraphContextEntry;
1249
+ type GraphDefinition = Components.Schemas.GraphDefinition;
1250
+ type GraphEdge = Components.Schemas.GraphEdge;
1251
+ type GraphNode = Components.Schemas.GraphNode;
1252
+ type GraphNodeFilter = Components.Schemas.GraphNodeFilter;
1253
+ type GraphSeed = Components.Schemas.GraphSeed;
1061
1254
  type JourneyRef = Components.Schemas.JourneyRef;
1062
1255
  type Loop_Index_String = Components.Schemas.LoopIndexString;
1063
1256
  type MapCondition = Components.Schemas.MapCondition;
@@ -1089,4 +1282,4 @@ type SetValueMapper = Components.Schemas.SetValueMapper;
1089
1282
  type SourceConfig = Components.Schemas.SourceConfig;
1090
1283
  type TargetConfig = Components.Schemas.TargetConfig;
1091
1284
 
1092
- export { type AppendValueMapper as A, type OperationObjectNode as B, type Client as C, type Owner as D, type Entity as E, type PrimitiveJSONValue as F, type RelationAttribute as G, type RelationItem as H, type SetValueMapper as I, type JourneyRef as J, type SourceConfig as K, type Loop_Index_String as L, type MapCondition as M, type NewRelationItem as N, type OperationMethods as O, Paths as P, type RandomOperation as R, type SearchMappingReq as S, type TargetConfig as T, Components as a, type PathsDictionary as b, type AttributeOrigin as c, type ConditionNode as d, type CopyValueMapper as e, type EntityRef as f, type ExecuteMappingReq as g, type ExecuteMappingResp as h, type ExecuteRelationsReq as i, type ExecuteRelationsResp as j, type MappingAttribute as k, type MappingAttributeMode as l, type MappingAttributeV2 as m, type MappingConfig as n, type MappingConfigCommonFields as o, type MappingConfigV2 as p, type MappingConfigs as q, type MappingConfigsResp as r, type MappingFailure as s, type MappingHistoryEntry as t, type MappingHistoryResp as u, type MappingSource as v, type MappingSourceProperty as w, type MappingSourceTargetType as x, type MappingWarning as y, type OperationNode as z };
1285
+ export { type AppendValueMapper as A, type MappingSource as B, type Client as C, type MappingSourceProperty as D, type Entity as E, type MappingSourceTargetType as F, type GraphContextEntry as G, type MappingWarning as H, type OperationNode as I, type JourneyRef as J, type OperationObjectNode as K, type Loop_Index_String as L, type MapCondition as M, type NewRelationItem as N, type OperationMethods as O, Paths as P, type Owner as Q, type PrimitiveJSONValue as R, type RandomOperation as S, type RelationAttribute as T, type RelationItem as U, type SearchMappingReq as V, type SetValueMapper as W, type SourceConfig as X, type TargetConfig as Y, Components as a, type PathsDictionary as b, type AttributeOrigin as c, type ConditionNode as d, type CopyValueMapper as e, type EntityRef as f, type ExecuteMappingReq as g, type ExecuteMappingResp as h, type ExecuteRelationsReq as i, type ExecuteRelationsResp as j, type GraphDefinition as k, type GraphEdge as l, type GraphNode as m, type GraphNodeFilter as n, type GraphSeed as o, type MappingAttribute as p, type MappingAttributeMode as q, type MappingAttributeV2 as r, type MappingConfig as s, type MappingConfigCommonFields as t, type MappingConfigV2 as u, type MappingConfigs as v, type MappingConfigsResp as w, type MappingFailure as x, type MappingHistoryEntry as y, type MappingHistoryResp as z };
@@ -0,0 +1,7 @@
1
+ "use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
2
+
3
+ // src/docs/environments.json
4
+ var environments_default = '# Environments API\n\n- **Base URL:** `https://environments.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/environments](https://docs.epilot.io/api/environments)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.environments.listEnvironmentVariables(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/environments\'\n\nconst environmentsClient = getClient()\nauthorize(environmentsClient, () => \'<token>\')\nconst { data } = await environmentsClient.listEnvironmentVariables(...)\n```\n\n## Operations\n\n**environments**\n- [`listEnvironmentVariables`](#listenvironmentvariables)\n- [`createEnvironmentVariable`](#createenvironmentvariable)\n- [`listEnvironmentGroups`](#listenvironmentgroups)\n- [`putEnvironmentGroup`](#putenvironmentgroup)\n- [`deleteEnvironmentGroup`](#deleteenvironmentgroup)\n- [`getEnvironmentVariable`](#getenvironmentvariable)\n- [`updateEnvironmentVariable`](#updateenvironmentvariable)\n- [`deleteEnvironmentVariable`](#deleteenvironmentvariable)\n\n**Schemas**\n- [`EnvironmentValueType`](#environmentvaluetype)\n- [`EnvironmentOption`](#environmentoption)\n- [`OptionsValue`](#optionsvalue)\n- [`EnvironmentValue`](#environmentvalue)\n- [`EnvironmentVariable`](#environmentvariable)\n- [`EnvironmentVariableListItem`](#environmentvariablelistitem)\n- [`EnvironmentVariableList`](#environmentvariablelist)\n- [`EnvironmentVariableCreateRequest`](#environmentvariablecreaterequest)\n- [`EnvironmentVariableUpdateRequest`](#environmentvariableupdaterequest)\n- [`EnvironmentGroup`](#environmentgroup)\n- [`EnvironmentGroupList`](#environmentgrouplist)\n- [`EnvironmentGroupUpsertRequest`](#environmentgroupupsertrequest)\n\n### `listEnvironmentVariables`\n\nList all environment variables for the organization. Returns metadata only, no secret values.\n\n`GET /v1/environments`\n\n```ts\nconst { data } = await client.listEnvironmentVariables()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "items": [\n {\n "key": "string",\n "type": "String",\n "description": "string",\n "group": "string",\n "value": "string",\n "protected": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createEnvironmentVariable`\n\nCreate a new environment variable or secret for the organization. If `group` is provided and the group does not yet exist, it is created automatically.\n\n`POST /v1/environments`\n\n```ts\nconst { data } = await client.createEnvironmentVariable(\n null,\n {\n key: \'string\',\n type: \'String\',\n description: \'string\',\n group: \'string\',\n value: \'string\',\n protected: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "key": "string",\n "type": "String",\n "description": "string",\n "group": "string",\n "value": "string",\n "protected": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `listEnvironmentGroups`\n\nList all environment groups for the organization.\n\n`GET /v1/environments/groups`\n\n```ts\nconst { data } = await client.listEnvironmentGroups()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "items": [\n {\n "name": "string",\n "description": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `putEnvironmentGroup`\n\nCreate or update an environment group by name. Acts as an upsert \u2014 creates the group if it does not exist.\n\n`PUT /v1/environments/groups/{name}`\n\n```ts\nconst { data } = await client.putEnvironmentGroup(\n {\n name: \'example\',\n },\n {\n description: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "name": "string",\n "description": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `deleteEnvironmentGroup`\n\nDeletes a group. Variables assigned to this group become ungrouped.\n\n`DELETE /v1/environments/groups/{name}`\n\n```ts\nconst { data } = await client.deleteEnvironmentGroup({\n name: \'example\',\n})\n```\n\n---\n\n### `getEnvironmentVariable`\n\nGet an environment variable by key. Returns value for non-secret types, omitted for SecretString.\n\n`GET /v1/environments/{key}`\n\n```ts\nconst { data } = await client.getEnvironmentVariable({\n key: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "key": "string",\n "type": "String",\n "description": "string",\n "group": "string",\n "value": "string",\n "protected": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateEnvironmentVariable`\n\nCreate or update an environment variable. Acts as an upsert \u2014 creates the variable if it does not exist. If `group` is provided and the group does not yet exist, it is created automatically.\n\n`PUT /v1/environments/{key}`\n\n```ts\nconst { data } = await client.updateEnvironmentVariable(\n {\n key: \'example\',\n },\n {\n type: \'String\',\n value: \'string\',\n description: \'string\',\n group: \'string\',\n protected: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "key": "string",\n "type": "String",\n "description": "string",\n "group": "string",\n "value": "string",\n "protected": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `deleteEnvironmentVariable`\n\nDelete an environment variable by key.\n\n`DELETE /v1/environments/{key}`\n\n```ts\nconst { data } = await client.deleteEnvironmentVariable({\n key: \'example\',\n})\n```\n\n---\n\n## Schemas\n\n### `EnvironmentValueType`\n\nThe structure a variable\'s value holds. `SecretString` is encrypted at rest and\nits value is never returned. `Text`, `Number`, `Boolean` and `Options` may be\nserved to browser-facing consumers; `String` and `SecretString` may not.\n\n\n```ts\ntype EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"\n```\n\n### `EnvironmentOption`\n\n```ts\ntype EnvironmentOption = {\n value: string\n label: string\n} | {\n value: string\n labels: Record<string, string>\n}\n```\n\n### `OptionsValue`\n\n```ts\ntype OptionsValue = {\n fallbackLanguage?: string\n options: Array<{\n value: string\n label: string\n } | {\n value: string\n labels: Record<string, string>\n }>\n}\n```\n\n### `EnvironmentValue`\n\nA variable\'s value. The JSON type corresponds to the variable\'s `type`:\n`String`, `SecretString` and `Text` are strings, `Number` is a number,\n`Boolean` is a boolean, and `Options` is an object. Numbers are IEEE 754\ndoubles; integers above 2^53 may lose precision on round-trip.\n\n\n```ts\ntype EnvironmentValue = string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n value: string\n label: string\n } | {\n value: string\n labels: Record<string, string>\n }>\n}\n```\n\n### `EnvironmentVariable`\n\n```ts\ntype EnvironmentVariable = {\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n value: { ... }\n label: { ... }\n } | {\n value: { ... }\n labels: { ... }\n }>\n }\n protected?: boolean\n created_at: string // date-time\n updated_at: string // date-time\n}\n```\n\n### `EnvironmentVariableListItem`\n\n```ts\ntype EnvironmentVariableListItem = {\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n value: { ... }\n label: { ... }\n } | {\n value: { ... }\n labels: { ... }\n }>\n }\n protected?: boolean\n created_at: string // date-time\n updated_at: string // date-time\n}\n```\n\n### `EnvironmentVariableList`\n\n```ts\ntype EnvironmentVariableList = {\n items: Array<{\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: { ... }\n options: { ... }\n }\n protected?: boolean\n created_at: string // date-time\n updated_at: string // date-time\n }>\n}\n```\n\n### `EnvironmentVariableCreateRequest`\n\n```ts\ntype EnvironmentVariableCreateRequest = {\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n value: { ... }\n label: { ... }\n } | {\n value: { ... }\n labels: { ... }\n }>\n }\n protected?: boolean\n}\n```\n\n### `EnvironmentVariableUpdateRequest`\n\n```ts\ntype EnvironmentVariableUpdateRequest = {\n type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n value: { ... }\n label: { ... }\n } | {\n value: { ... }\n labels: { ... }\n }>\n }\n description?: string\n group?: string\n protected?: boolean\n}\n```\n\n### `EnvironmentGroup`\n\n```ts\ntype EnvironmentGroup = {\n name: string\n description?: string\n created_at: string // date-time\n updated_at: string // date-time\n}\n```\n\n### `EnvironmentGroupList`\n\n```ts\ntype EnvironmentGroupList = {\n items: Array<{\n name: string\n description?: string\n created_at: string // date-time\n updated_at: string // date-time\n }>\n}\n```\n\n### `EnvironmentGroupUpsertRequest`\n\n```ts\ntype EnvironmentGroupUpsertRequest = {\n description?: string\n}\n```\n';
5
+
6
+
7
+ exports.default = environments_default;
@@ -0,0 +1,7 @@
1
+ import "./chunk-YPSWSI3M.js";
2
+
3
+ // src/docs/environments.json
4
+ var environments_default = '# Environments API\n\n- **Base URL:** `https://environments.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/environments](https://docs.epilot.io/api/environments)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.environments.listEnvironmentVariables(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/environments\'\n\nconst environmentsClient = getClient()\nauthorize(environmentsClient, () => \'<token>\')\nconst { data } = await environmentsClient.listEnvironmentVariables(...)\n```\n\n## Operations\n\n**environments**\n- [`listEnvironmentVariables`](#listenvironmentvariables)\n- [`createEnvironmentVariable`](#createenvironmentvariable)\n- [`listEnvironmentGroups`](#listenvironmentgroups)\n- [`putEnvironmentGroup`](#putenvironmentgroup)\n- [`deleteEnvironmentGroup`](#deleteenvironmentgroup)\n- [`getEnvironmentVariable`](#getenvironmentvariable)\n- [`updateEnvironmentVariable`](#updateenvironmentvariable)\n- [`deleteEnvironmentVariable`](#deleteenvironmentvariable)\n\n**Schemas**\n- [`EnvironmentValueType`](#environmentvaluetype)\n- [`EnvironmentOption`](#environmentoption)\n- [`OptionsValue`](#optionsvalue)\n- [`EnvironmentValue`](#environmentvalue)\n- [`EnvironmentVariable`](#environmentvariable)\n- [`EnvironmentVariableListItem`](#environmentvariablelistitem)\n- [`EnvironmentVariableList`](#environmentvariablelist)\n- [`EnvironmentVariableCreateRequest`](#environmentvariablecreaterequest)\n- [`EnvironmentVariableUpdateRequest`](#environmentvariableupdaterequest)\n- [`EnvironmentGroup`](#environmentgroup)\n- [`EnvironmentGroupList`](#environmentgrouplist)\n- [`EnvironmentGroupUpsertRequest`](#environmentgroupupsertrequest)\n\n### `listEnvironmentVariables`\n\nList all environment variables for the organization. Returns metadata only, no secret values.\n\n`GET /v1/environments`\n\n```ts\nconst { data } = await client.listEnvironmentVariables()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "items": [\n {\n "key": "string",\n "type": "String",\n "description": "string",\n "group": "string",\n "value": "string",\n "protected": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createEnvironmentVariable`\n\nCreate a new environment variable or secret for the organization. If `group` is provided and the group does not yet exist, it is created automatically.\n\n`POST /v1/environments`\n\n```ts\nconst { data } = await client.createEnvironmentVariable(\n null,\n {\n key: \'string\',\n type: \'String\',\n description: \'string\',\n group: \'string\',\n value: \'string\',\n protected: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "key": "string",\n "type": "String",\n "description": "string",\n "group": "string",\n "value": "string",\n "protected": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `listEnvironmentGroups`\n\nList all environment groups for the organization.\n\n`GET /v1/environments/groups`\n\n```ts\nconst { data } = await client.listEnvironmentGroups()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "items": [\n {\n "name": "string",\n "description": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `putEnvironmentGroup`\n\nCreate or update an environment group by name. Acts as an upsert \u2014 creates the group if it does not exist.\n\n`PUT /v1/environments/groups/{name}`\n\n```ts\nconst { data } = await client.putEnvironmentGroup(\n {\n name: \'example\',\n },\n {\n description: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "name": "string",\n "description": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `deleteEnvironmentGroup`\n\nDeletes a group. Variables assigned to this group become ungrouped.\n\n`DELETE /v1/environments/groups/{name}`\n\n```ts\nconst { data } = await client.deleteEnvironmentGroup({\n name: \'example\',\n})\n```\n\n---\n\n### `getEnvironmentVariable`\n\nGet an environment variable by key. Returns value for non-secret types, omitted for SecretString.\n\n`GET /v1/environments/{key}`\n\n```ts\nconst { data } = await client.getEnvironmentVariable({\n key: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "key": "string",\n "type": "String",\n "description": "string",\n "group": "string",\n "value": "string",\n "protected": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateEnvironmentVariable`\n\nCreate or update an environment variable. Acts as an upsert \u2014 creates the variable if it does not exist. If `group` is provided and the group does not yet exist, it is created automatically.\n\n`PUT /v1/environments/{key}`\n\n```ts\nconst { data } = await client.updateEnvironmentVariable(\n {\n key: \'example\',\n },\n {\n type: \'String\',\n value: \'string\',\n description: \'string\',\n group: \'string\',\n protected: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "key": "string",\n "type": "String",\n "description": "string",\n "group": "string",\n "value": "string",\n "protected": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `deleteEnvironmentVariable`\n\nDelete an environment variable by key.\n\n`DELETE /v1/environments/{key}`\n\n```ts\nconst { data } = await client.deleteEnvironmentVariable({\n key: \'example\',\n})\n```\n\n---\n\n## Schemas\n\n### `EnvironmentValueType`\n\nThe structure a variable\'s value holds. `SecretString` is encrypted at rest and\nits value is never returned. `Text`, `Number`, `Boolean` and `Options` may be\nserved to browser-facing consumers; `String` and `SecretString` may not.\n\n\n```ts\ntype EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"\n```\n\n### `EnvironmentOption`\n\n```ts\ntype EnvironmentOption = {\n value: string\n label: string\n} | {\n value: string\n labels: Record<string, string>\n}\n```\n\n### `OptionsValue`\n\n```ts\ntype OptionsValue = {\n fallbackLanguage?: string\n options: Array<{\n value: string\n label: string\n } | {\n value: string\n labels: Record<string, string>\n }>\n}\n```\n\n### `EnvironmentValue`\n\nA variable\'s value. The JSON type corresponds to the variable\'s `type`:\n`String`, `SecretString` and `Text` are strings, `Number` is a number,\n`Boolean` is a boolean, and `Options` is an object. Numbers are IEEE 754\ndoubles; integers above 2^53 may lose precision on round-trip.\n\n\n```ts\ntype EnvironmentValue = string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n value: string\n label: string\n } | {\n value: string\n labels: Record<string, string>\n }>\n}\n```\n\n### `EnvironmentVariable`\n\n```ts\ntype EnvironmentVariable = {\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n value: { ... }\n label: { ... }\n } | {\n value: { ... }\n labels: { ... }\n }>\n }\n protected?: boolean\n created_at: string // date-time\n updated_at: string // date-time\n}\n```\n\n### `EnvironmentVariableListItem`\n\n```ts\ntype EnvironmentVariableListItem = {\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n value: { ... }\n label: { ... }\n } | {\n value: { ... }\n labels: { ... }\n }>\n }\n protected?: boolean\n created_at: string // date-time\n updated_at: string // date-time\n}\n```\n\n### `EnvironmentVariableList`\n\n```ts\ntype EnvironmentVariableList = {\n items: Array<{\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: { ... }\n options: { ... }\n }\n protected?: boolean\n created_at: string // date-time\n updated_at: string // date-time\n }>\n}\n```\n\n### `EnvironmentVariableCreateRequest`\n\n```ts\ntype EnvironmentVariableCreateRequest = {\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n value: { ... }\n label: { ... }\n } | {\n value: { ... }\n labels: { ... }\n }>\n }\n protected?: boolean\n}\n```\n\n### `EnvironmentVariableUpdateRequest`\n\n```ts\ntype EnvironmentVariableUpdateRequest = {\n type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n value: { ... }\n label: { ... }\n } | {\n value: { ... }\n labels: { ... }\n }>\n }\n description?: string\n group?: string\n protected?: boolean\n}\n```\n\n### `EnvironmentGroup`\n\n```ts\ntype EnvironmentGroup = {\n name: string\n description?: string\n created_at: string // date-time\n updated_at: string // date-time\n}\n```\n\n### `EnvironmentGroupList`\n\n```ts\ntype EnvironmentGroupList = {\n items: Array<{\n name: string\n description?: string\n created_at: string // date-time\n updated_at: string // date-time\n }>\n}\n```\n\n### `EnvironmentGroupUpsertRequest`\n\n```ts\ntype EnvironmentGroupUpsertRequest = {\n description?: string\n}\n```\n';
5
+ export {
6
+ environments_default as default
7
+ };