@uipath/maestro-builder-sdk 6.1.0 → 6.2.0
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.
- package/dist/api-index.md +357 -351
- package/dist/api-members.md +969 -0
- package/package.json +3 -3
package/dist/api-index.md
CHANGED
|
@@ -5,8 +5,14 @@
|
|
|
5
5
|
|
|
6
6
|
# Maestro Builder SDK — API index
|
|
7
7
|
|
|
8
|
-
|
|
9
|
-
of the
|
|
8
|
+
**A lookup table — match one name in it, do not read it.** Every exported
|
|
9
|
+
symbol of the three authoring entry points, with the exact lines of the
|
|
10
|
+
`.d.ts` that declares it.
|
|
11
|
+
|
|
12
|
+
**Holding a FIELD or METHOD name instead?** That is the usual case, because the
|
|
13
|
+
reference pages are "one line per field". Those are not here — they are in
|
|
14
|
+
[`api-members.md`](api-members.md), keyed by the member's own name. This file
|
|
15
|
+
indexes the exports: interfaces, types, functions, classes, consts.
|
|
10
16
|
|
|
11
17
|
**Read the declaration, not a description of it.** The `.d.ts` is what the
|
|
12
18
|
compiler checks your source against, and it carries the `@remarks` and
|
|
@@ -35,216 +41,216 @@ that is the thing to check first.
|
|
|
35
41
|
|
|
36
42
|
| Symbol | Kind | Declaration | Area | Summary |
|
|
37
43
|
| --- | --- | --- | --- | --- |
|
|
38
|
-
| `ActionSpec` | type | `dist/core/actions.d.ts
|
|
39
|
-
| `agent` | function | `dist/core/actions.d.ts
|
|
40
|
-
| `AgentFlavour` | type | `dist/core/actions.d.ts
|
|
41
|
-
| `AgentGuardrail` | type | `dist/core/actions.d.ts`
|
|
42
|
-
| `agenticProcess` | function | `dist/core/actions.d.ts
|
|
43
|
-
| `AgenticProcessCompletion` | type | `dist/core/actions.d.ts
|
|
44
|
-
| `AgenticProcessInputs` | type | `dist/core/actions.d.ts
|
|
45
|
-
| `AgenticProcessInputsBase` | interface | `dist/core/actions.d.ts
|
|
46
|
-
| `AgentInputs` | interface | `dist/core/actions.d.ts
|
|
47
|
-
| `AgentLocation` | type | `dist/core/actions.d.ts`
|
|
48
|
-
| `AgentMemoryRef` | interface | `dist/core/actions.d.ts
|
|
49
|
-
| `Aggregation` | interface | `dist/core/actions.d.ts
|
|
50
|
-
| `AggregationOperation` | type | `dist/core/actions.d.ts`
|
|
51
|
-
| `apiWorkflow` | function | `dist/core/actions.d.ts
|
|
52
|
-
| `ApiWorkflowInputs` | interface | `dist/core/actions.d.ts
|
|
53
|
-
| `AppRef` | interface | `dist/core/actions.d.ts
|
|
54
|
-
| `ArmBuilder` | class | `dist/flow-sdk.d.ts
|
|
55
|
-
| `AskedField` | interface | `dist/core/actions.d.ts
|
|
56
|
-
| `batchTransform` | function | `dist/core/actions.d.ts
|
|
57
|
-
| `BatchTransformInputs` | interface | `dist/core/actions.d.ts
|
|
58
|
-
| `BindingContribution` | interface | `dist/core/node-classes.d.ts
|
|
59
|
-
| `BuiltEntryPoint` | interface | `dist/flow-sdk.d.ts
|
|
60
|
-
| `BuiltFlow` | interface | `dist/flow-sdk.d.ts
|
|
61
|
-
| `BuiltinToolName` | type | `dist/core/actions.d.ts
|
|
62
|
-
| `BuiltinToolRef` | interface | `dist/core/actions.d.ts
|
|
63
|
-
| `BuiltInValidatorGuardrail` | interface | `dist/core/actions.d.ts
|
|
64
|
-
| `CaseValue` | type | `dist/flow-sdk.d.ts
|
|
65
|
-
| `ChildFlow` | type | `dist/flow-sdk.d.ts
|
|
66
|
-
| `ClientSideToolRef` | interface | `dist/core/actions.d.ts
|
|
67
|
-
| `connector` | function | `dist/core/actions.d.ts
|
|
68
|
-
| `connector` | function | `dist/core/actions.d.ts
|
|
69
|
-
| `ConnectorDescriptor` | type | `dist/core/connectors.d.ts
|
|
70
|
-
| `ConnectorLookupValue` | type | `dist/core/connectors.d.ts
|
|
71
|
-
| `ConnectorMeta` | interface | `dist/core/connectors.d.ts
|
|
72
|
-
| `ConnectorOpts` | interface | `dist/core/actions.d.ts
|
|
73
|
-
| `ConnectorToolRef` | interface | `dist/core/actions.d.ts
|
|
74
|
-
| `ConnectorValue` | type | `dist/core/connectors.d.ts
|
|
75
|
-
| `ContextIndexRef` | interface | `dist/core/actions.d.ts
|
|
76
|
-
| `ContributionContext` | interface | `dist/core/node-classes.d.ts
|
|
77
|
-
| `ContributionDiagnostic` | interface | `dist/core/node-classes.d.ts
|
|
78
|
-
| `conversationalAgent` | function | `dist/core/actions.d.ts
|
|
79
|
-
| `ConversationalAgentInputs` | interface | `dist/core/actions.d.ts
|
|
80
|
-
| `ConversationalAgentSettings` | interface | `dist/core/actions.d.ts
|
|
81
|
-
| `conversationContext` | function | `dist/core/actions.d.ts
|
|
82
|
-
| `ConversationContextInputs` | interface | `dist/core/actions.d.ts
|
|
83
|
-
| `conversationTrigger` | function | `dist/flow-sdk.d.ts
|
|
84
|
-
| `createOutgoingCall` | function | `dist/core/actions.d.ts
|
|
85
|
-
| `CreateOutgoingCallInputs` | interface | `dist/core/actions.d.ts
|
|
86
|
-
| `CustomGuardrail` | interface | `dist/core/actions.d.ts
|
|
87
|
-
| `DataFabricFilter` | interface | `dist/core/actions.d.ts
|
|
88
|
-
| `dataFabricRead` | function | `dist/core/actions.d.ts
|
|
89
|
-
| `DataFabricReadInputs` | interface | `dist/core/actions.d.ts
|
|
90
|
-
| `dataFabricUpdate` | function | `dist/core/actions.d.ts
|
|
91
|
-
| `DataFabricUpdateInputs` | interface | `dist/core/actions.d.ts
|
|
92
|
-
| `DEFAULT_TRIGGER_ID` | const | `dist/core/expr.d.ts
|
|
93
|
-
| `DefinitionReference` | type | `dist/core/node-classes.d.ts
|
|
94
|
-
| `delay` | function | `dist/core/actions.d.ts
|
|
95
|
-
| `DELAY_PRESETS` | const | `dist/core/actions.d.ts
|
|
96
|
-
| `DelayInputs` | type | `dist/core/actions.d.ts
|
|
97
|
-
| `descriptor` | function | `dist/core/connectors.d.ts
|
|
98
|
-
| `documentClassify` | function | `dist/core/actions.d.ts
|
|
99
|
-
| `DocumentClassifyInputs` | interface | `dist/core/actions.d.ts
|
|
100
|
-
| `DocValidationInputs` | interface | `dist/core/actions.d.ts
|
|
101
|
-
| `DoWhileOptions` | interface | `dist/flow-sdk.d.ts
|
|
102
|
-
| `dynamicExtract` | function | `dist/core/actions.d.ts
|
|
103
|
-
| `DynamicExtractInputs` | interface | `dist/core/actions.d.ts
|
|
104
|
-
| `EdgeRoute` | interface | `dist/flow-sdk.d.ts
|
|
105
|
-
| `endCall` | function | `dist/core/actions.d.ts
|
|
106
|
-
| `EndCallInputs` | interface | `dist/core/actions.d.ts
|
|
107
|
-
| `entryInput` | function | `dist/core/expr.d.ts
|
|
108
|
-
| `err` | function | `dist/core/expr.d.ts
|
|
109
|
-
| `ErrorEnvelopeField` | type | `dist/core/expr.d.ts
|
|
110
|
-
| `EscalationRef` | interface | `dist/core/actions.d.ts
|
|
111
|
-
| `EventFilter` | type | `dist/core/actions.d.ts
|
|
112
|
-
| `EventSubscription` | interface | `dist/core/actions.d.ts
|
|
113
|
-
| `Expr` | class | `dist/core/expr.d.ts
|
|
114
|
-
| `FieldMapping` | interface | `dist/core/actions.d.ts
|
|
115
|
-
| `FilterCondition` | type | `dist/core/actions.d.ts
|
|
116
|
-
| `FilterMatch` | type | `dist/core/actions.d.ts
|
|
117
|
-
| `FilterRule` | interface | `dist/core/actions.d.ts
|
|
118
|
-
| `flow` | function | `dist/flow-sdk.d.ts
|
|
119
|
-
| `FlowAction` | class | `dist/core/node-classes.d.ts
|
|
120
|
-
| `FlowActionSpec` | type | `dist/flow-sdk.d.ts
|
|
121
|
-
| `FlowBuilder` | class | `dist/flow-sdk.d.ts
|
|
122
|
-
| `FlowLayout` | interface | `dist/flow-sdk.d.ts
|
|
123
|
-
| `FlowNode` | class | `dist/core/node-classes.d.ts
|
|
124
|
-
| `FlowResource` | class | `dist/core/node-classes.d.ts
|
|
125
|
-
| `FlowTrigger` | class | `dist/core/node-classes.d.ts
|
|
126
|
-
| `FormField` | type | `dist/core/actions.d.ts`
|
|
127
|
-
| `FormFieldType` | type | `dist/core/actions.d.ts
|
|
128
|
-
| `formTrigger` | function | `dist/flow-sdk.d.ts
|
|
129
|
-
| `GuardrailAction` | type | `dist/core/actions.d.ts
|
|
130
|
-
| `GuardrailFieldReference` | interface | `dist/core/actions.d.ts
|
|
131
|
-
| `GuardrailFieldSelector` | type | `dist/core/actions.d.ts
|
|
132
|
-
| `GuardrailRule` | type | `dist/core/actions.d.ts
|
|
133
|
-
| `GuardrailScope` | type | `dist/core/actions.d.ts
|
|
134
|
-
| `GuardrailSelector` | interface | `dist/core/actions.d.ts
|
|
135
|
-
| `hitl` | function | `dist/core/actions.d.ts
|
|
136
|
-
| `HitlAssigneeType` | type | `dist/core/actions.d.ts
|
|
137
|
-
| `HitlChannel` | type | `dist/core/actions.d.ts
|
|
138
|
-
| `HitlConnection` | interface | `dist/core/actions.d.ts
|
|
139
|
-
| `HitlInputs` | interface | `dist/core/actions.d.ts
|
|
140
|
-
| `HitlRecipient` | interface | `dist/core/actions.d.ts
|
|
141
|
-
| `HitlVariant` | type | `dist/core/actions.d.ts
|
|
142
|
-
| `http` | function | `dist/core/actions.d.ts
|
|
143
|
-
| `HttpBranch` | interface | `dist/core/actions.d.ts
|
|
144
|
-
| `HttpInputs` | type | `dist/core/actions.d.ts
|
|
145
|
-
| `HttpInputsBase` | interface | `dist/core/actions.d.ts
|
|
146
|
-
| `HttpRequestToolRef` | interface | `dist/core/actions.d.ts
|
|
147
|
-
| `inlineAgent` | function | `dist/core/actions.d.ts
|
|
148
|
-
| `InlineAgentFieldType` | type | `dist/core/actions.d.ts
|
|
149
|
-
| `InlineAgentInputs` | interface | `dist/core/actions.d.ts
|
|
150
|
-
| `InOutField` | interface | `dist/core/actions.d.ts
|
|
151
|
-
| `input` | function | `dist/core/expr.d.ts
|
|
152
|
-
| `isLookupToken` | function | `dist/core/lookups.d.ts
|
|
153
|
-
| `ixpExtract` | function | `dist/core/actions.d.ts
|
|
154
|
-
| `IxpExtractInputs` | interface | `dist/core/actions.d.ts
|
|
155
|
-
| `IxpToolRef` | interface | `dist/core/actions.d.ts
|
|
156
|
-
| `js` | function | `dist/core/expr.d.ts
|
|
157
|
-
| `lit` | function | `dist/core/expr.d.ts
|
|
158
|
-
| `lookup` | function | `dist/core/lookups.d.ts
|
|
159
|
-
| `lookup` | function | `dist/core/lookups.d.ts
|
|
160
|
-
| `lookup` | function | `dist/core/lookups.d.ts
|
|
161
|
-
| `lookup` | function | `dist/core/lookups.d.ts
|
|
162
|
-
| `LookupBuilder` | type | `dist/core/lookups.d.ts
|
|
163
|
-
| `lookupKey` | function | `dist/core/lookups.d.ts
|
|
164
|
-
| `LookupResolution` | interface | `dist/core/lookups.d.ts
|
|
165
|
-
| `LookupResolutions` | type | `dist/core/lookups.d.ts
|
|
166
|
-
| `LookupSpec` | interface | `dist/core/lookups.d.ts
|
|
167
|
-
| `lookupSpecOf` | function | `dist/core/lookups.d.ts
|
|
168
|
-
| `LookupStrategy` | type | `dist/core/lookups.d.ts
|
|
169
|
-
| `LookupToken` | interface | `dist/core/lookups.d.ts
|
|
170
|
-
| `LoopOptions` | interface | `dist/flow-sdk.d.ts
|
|
171
|
-
| `manual` | function | `dist/flow-sdk.d.ts
|
|
172
|
-
| `McpToolRef` | interface | `dist/core/actions.d.ts
|
|
173
|
-
| `mock` | function | `dist/core/actions.d.ts
|
|
174
|
-
| `NodeContribution` | interface | `dist/core/node-classes.d.ts
|
|
175
|
-
| `NodeLayout` | interface | `dist/flow-sdk.d.ts
|
|
176
|
-
| `NodeOptions` | interface | `dist/flow-sdk.d.ts
|
|
177
|
-
| `onEvent` | function | `dist/flow-sdk.d.ts
|
|
178
|
-
| `onEvent` | function | `dist/flow-sdk.d.ts
|
|
179
|
-
| `out` | function | `dist/core/expr.d.ts
|
|
180
|
-
| `Outcome` | type | `dist/core/actions.d.ts
|
|
181
|
-
| `OutputColumn` | interface | `dist/core/actions.d.ts
|
|
182
|
-
| `PortArm` | interface | `dist/flow-sdk.d.ts
|
|
183
|
-
| `ProcessToolKind` | type | `dist/core/actions.d.ts
|
|
184
|
-
| `ProcessToolRef` | interface | `dist/core/actions.d.ts
|
|
185
|
-
| `publishedFunction` | function | `dist/core/actions.d.ts
|
|
186
|
-
| `PublishedFunctionInputs` | interface | `dist/core/actions.d.ts
|
|
187
|
-
| `queueItem` | function | `dist/core/actions.d.ts
|
|
188
|
-
| `QueueItemInputs` | interface | `dist/core/actions.d.ts
|
|
189
|
-
| `QueuePriority` | type | `dist/core/actions.d.ts
|
|
190
|
-
| `ran` | function | `dist/core/expr.d.ts
|
|
191
|
-
| `rawNode` | function | `dist/core/node-classes.d.ts
|
|
192
|
-
| `RawReference` | type | `dist/core/lookups.d.ts
|
|
193
|
-
| `refuseLookupToken` | function | `dist/core/lookups.d.ts
|
|
194
|
-
| `RemoteA2aToolRef` | interface | `dist/core/actions.d.ts
|
|
195
|
-
| `resolvedValue` | function | `dist/core/lookups.d.ts
|
|
196
|
-
| `ReturnFieldType` | type | `dist/core/actions.d.ts
|
|
197
|
-
| `ReturnOptions` | interface | `dist/flow-sdk.d.ts
|
|
198
|
-
| `rpaWorkflow` | function | `dist/core/actions.d.ts
|
|
199
|
-
| `RpaWorkflowInputs` | interface | `dist/core/actions.d.ts
|
|
200
|
-
| `SCHEDULE_PRESETS` | const | `dist/flow-sdk.d.ts
|
|
201
|
-
| `scheduled` | function | `dist/flow-sdk.d.ts
|
|
202
|
-
| `ScheduledInputs` | interface | `dist/flow-sdk.d.ts
|
|
203
|
-
| `ScheduleEvery` | type | `dist/flow-sdk.d.ts
|
|
204
|
-
| `SchedulePreset` | type | `dist/flow-sdk.d.ts`
|
|
205
|
-
| `script` | function | `dist/core/actions.d.ts
|
|
206
|
-
| `ScriptInputs` | interface | `dist/core/actions.d.ts
|
|
207
|
-
| `ScriptReturns` | type | `dist/core/script-return.d.ts
|
|
208
|
-
| `ScriptReturnType` | type | `dist/core/script-return.d.ts
|
|
209
|
-
| `sendMessage` | function | `dist/core/actions.d.ts
|
|
210
|
-
| `SendMessageInputs` | interface | `dist/core/actions.d.ts
|
|
211
|
-
| `ShownField` | interface | `dist/core/actions.d.ts
|
|
212
|
-
| `Step` | type | `dist/flow-sdk.d.ts
|
|
213
|
-
| `StepList` | class | `dist/flow-sdk.d.ts
|
|
214
|
-
| `STICKY_NOTE_COLORS` | const | `dist/flow-sdk.d.ts
|
|
215
|
-
| `StickyNote` | interface | `dist/flow-sdk.d.ts
|
|
216
|
-
| `StickyNoteColor` | type | `dist/flow-sdk.d.ts
|
|
217
|
-
| `subflow` | function | `dist/flow-sdk.d.ts
|
|
218
|
-
| `SubflowSpec` | interface | `dist/flow-sdk.d.ts
|
|
219
|
-
| `summarize` | function | `dist/core/actions.d.ts
|
|
220
|
-
| `SummarizeInputs` | interface | `dist/core/actions.d.ts
|
|
221
|
-
| `SwitchArm` | interface | `dist/flow-sdk.d.ts
|
|
222
|
-
| `tmpl` | function | `dist/core/expr.d.ts
|
|
223
|
-
| `ToolRef` | type | `dist/core/actions.d.ts
|
|
224
|
-
| `transform` | function | `dist/core/actions.d.ts
|
|
225
|
-
| `Transformation` | type | `dist/core/actions.d.ts
|
|
226
|
-
| `TransformInputs` | interface | `dist/core/actions.d.ts
|
|
227
|
-
| `TransformOperation` | type | `dist/core/actions.d.ts
|
|
228
|
-
| `TransformVariant` | type | `dist/core/actions.d.ts
|
|
229
|
-
| `triggerDescriptor` | function | `dist/core/connectors.d.ts
|
|
230
|
-
| `TriggerDescriptor` | type | `dist/core/connectors.d.ts
|
|
231
|
-
| `TriggerMeta` | interface | `dist/core/connectors.d.ts
|
|
232
|
-
| `TriggerOptions` | interface | `dist/core/actions.d.ts
|
|
233
|
-
| `TriggerSpec` | type | `dist/flow-sdk.d.ts
|
|
234
|
-
| `TypeDesc` | type | `dist/core/expr.d.ts`
|
|
235
|
-
| `types` | const | `dist/core/expr.d.ts
|
|
236
|
-
| `unresolvedLookupMessage` | function | `dist/core/lookups.d.ts
|
|
237
|
-
| `v` | function | `dist/core/expr.d.ts
|
|
238
|
-
| `VarDecl` | interface | `dist/flow-sdk.d.ts
|
|
239
|
-
| `VarSpec` | interface | `dist/flow-sdk.d.ts
|
|
240
|
-
| `voiceAgent` | function | `dist/core/actions.d.ts
|
|
241
|
-
| `VoiceAgentInputs` | interface | `dist/core/actions.d.ts
|
|
242
|
-
| `VoiceSettings` | interface | `dist/core/actions.d.ts
|
|
243
|
-
| `voiceTrigger` | function | `dist/flow-sdk.d.ts
|
|
244
|
-
| `waitForEvent` | function | `dist/core/actions.d.ts
|
|
245
|
-
| `waitForEvent` | function | `dist/core/actions.d.ts
|
|
246
|
-
| `waitForMessage` | function | `dist/core/actions.d.ts
|
|
247
|
-
| `WaitForMessageInputs` | interface | `dist/core/actions.d.ts
|
|
44
|
+
| `ActionSpec` | type | `dist/core/actions.d.ts:2105-2200` | Supporting types | |
|
|
45
|
+
| `agent` | function | `dist/core/actions.d.ts:2805-2859` | Actions | Invoke an AGENT resource — either one published to Orchestrator or a sibling agent project registered in the same… |
|
|
46
|
+
| `AgentFlavour` | type | `dist/core/actions.d.ts:1140-1144` | Supporting types | Which KIND of agent project was published behind a `uipath.core.agent.<key>` resource. |
|
|
47
|
+
| `AgentGuardrail` | type | `dist/core/actions.d.ts:1368` | Supporting types | |
|
|
48
|
+
| `agenticProcess` | function | `dist/core/actions.d.ts:2759-2804` | Actions | Invoke a deployed AGENTIC PROCESS — a Maestro process orchestration published to Orchestrator: a BPMN process that… |
|
|
49
|
+
| `AgenticProcessCompletion` | type | `dist/core/actions.d.ts:1099-1137` | Supporting types | Whether an Agentic Process step waits for the process's result. |
|
|
50
|
+
| `AgenticProcessInputs` | type | `dist/core/actions.d.ts:1138-1139` | Option shapes | What `agenticProcess()` takes: the shared fields plus the completion policy. |
|
|
51
|
+
| `AgenticProcessInputsBase` | interface | `dist/core/actions.d.ts:1064-1098` | Option shapes | 5 field(s) |
|
|
52
|
+
| `AgentInputs` | interface | `dist/core/actions.d.ts:1146-1240` | Option shapes | 8 field(s) |
|
|
53
|
+
| `AgentLocation` | type | `dist/core/actions.d.ts:1145` | Supporting types | |
|
|
54
|
+
| `AgentMemoryRef` | interface | `dist/core/actions.d.ts:1716-1740` | Supporting types | An episodic memory the agent learns from across runs, wired to the agent's own `memory` handle. |
|
|
55
|
+
| `Aggregation` | interface | `dist/core/actions.d.ts:246-252` | Supporting types | 3 field(s) |
|
|
56
|
+
| `AggregationOperation` | type | `dist/core/actions.d.ts:245` | Supporting types | |
|
|
57
|
+
| `apiWorkflow` | function | `dist/core/actions.d.ts:2573-2607` | Actions | Invoke a deployed API workflow — a coded workflow published to Orchestrator, run as a serverless job rather than by a… |
|
|
58
|
+
| `ApiWorkflowInputs` | interface | `dist/core/actions.d.ts:997-1028` | Option shapes | 5 field(s) |
|
|
59
|
+
| `AppRef` | interface | `dist/core/actions.d.ts:493-538` | Supporting types | A deployed Action App that supplies a human task's form — the `'action-app'` variant's subject. |
|
|
60
|
+
| `ArmBuilder` | class | `dist/flow-sdk.d.ts:1092-1115` | Builders | The sub-builder an ARM callback receives — a `StepList` that can also name itself with `.label(...)`. |
|
|
61
|
+
| `AskedField` | interface | `dist/core/actions.d.ts:341-351` | Supporting types | A value the reviewer FILLS IN: read downstream with `out('<step>', '<id>')`. |
|
|
62
|
+
| `batchTransform` | function | `dist/core/actions.d.ts:2376-2410` | Actions | Add AI-generated columns to a CSV — the platform's **Batch transform** node, `uipath.pattern.batch-transform` (service… |
|
|
63
|
+
| `BatchTransformInputs` | interface | `dist/core/actions.d.ts:824-839` | Option shapes | 4 field(s) |
|
|
64
|
+
| `BindingContribution` | interface | `dist/core/node-classes.d.ts:76-97` | Supporting types | A resource binding a contribution hoists to the flow's top-level `bindings` array — the shape the `.flow` format… |
|
|
65
|
+
| `BuiltEntryPoint` | interface | `dist/flow-sdk.d.ts:621-633` | Supporting types | One additional flow root, built by `.entryPoint()`. |
|
|
66
|
+
| `BuiltFlow` | interface | `dist/flow-sdk.d.ts:634-669` | Supporting types | 15 field(s) |
|
|
67
|
+
| `BuiltinToolName` | type | `dist/core/actions.d.ts:1608-1609` | Supporting types | The three platform-shipped built-in tools (fixed registry types). |
|
|
68
|
+
| `BuiltinToolRef` | interface | `dist/core/actions.d.ts:1741-1761` | Supporting types | A platform built-in tool. |
|
|
69
|
+
| `BuiltInValidatorGuardrail` | interface | `dist/core/actions.d.ts:1326-1367` | Supporting types | A platform-shipped validator, configured by parameters. |
|
|
70
|
+
| `CaseValue` | type | `dist/flow-sdk.d.ts:287-288` | Supporting types | A value a `.switch` case compares the discriminant against. |
|
|
71
|
+
| `ChildFlow` | type | `dist/flow-sdk.d.ts:43-46` | Supporting types | Anything `subflow()` accepts as the child: a builder, or an already-built flow. |
|
|
72
|
+
| `ClientSideToolRef` | interface | `dist/core/actions.d.ts:1670-1685` | Supporting types | A CLIENT-side tool: the agent asks the CALLING application to run it and hand the answer back… |
|
|
73
|
+
| `connector` | function | `dist/core/actions.d.ts:3035-3058` | Actions | Declare an Integration Service connector action — the typed form, where a generated descriptor supplies the nodeType and… |
|
|
74
|
+
| `connector` | function | `dist/core/actions.d.ts:3059-3075` | Actions | Stringly form, for a connector with no prepared module — `connector('uipath-salesforce-slack',… |
|
|
75
|
+
| `ConnectorDescriptor` | type | `dist/core/connectors.d.ts:89-97` | Generated descriptors | A generated, typed connector descriptor: ConnectorMeta branded with phantom input/output types. |
|
|
76
|
+
| `ConnectorLookupValue` | type | `dist/core/connectors.d.ts:50-59` | Generated descriptors | ConnectorValue for a field that also accepts an unresolved lookup. |
|
|
77
|
+
| `ConnectorMeta` | interface | `dist/core/connectors.d.ts:60-88` | Generated descriptors | Runtime metadata a generated descriptor carries. |
|
|
78
|
+
| `ConnectorOpts` | interface | `dist/core/actions.d.ts:177-217` | Option shapes | 4 field(s) |
|
|
79
|
+
| `ConnectorToolRef` | interface | `dist/core/actions.d.ts:1762-1780` | Supporting types | An Integration Service connector operation as a tool — e.g. |
|
|
80
|
+
| `ConnectorValue` | type | `dist/core/connectors.d.ts:26-49` | Generated descriptors | What a generated `Inputs` property accepts: the value, or an expression. |
|
|
81
|
+
| `ContextIndexRef` | interface | `dist/core/actions.d.ts:1913-1947` | Supporting types | One Context Grounding index an inline agent is grounded on. |
|
|
82
|
+
| `ContributionContext` | interface | `dist/core/node-classes.d.ts:64-75` | Supporting types | What the serializer tells a contributor before asking for its contribution. |
|
|
83
|
+
| `ContributionDiagnostic` | interface | `dist/core/node-classes.d.ts:1-29` | Supporting types | Definition-backed node base classes — the public extension surface. |
|
|
84
|
+
| `conversationalAgent` | function | `dist/core/actions.d.ts:2734-2758` | Actions | A CONVERSATIONAL agent (`uipath.agent.conversational`) — it answers one turn of a live chat, reading the transcript… |
|
|
85
|
+
| `ConversationalAgentInputs` | interface | `dist/core/actions.d.ts:672-709` | Option shapes | 10 field(s) |
|
|
86
|
+
| `ConversationalAgentSettings` | interface | `dist/core/actions.d.ts:648-671` | Supporting types | How a conversational agent gets its turn — the node's own `conversationalAgentSettings` sub-object. |
|
|
87
|
+
| `conversationContext` | function | `dist/core/actions.d.ts:2669-2683` | Actions | READ a conversation's transcript so far without waiting (`uipath.conversational.get-conversation-context`) — the shape a… |
|
|
88
|
+
| `ConversationContextInputs` | interface | `dist/core/actions.d.ts:640-647` | Option shapes | 2 field(s) |
|
|
89
|
+
| `conversationTrigger` | function | `dist/flow-sdk.d.ts:235-261` | Flow construction | Start the flow when a new CONVERSATION is created (`core.trigger.conversation`) — the entry point for a chat-driven… |
|
|
90
|
+
| `createOutgoingCall` | function | `dist/core/actions.d.ts:2684-2700` | Actions | Place an outgoing phone call (`uipath.conversational.voice.create-outgoing-call`) and get back the `callContext` every… |
|
|
91
|
+
| `CreateOutgoingCallInputs` | interface | `dist/core/actions.d.ts:710-718` | Option shapes | 2 field(s) |
|
|
92
|
+
| `CustomGuardrail` | interface | `dist/core/actions.d.ts:1313-1325` | Supporting types | A rule-based guardrail you author in place. |
|
|
93
|
+
| `DataFabricFilter` | interface | `dist/core/actions.d.ts:2019-2029` | Supporting types | One filter row on a Data Fabric read — rows AND together unless `or` is set. |
|
|
94
|
+
| `dataFabricRead` | function | `dist/core/actions.d.ts:2931-2971` | Actions | Read ONE entity record from Data Fabric (`core.datafabric.read`). |
|
|
95
|
+
| `DataFabricReadInputs` | interface | `dist/core/actions.d.ts:2030-2037` | Option shapes | 3 field(s) |
|
|
96
|
+
| `dataFabricUpdate` | function | `dist/core/actions.d.ts:2972-2988` | Actions | Update an entity record in Data Fabric (`core.datafabric.update`). |
|
|
97
|
+
| `DataFabricUpdateInputs` | interface | `dist/core/actions.d.ts:2038-2059` | Option shapes | 4 field(s) |
|
|
98
|
+
| `DEFAULT_TRIGGER_ID` | const | `dist/core/expr.d.ts:36-37` | Expressions and types | The manual trigger node's default id. |
|
|
99
|
+
| `DefinitionReference` | type | `dist/core/node-classes.d.ts:30-63` | Supporting types | An exact reference to the node definition a contribution compiles against. |
|
|
100
|
+
| `delay` | function | `dist/core/actions.d.ts:2466-2487` | Actions | Declare a delay — a step that pauses the flow for a fixed length of time and then carries on. |
|
|
101
|
+
| `DELAY_PRESETS` | const | `dist/core/actions.d.ts:932-939` | Actions | The twelve durations the designer's dropdown offers. |
|
|
102
|
+
| `DelayInputs` | type | `dist/core/actions.d.ts:940-961` | Option shapes | |
|
|
103
|
+
| `descriptor` | function | `dist/core/connectors.d.ts:98-110` | Generated descriptors | Brand a descriptor literal with its input/output types (zero runtime cost). |
|
|
104
|
+
| `documentClassify` | function | `dist/core/actions.d.ts:2911-2919` | Actions | Classify a document into a document type (`uipath.document.classify`). |
|
|
105
|
+
| `DocumentClassifyInputs` | interface | `dist/core/actions.d.ts:2060-2069` | Option shapes | 4 field(s) |
|
|
106
|
+
| `DocValidationInputs` | interface | `dist/core/actions.d.ts:431-454` | Option shapes | The Document Validation task's subject — `variant: 'document-validation'` only. |
|
|
107
|
+
| `DoWhileOptions` | interface | `dist/flow-sdk.d.ts:408-417` | Option shapes | Do-while options. |
|
|
108
|
+
| `dynamicExtract` | function | `dist/core/actions.d.ts:2920-2930` | Actions | Extract fields from a document with an INLINE schema — Dynamic Extract (`uipath.ixp.extract-document-builder`), the… |
|
|
109
|
+
| `DynamicExtractInputs` | interface | `dist/core/actions.d.ts:2070-2104` | Option shapes | 5 field(s) |
|
|
110
|
+
| `EdgeRoute` | interface | `dist/flow-sdk.d.ts:545-559` | Supporting types | One edge's route: user-dragged bends and/or the auto-router's waypoints. |
|
|
111
|
+
| `endCall` | function | `dist/core/actions.d.ts:2701-2708` | Actions | Hang up (`uipath.conversational.voice.end-call`). |
|
|
112
|
+
| `EndCallInputs` | interface | `dist/core/actions.d.ts:719-726` | Option shapes | 1 field(s) |
|
|
113
|
+
| `entryInput` | function | `dist/core/expr.d.ts:56-66` | Expressions and types | Reference an ENTRY POINT's scoped input: `entryInput('nightly', 'batchDate')` reads `$vars.nightly.output.batchDate` —… |
|
|
114
|
+
| `err` | function | `dist/core/expr.d.ts:148-235` | Expressions and types | Reference a FAILED step's error → `$vars.<step>.error[.<field>]`. |
|
|
115
|
+
| `ErrorEnvelopeField` | type | `dist/core/expr.d.ts:137-147` | Supporting types | The fields a failure envelope carries. |
|
|
116
|
+
| `EscalationRef` | interface | `dist/core/actions.d.ts:1858-1912` | Supporting types | One escalation an inline agent may raise — an Action Center app task a human completes (the `coded-action-app` variant,… |
|
|
117
|
+
| `EventFilter` | type | `dist/core/actions.d.ts:3076-3117` | Supporting types | One filter condition on the event payload. |
|
|
118
|
+
| `EventSubscription` | interface | `dist/core/actions.d.ts:3163-3201` | Option shapes | What a connector event subscribes to. |
|
|
119
|
+
| `Expr` | class | `dist/core/expr.d.ts:11-21` | Supporting types | A Flow expression. |
|
|
120
|
+
| `FieldMapping` | interface | `dist/core/actions.d.ts:237-244` | Supporting types | 3 field(s) |
|
|
121
|
+
| `FilterCondition` | type | `dist/core/actions.d.ts:220-221` | Supporting types | Comparison a filter rule applies to a field. |
|
|
122
|
+
| `FilterMatch` | type | `dist/core/actions.d.ts:218-219` | Supporting types | How a filter combines its rules: every rule must match, or any one. |
|
|
123
|
+
| `FilterRule` | interface | `dist/core/actions.d.ts:222-234` | Supporting types | 3 field(s) |
|
|
124
|
+
| `flow` | function | `dist/flow-sdk.d.ts:1347-1362` | Flow construction | Start building a flow with the given id. |
|
|
125
|
+
| `FlowAction` | class | `dist/core/node-classes.d.ts:158-164` | Supporting types | A node placed as a step — pass an instance to `.step(name, …)`. |
|
|
126
|
+
| `FlowActionSpec` | type | `dist/flow-sdk.d.ts:41-42` | Supporting types | What `.step()` accepts here: the shared actions plus this SDK's subflow. |
|
|
127
|
+
| `FlowBuilder` | class | `dist/flow-sdk.d.ts:1116-1346` | Builders | 13 member(s) |
|
|
128
|
+
| `FlowLayout` | interface | `dist/flow-sdk.d.ts:607-620` | Supporting types | Designer layout for a flow, keyed by AUTHOR-level ids: node entries by step name (plus the trigger id and `end`), edge… |
|
|
129
|
+
| `FlowNode` | class | `dist/core/node-classes.d.ts:122-157` | Supporting types | The abstract root of every definition-backed node the builder can place. |
|
|
130
|
+
| `FlowResource` | class | `dist/core/node-classes.d.ts:172-179` | Supporting types | A node attached to another semantic node — an inline agent's tool, context, memory, or escalation. |
|
|
131
|
+
| `FlowTrigger` | class | `dist/core/node-classes.d.ts:165-171` | Supporting types | A node that starts the flow — pass an instance to `.trigger(…)`. |
|
|
132
|
+
| `FormField` | type | `dist/core/actions.d.ts:370` | Supporting types | |
|
|
133
|
+
| `FormFieldType` | type | `dist/core/actions.d.ts:319-324` | Supporting types | A form field's type. |
|
|
134
|
+
| `formTrigger` | function | `dist/flow-sdk.d.ts:206-234` | Flow construction | Start the flow from a FORM a person fills in (`core.trigger.form`) — the platform renders one field per flow input and… |
|
|
135
|
+
| `GuardrailAction` | type | `dist/core/actions.d.ts:1302-1312` | Supporting types | What happens when a guardrail trips. |
|
|
136
|
+
| `GuardrailFieldReference` | interface | `dist/core/actions.d.ts:1269-1274` | Supporting types | A field the rule or filter action points at. |
|
|
137
|
+
| `GuardrailFieldSelector` | type | `dist/core/actions.d.ts:1275-1281` | Supporting types | All fields, or a named few. |
|
|
138
|
+
| `GuardrailRule` | type | `dist/core/actions.d.ts:1282-1301` | Supporting types | One condition of a custom guardrail. |
|
|
139
|
+
| `GuardrailScope` | type | `dist/core/actions.d.ts:1261-1262` | Supporting types | Where a guardrail applies: the whole agent, its LLM calls, or its tools. |
|
|
140
|
+
| `GuardrailSelector` | interface | `dist/core/actions.d.ts:1263-1268` | Supporting types | Which artifacts inside the scope the guardrail watches. |
|
|
141
|
+
| `hitl` | function | `dist/core/actions.d.ts:2283-2334` | Actions | Declare a human task — a step that pauses for a person to read some values, fill others in, and press one of the outcome… |
|
|
142
|
+
| `HitlAssigneeType` | type | `dist/core/actions.d.ts:377-384` | Supporting types | How the task is assigned, the platform's own vocabulary (canvas `HITL_ASSIGNEE_TYPE`): `'user'` a single user, `'group'`… |
|
|
143
|
+
| `HitlChannel` | type | `dist/core/actions.d.ts:371-376` | Supporting types | Where the task is delivered. |
|
|
144
|
+
| `HitlConnection` | interface | `dist/core/actions.d.ts:385-393` | Supporting types | A per-channel Integration Service connection (Slack / Teams delivery). |
|
|
145
|
+
| `HitlInputs` | interface | `dist/core/actions.d.ts:539-610` | Option shapes | 11 field(s) |
|
|
146
|
+
| `HitlRecipient` | interface | `dist/core/actions.d.ts:394-430` | Supporting types | Who gets the task and over which channels. |
|
|
147
|
+
| `HitlVariant` | type | `dist/core/actions.d.ts:467-492` | Supporting types | WHICH human-task node type to emit. |
|
|
148
|
+
| `http` | function | `dist/core/actions.d.ts:2221-2228` | Actions | Declare an HTTP request action, explicitly choosing standalone or managed. |
|
|
149
|
+
| `HttpBranch` | interface | `dist/core/actions.d.ts:14-29` | Supporting types | One conditional response branch on an HTTP node — a designer-visible side exit. |
|
|
150
|
+
| `HttpInputs` | type | `dist/core/actions.d.ts:121-138` | Option shapes | |
|
|
151
|
+
| `HttpInputsBase` | interface | `dist/core/actions.d.ts:30-120` | Option shapes | 11 field(s) |
|
|
152
|
+
| `HttpRequestToolRef` | interface | `dist/core/actions.d.ts:1686-1715` | Supporting types | The built-in HTTP-request tool (`uipath.agent.resource.tool.builtin.httprequest`): the agent performs an HTTP call. |
|
|
153
|
+
| `inlineAgent` | function | `dist/core/actions.d.ts:2860-2910` | Actions | Declare an INLINE AUTONOMOUS AGENT — an agent defined inside this flow's own project rather than published to… |
|
|
154
|
+
| `InlineAgentFieldType` | type | `dist/core/actions.d.ts:1241-1242` | Supporting types | A JSON-schema-ish type for one field of an inline agent's input/output schema. |
|
|
155
|
+
| `InlineAgentInputs` | interface | `dist/core/actions.d.ts:1369-1607` | Option shapes | 16 field(s) |
|
|
156
|
+
| `InOutField` | interface | `dist/core/actions.d.ts:352-369` | Supporting types | A value the reviewer READS **and can correct**: pre-filled from the flow, editable on the form, and the (possibly… |
|
|
157
|
+
| `input` | function | `dist/core/expr.d.ts:38-55` | Expressions and types | Reference a flow input by name → `$vars.<triggerId>.output.<name>`. |
|
|
158
|
+
| `isLookupToken` | function | `dist/core/lookups.d.ts:53-54` | Generated descriptors | True when `v` is an unresolved LookupToken. |
|
|
159
|
+
| `ixpExtract` | function | `dist/core/actions.d.ts:2411-2465` | Actions | Extract fields from a document with a published IxP project — the platform's **Extract** node (`uipath.ixp.*`, service… |
|
|
160
|
+
| `IxpExtractInputs` | interface | `dist/core/actions.d.ts:857-931` | Option shapes | 9 field(s) |
|
|
161
|
+
| `IxpToolRef` | interface | `dist/core/actions.d.ts:1819-1857` | Supporting types | A published IxP (Intelligent eXtraction Platform) project as a tool — the agent decides when to extract a document and… |
|
|
162
|
+
| `js` | function | `dist/core/expr.d.ts:236-247` | Expressions and types | Build a raw JS *expression* (a condition or computation). |
|
|
163
|
+
| `lit` | function | `dist/core/expr.d.ts:22-28` | Expressions and types | A constant value baked directly into a node input. |
|
|
164
|
+
| `lookup` | function | `dist/core/lookups.d.ts:95-102` | Generated descriptors | Begin resolving a lookup field on a generated descriptor. |
|
|
165
|
+
| `lookup` | function | `dist/core/lookups.d.ts:103-122` | Generated descriptors | Begin resolving a lookup field addressed by connector key and action. |
|
|
166
|
+
| `lookup` | function | `dist/core/lookups.d.ts:123-137` | Generated descriptors | Begin resolving a `where` parameter on a trigger descriptor that carries a lookup table. |
|
|
167
|
+
| `lookup` | function | `dist/core/lookups.d.ts:138-159` | Generated descriptors | Begin resolving a `where` parameter on a connector-EVENT descriptor. |
|
|
168
|
+
| `LookupBuilder` | type | `dist/core/lookups.d.ts:64-71` | Generated descriptors | What `lookup(...)` returns: the generic form plus any generated aliases. |
|
|
169
|
+
| `lookupKey` | function | `dist/core/lookups.d.ts:55-63` | Generated descriptors | The identity of one resolution, as `prepare` records it and `compile` reads it. |
|
|
170
|
+
| `LookupResolution` | interface | `dist/core/lookups.d.ts:160-169` | Generated descriptors | One recorded resolution, as `connectors-local/resolutions.json` stores it. |
|
|
171
|
+
| `LookupResolutions` | type | `dist/core/lookups.d.ts:170-171` | Generated descriptors | Every recorded resolution, keyed by lookupKey. |
|
|
172
|
+
| `LookupSpec` | interface | `dist/core/lookups.d.ts:11-36` | Generated descriptors | One lookup field's retrieval contract, generated from `reference`. |
|
|
173
|
+
| `lookupSpecOf` | function | `dist/core/lookups.d.ts:199-206` | Generated descriptors | The LookupSpec for one field, or `undefined` when it earns no helper. |
|
|
174
|
+
| `LookupStrategy` | type | `dist/core/lookups.d.ts:1-10` | Generated descriptors | How `prepare` should retrieve the collection, chosen from the metadata. |
|
|
175
|
+
| `LookupToken` | interface | `dist/core/lookups.d.ts:37-52` | Generated descriptors | An unresolved lookup: what `.byEmail(…)` returns. |
|
|
176
|
+
| `LoopOptions` | interface | `dist/flow-sdk.d.ts:386-407` | Option shapes | Loop-specific options. |
|
|
177
|
+
| `manual` | function | `dist/flow-sdk.d.ts:130-139` | Flow construction | The manual trigger, explicitly. |
|
|
178
|
+
| `McpToolRef` | interface | `dist/core/actions.d.ts:1620-1648` | Supporting types | An MCP server the agent may call tools on. |
|
|
179
|
+
| `mock` | function | `dist/core/actions.d.ts:2488-2527` | Actions | Declare a PLACEHOLDER step — "a real node goes here later". |
|
|
180
|
+
| `NodeContribution` | interface | `dist/core/node-classes.d.ts:98-121` | Supporting types | One validated construct, returned by FlowNode.contribute. |
|
|
181
|
+
| `NodeLayout` | interface | `dist/flow-sdk.d.ts:530-544` | Supporting types | One node's designer layout: canvas position, and optionally size and collapsed state. |
|
|
182
|
+
| `NodeOptions` | interface | `dist/flow-sdk.d.ts:308-353` | Option shapes | Options shared by every builder method that creates a definition-backed node: `version` selects the exact node… |
|
|
183
|
+
| `onEvent` | function | `dist/flow-sdk.d.ts:140-177` | Flow construction | Start the flow when a connector event fires — e.g. |
|
|
184
|
+
| `onEvent` | function | `dist/flow-sdk.d.ts:178-185` | Flow construction | Stringly form, for an event with no prepared module. |
|
|
185
|
+
| `out` | function | `dist/core/expr.d.ts:67-89` | Expressions and types | Reference an upstream step's output → `$vars.<step>.output[.<path>]`. |
|
|
186
|
+
| `Outcome` | type | `dist/core/actions.d.ts:455-466` | Supporting types | One completion button. |
|
|
187
|
+
| `OutputColumn` | interface | `dist/core/actions.d.ts:817-823` | Supporting types | One column Batch Transform appends to the CSV. |
|
|
188
|
+
| `PortArm` | interface | `dist/flow-sdk.d.ts:295-307` | Supporting types | One arm of a built `.stepSwitch` — the same shape as SwitchArm, but `value` names an exit the ACTION declares (a… |
|
|
189
|
+
| `ProcessToolKind` | type | `dist/core/actions.d.ts:1781-1794` | Supporting types | The tool kinds that wrap a DEPLOYED tenant resource. |
|
|
190
|
+
| `ProcessToolRef` | interface | `dist/core/actions.d.ts:1795-1818` | Supporting types | A deployed tenant resource the agent may invoke. |
|
|
191
|
+
| `publishedFunction` | function | `dist/core/actions.d.ts:2608-2632` | Actions | Invoke a published Orchestrator **Function** — a deployed unit of code run as one step (`uipath.core.function.<key>`,… |
|
|
192
|
+
| `PublishedFunctionInputs` | interface | `dist/core/actions.d.ts:1029-1063` | Option shapes | A published Orchestrator **Function** — a small, single-purpose unit of code deployed as its own resource and invoked as… |
|
|
193
|
+
| `queueItem` | function | `dist/core/actions.d.ts:2989-3034` | Actions | Declare an Orchestrator QUEUE ITEM step. |
|
|
194
|
+
| `QueueItemInputs` | interface | `dist/core/actions.d.ts:1950-2018` | Option shapes | 10 field(s) |
|
|
195
|
+
| `QueuePriority` | type | `dist/core/actions.d.ts:1948-1949` | Supporting types | The three priorities an Orchestrator queue item can carry. |
|
|
196
|
+
| `ran` | function | `dist/core/expr.d.ts:90-136` | Expressions and types | Did this step run? |
|
|
197
|
+
| `rawNode` | function | `dist/core/node-classes.d.ts:180-234` | Supporting types | Place a node this SDK has no factory for, carrying its definition verbatim (`uipath.exotic.thing@2.1` and the manifest… |
|
|
198
|
+
| `RawReference` | type | `dist/core/lookups.d.ts:190-198` | Supporting types | |
|
|
199
|
+
| `refuseLookupToken` | function | `dist/core/lookups.d.ts:207-226` | Generated descriptors | Refuse a lookup token where the family cannot resolve one. |
|
|
200
|
+
| `RemoteA2aToolRef` | interface | `dist/core/actions.d.ts:1649-1669` | Supporting types | A remote A2A (agent-to-agent) endpoint the agent may delegate to. |
|
|
201
|
+
| `resolvedValue` | function | `dist/core/lookups.d.ts:172-179` | Generated descriptors | The recorded id for a token, or `undefined`. |
|
|
202
|
+
| `ReturnFieldType` | type | `dist/core/actions.d.ts:1243-1260` | Supporting types | A JSON-schema-ish type for one field of a step's declared `returns`. |
|
|
203
|
+
| `ReturnOptions` | interface | `dist/flow-sdk.d.ts:354-385` | Option shapes | `.return(...)`-specific options. |
|
|
204
|
+
| `rpaWorkflow` | function | `dist/core/actions.d.ts:2528-2572` | Actions | Invoke a deployed RPA (robotic process automation) workflow — a classic UI-automation process, published to… |
|
|
205
|
+
| `RpaWorkflowInputs` | interface | `dist/core/actions.d.ts:962-996` | Option shapes | 5 field(s) |
|
|
206
|
+
| `SCHEDULE_PRESETS` | const | `dist/flow-sdk.d.ts:77-84` | Flow construction | The eight intervals the designer offers in its Frequency dropdown. |
|
|
207
|
+
| `scheduled` | function | `dist/flow-sdk.d.ts:186-205` | Flow construction | Start the flow on a recurring schedule instead of on demand. |
|
|
208
|
+
| `ScheduledInputs` | interface | `dist/flow-sdk.d.ts:98-110` | Option shapes | 1 field(s) |
|
|
209
|
+
| `ScheduleEvery` | type | `dist/flow-sdk.d.ts:86-97` | Supporting types | How often a scheduled flow runs, as an ISO-8601 repeating interval: `R/` followed by a duration. |
|
|
210
|
+
| `SchedulePreset` | type | `dist/flow-sdk.d.ts:85` | Supporting types | |
|
|
211
|
+
| `script` | function | `dist/core/actions.d.ts:2229-2236` | Actions | Declare an inline script action. |
|
|
212
|
+
| `ScriptInputs` | interface | `dist/core/actions.d.ts:139-176` | Option shapes | 2 field(s) |
|
|
213
|
+
| `ScriptReturns` | type | `dist/core/script-return.d.ts:33-38` | Supporting types | What an author may write for `script({ returns })`: the type outright, or — for an object return — the FIELDS, which is… |
|
|
214
|
+
| `ScriptReturnType` | type | `dist/core/script-return.d.ts:31-32` | Supporting types | The vocabulary a script's output can be declared as. |
|
|
215
|
+
| `sendMessage` | function | `dist/core/actions.d.ts:2633-2651` | Actions | Post an assistant message into a live conversation (`uipath.conversational.send-message`). |
|
|
216
|
+
| `SendMessageInputs` | interface | `dist/core/actions.d.ts:611-630` | Option shapes | 4 field(s) |
|
|
217
|
+
| `ShownField` | interface | `dist/core/actions.d.ts:325-340` | Supporting types | A value the reviewer READS: shown on the form, filled in from the flow. |
|
|
218
|
+
| `Step` | type | `dist/flow-sdk.d.ts:418-529` | Supporting types | |
|
|
219
|
+
| `StepList` | class | `dist/flow-sdk.d.ts:670-1091` | Builders | Collects a sequence of steps. |
|
|
220
|
+
| `STICKY_NOTE_COLORS` | const | `dist/flow-sdk.d.ts:560-565` | Flow construction | The designer's sticky-note palette. |
|
|
221
|
+
| `StickyNote` | interface | `dist/flow-sdk.d.ts:572-606` | Supporting types | A canvas sticky note — free text pinned to the diagram, for the humans reading it. |
|
|
222
|
+
| `StickyNoteColor` | type | `dist/flow-sdk.d.ts:566-571` | Supporting types | A sticky note's swatch. |
|
|
223
|
+
| `subflow` | function | `dist/flow-sdk.d.ts:1363-1402` | Flow construction | Run another flow as one step, and read back what it returns. |
|
|
224
|
+
| `SubflowSpec` | interface | `dist/flow-sdk.d.ts:33-40` | Supporting types | A step that runs a child flow. |
|
|
225
|
+
| `summarize` | function | `dist/core/actions.d.ts:2335-2375` | Actions | Summarize a document with citations — the platform's **Summarize** node. |
|
|
226
|
+
| `SummarizeInputs` | interface | `dist/core/actions.d.ts:784-816` | Option shapes | 3 field(s) |
|
|
227
|
+
| `SwitchArm` | interface | `dist/flow-sdk.d.ts:289-294` | Supporting types | One arm of a built `.switch` (the serializer's view: body already collected). |
|
|
228
|
+
| `tmpl` | function | `dist/core/expr.d.ts:248-258` | Expressions and types | Build a JS *string template* (for URLs, messages, etc.). |
|
|
229
|
+
| `ToolRef` | type | `dist/core/actions.d.ts:1610-1619` | Supporting types | One tool on an inline agent — a discriminated union over the kinds the tenant's registry actually serves… |
|
|
230
|
+
| `transform` | function | `dist/core/actions.d.ts:2237-2282` | Actions | Declare a Transform action — a chain of declarative operations over a collection. |
|
|
231
|
+
| `Transformation` | type | `dist/core/actions.d.ts:235-236` | Supporting types | What a map does to a field's value. |
|
|
232
|
+
| `TransformInputs` | interface | `dist/core/actions.d.ts:294-318` | Option shapes | 3 field(s) |
|
|
233
|
+
| `TransformOperation` | type | `dist/core/actions.d.ts:253-270` | Supporting types | One link in the chain. |
|
|
234
|
+
| `TransformVariant` | type | `dist/core/actions.d.ts:271-287` | Supporting types | Which Transform node type to emit. |
|
|
235
|
+
| `triggerDescriptor` | function | `dist/core/connectors.d.ts:139-151` | Generated descriptors | Brand a trigger descriptor literal with its where/output types. |
|
|
236
|
+
| `TriggerDescriptor` | type | `dist/core/connectors.d.ts:130-138` | Generated descriptors | A generated, typed connector-trigger descriptor: TriggerMeta branded with phantom `where`/output types. |
|
|
237
|
+
| `TriggerMeta` | interface | `dist/core/connectors.d.ts:120-129` | Generated descriptors | Runtime metadata a generated trigger descriptor carries. |
|
|
238
|
+
| `TriggerOptions` | interface | `dist/core/actions.d.ts:3118-3162` | Option shapes | The typed `onEvent`/`waitForEvent` options — everything an EventSubscription carries except `connector`/`event`, which… |
|
|
239
|
+
| `TriggerSpec` | type | `dist/flow-sdk.d.ts:111-129` | Supporting types | What starts the flow. |
|
|
240
|
+
| `TypeDesc` | type | `dist/core/expr.d.ts:323` | Supporting types | |
|
|
241
|
+
| `types` | const | `dist/core/expr.d.ts:307-322` | Expressions and types | Variable type descriptors (map to Flow variable `type` values). |
|
|
242
|
+
| `unresolvedLookupMessage` | function | `dist/core/lookups.d.ts:180-189` | Generated descriptors | The message for a lookup nothing has resolved — the command that fixes it. |
|
|
243
|
+
| `v` | function | `dist/core/expr.d.ts:29-35` | Expressions and types | Reference a flow-level variable or input by name → `$vars.<name>`. |
|
|
244
|
+
| `VarDecl` | interface | `dist/flow-sdk.d.ts:47-57` | Supporting types | 6 field(s) |
|
|
245
|
+
| `VarSpec` | interface | `dist/flow-sdk.d.ts:58-76` | Supporting types | The rich spelling of a variable declaration: pass it instead of a bare `types.*` descriptor wherever `.input()` /… |
|
|
246
|
+
| `voiceAgent` | function | `dist/core/actions.d.ts:2709-2733` | Actions | Put a VOICE agent on a live call (`uipath.agent.voice`) — it speaks and listens for one turn, then the flow continues. |
|
|
247
|
+
| `VoiceAgentInputs` | interface | `dist/core/actions.d.ts:750-783` | Option shapes | 6 field(s) |
|
|
248
|
+
| `VoiceSettings` | interface | `dist/core/actions.d.ts:727-749` | Supporting types | The audio settings a voice agent speaks with. |
|
|
249
|
+
| `voiceTrigger` | function | `dist/flow-sdk.d.ts:262-286` | Flow construction | Start the flow when a phone call comes IN (`core.trigger.voice`). |
|
|
250
|
+
| `waitForEvent` | function | `dist/core/actions.d.ts:3211-3245` | Actions | Wait mid-flow until a connector event fires, then continue with its payload — the typed form, where a generated trigger… |
|
|
251
|
+
| `waitForEvent` | function | `dist/core/actions.d.ts:3246-3253` | Actions | Stringly form, for an event with no prepared module. |
|
|
252
|
+
| `waitForMessage` | function | `dist/core/actions.d.ts:2652-2668` | Actions | PAUSE until the person sends their next message (`uipath.conversational.wait-for-message`) — a catch event, like… |
|
|
253
|
+
| `WaitForMessageInputs` | interface | `dist/core/actions.d.ts:631-639` | Option shapes | 2 field(s) |
|
|
248
254
|
|
|
249
255
|
## `@uipath/maestro-builder-sdk/case`
|
|
250
256
|
|
|
@@ -252,84 +258,84 @@ that is the thing to check first.
|
|
|
252
258
|
|
|
253
259
|
| Symbol | Kind | Declaration | Area | Summary |
|
|
254
260
|
| --- | --- | --- | --- | --- |
|
|
255
|
-
| `ActionField` | interface | `dist/case/case-sdk.d.ts
|
|
256
|
-
| `ActionSpecData` | interface | `dist/case/case-sdk.d.ts
|
|
257
|
-
| `BuiltCase` | interface | `dist/case/case-sdk.d.ts
|
|
258
|
-
| `BuiltCaseExitCondition` | interface | `dist/case/case-sdk.d.ts
|
|
259
|
-
| `BuiltEntryCondition` | interface | `dist/case/case-sdk.d.ts
|
|
260
|
-
| `BuiltEscalation` | interface | `dist/case/case-sdk.d.ts
|
|
261
|
-
| `BuiltExitCondition` | interface | `dist/case/case-sdk.d.ts
|
|
262
|
-
| `BuiltSla` | interface | `dist/case/case-sdk.d.ts
|
|
263
|
-
| `BuiltStage` | interface | `dist/case/case-sdk.d.ts
|
|
264
|
-
| `BuiltTask` | interface | `dist/case/case-sdk.d.ts
|
|
265
|
-
| `BuiltTaskEntryCondition` | interface | `dist/case/case-sdk.d.ts
|
|
266
|
-
| `BuiltTrigger` | interface | `dist/case/case-sdk.d.ts
|
|
267
|
-
| `CaseAppConfig` | interface | `dist/case/case-sdk.d.ts
|
|
268
|
-
| `CaseAppDetailValue` | type | `dist/case/case-sdk.d.ts
|
|
269
|
-
| `CaseAppSection` | interface | `dist/case/case-sdk.d.ts
|
|
270
|
-
| `CaseBuilder` | class | `dist/case/case-sdk.d.ts
|
|
271
|
-
| `CaseLayout` | interface | `dist/case/case-sdk.d.ts
|
|
272
|
-
| `CaseNodeLayout` | interface | `dist/case/case-sdk.d.ts
|
|
273
|
-
| `casePlan` | function | `dist/case/case-sdk.d.ts
|
|
274
|
-
| `CaseRule` | interface | `dist/case/case-sdk.d.ts
|
|
275
|
-
| `CaseRuleGrid` | type | `dist/case/case-sdk.d.ts
|
|
276
|
-
| `CaseRuleInput` | type | `dist/case/case-sdk.d.ts
|
|
277
|
-
| `CaseRuleType` | type | `dist/case/case-sdk.d.ts`
|
|
278
|
-
| `CaseTriggerKind` | type | `dist/case/case-sdk.d.ts`
|
|
279
|
-
| `CaseVarDecl` | interface | `dist/case/case-sdk.d.ts
|
|
280
|
-
| `ConnectorDescriptor` | type | `dist/core/connectors.d.ts
|
|
281
|
-
| `ConnectorMeta` | interface | `dist/core/connectors.d.ts
|
|
282
|
-
| `ConnectorOpts` | interface | `dist/core/actions.d.ts
|
|
283
|
-
| `ConnectorSpecData` | type | `dist/case/case-sdk.d.ts
|
|
284
|
-
| `EntryOpts` | interface | `dist/case/case-sdk.d.ts
|
|
285
|
-
| `escalation` | function | `dist/case/case-sdk.d.ts
|
|
286
|
-
| `EscalationOpts` | interface | `dist/case/case-sdk.d.ts
|
|
287
|
-
| `EscalationRecipient` | interface | `dist/case/case-sdk.d.ts
|
|
288
|
-
| `EscalationTrigger` | type | `dist/case/case-sdk.d.ts
|
|
289
|
-
| `EventFilter` | type | `dist/core/actions.d.ts
|
|
290
|
-
| `EventSubscription` | interface | `dist/core/actions.d.ts
|
|
291
|
-
| `eventTrigger` | function | `dist/case/case-sdk.d.ts
|
|
292
|
-
| `eventTrigger` | function | `dist/case/case-sdk.d.ts
|
|
293
|
-
| `EventTriggerOpts` | interface | `dist/case/case-sdk.d.ts
|
|
294
|
-
| `ExitOpts` | interface | `dist/case/case-sdk.d.ts
|
|
295
|
-
| `ExternalExecutionMode` | type | `dist/case/case-sdk.d.ts
|
|
296
|
-
| `ExternalTaskOptions` | interface | `dist/case/case-sdk.d.ts
|
|
297
|
-
| `ExternalTaskSpecData` | interface | `dist/case/case-sdk.d.ts
|
|
298
|
-
| `jsonSchema` | function | `dist/case/case-sdk.d.ts
|
|
299
|
-
| `JsonSchemaType` | interface | `dist/case/case-sdk.d.ts
|
|
300
|
-
| `LookupSpec` | interface | `dist/core/lookups.d.ts
|
|
301
|
-
| `LookupStrategy` | type | `dist/core/lookups.d.ts
|
|
302
|
-
| `LookupToken` | interface | `dist/core/lookups.d.ts
|
|
303
|
-
| `manualTrigger` | function | `dist/case/case-sdk.d.ts
|
|
304
|
-
| `ManualTriggerOpts` | interface | `dist/case/case-sdk.d.ts
|
|
305
|
-
| `RecipientType` | type | `dist/case/case-sdk.d.ts
|
|
306
|
-
| `ResolvedEventTriggerOpts` | interface | `dist/case/case-sdk.d.ts
|
|
307
|
-
| `rule` | function | `dist/case/case-sdk.d.ts
|
|
308
|
-
| `RuleOpts` | interface | `dist/case/case-sdk.d.ts
|
|
309
|
-
| `SelectNextStageSpec` | interface | `dist/case/case-sdk.d.ts
|
|
310
|
-
| `SlaOpts` | interface | `dist/case/case-sdk.d.ts
|
|
311
|
-
| `SlaUnit` | type | `dist/case/case-sdk.d.ts
|
|
312
|
-
| `StageBuilder` | class | `dist/case/case-sdk.d.ts
|
|
313
|
-
| `StageExitType` | type | `dist/case/case-sdk.d.ts`
|
|
314
|
-
| `TaskBuilder` | class | `dist/case/case-sdk.d.ts
|
|
315
|
-
| `TaskInputBinding` | interface | `dist/case/case-sdk.d.ts
|
|
316
|
-
| `TaskKind` | type | `dist/case/case-sdk.d.ts`
|
|
317
|
-
| `TaskOutputBinding` | interface | `dist/case/case-sdk.d.ts
|
|
318
|
-
| `TaskRef` | interface | `dist/case/case-sdk.d.ts
|
|
319
|
-
| `TimerSpecData` | type | `dist/case/case-sdk.d.ts
|
|
320
|
-
| `timerTrigger` | function | `dist/case/case-sdk.d.ts
|
|
321
|
-
| `TimerTriggerOpts` | interface | `dist/case/case-sdk.d.ts
|
|
322
|
-
| `toGroup` | function | `dist/case/case-sdk.d.ts
|
|
323
|
-
| `toUser` | function | `dist/case/case-sdk.d.ts
|
|
324
|
-
| `TriggerDescriptor` | type | `dist/core/connectors.d.ts
|
|
325
|
-
| `TriggerMeta` | interface | `dist/core/connectors.d.ts
|
|
326
|
-
| `TriggerOptions` | interface | `dist/core/actions.d.ts
|
|
327
|
-
| `TypeDesc` | type | `dist/core/expr.d.ts`
|
|
328
|
-
| `UnresolvedReferenceTaskKind` | type | `dist/case/case-sdk.d.ts
|
|
329
|
-
| `WaitConnectorPlaceholderSpec` | interface | `dist/case/case-sdk.d.ts
|
|
330
|
-
| `WaitConnectorSpec` | type | `dist/case/case-sdk.d.ts
|
|
331
|
-
| `when` | function | `dist/case/case-sdk.d.ts
|
|
332
|
-
| `WhenExpression` | interface | `dist/case/case-sdk.d.ts
|
|
261
|
+
| `ActionField` | interface | `dist/case/case-sdk.d.ts:420-450` | Supporting types | One field of an Action Center task's form. |
|
|
262
|
+
| `ActionSpecData` | interface | `dist/case/case-sdk.d.ts:451-466` | Supporting types | 7 field(s) |
|
|
263
|
+
| `BuiltCase` | interface | `dist/case/case-sdk.d.ts:623-648` | Supporting types | 15 field(s) |
|
|
264
|
+
| `BuiltCaseExitCondition` | interface | `dist/case/case-sdk.d.ts:352-356` | Supporting types | 3 field(s) |
|
|
265
|
+
| `BuiltEntryCondition` | interface | `dist/case/case-sdk.d.ts:294-298` | Supporting types | 3 field(s) |
|
|
266
|
+
| `BuiltEscalation` | interface | `dist/case/case-sdk.d.ts:140-142` | Supporting types | A built escalation (the notification an SLA fires). |
|
|
267
|
+
| `BuiltExitCondition` | interface | `dist/case/case-sdk.d.ts:319-347` | Supporting types | 6 field(s) |
|
|
268
|
+
| `BuiltSla` | interface | `dist/case/case-sdk.d.ts:186-194` | Supporting types | A built SLA rule (`slaRules[]` entry). |
|
|
269
|
+
| `BuiltStage` | interface | `dist/case/case-sdk.d.ts:522-531` | Supporting types | 8 field(s) |
|
|
270
|
+
| `BuiltTask` | interface | `dist/case/case-sdk.d.ts:500-521` | Supporting types | 15 field(s) |
|
|
271
|
+
| `BuiltTaskEntryCondition` | interface | `dist/case/case-sdk.d.ts:348-351` | Supporting types | 2 field(s) |
|
|
272
|
+
| `BuiltTrigger` | interface | `dist/case/case-sdk.d.ts:196-207` | Supporting types | 6 field(s) |
|
|
273
|
+
| `CaseAppConfig` | interface | `dist/case/case-sdk.d.ts:583-589` | Supporting types | Typed configuration for the generated Case App. |
|
|
274
|
+
| `CaseAppDetailValue` | type | `dist/case/case-sdk.d.ts:572-573` | Supporting types | A value displayed in one Case App section. |
|
|
275
|
+
| `CaseAppSection` | interface | `dist/case/case-sdk.d.ts:574-582` | Supporting types | One summary section in the generated Case App. |
|
|
276
|
+
| `CaseBuilder` | class | `dist/case/case-sdk.d.ts:1032-1275` | Builders | 17 member(s) |
|
|
277
|
+
| `CaseLayout` | interface | `dist/case/case-sdk.d.ts:611-622` | Supporting types | Optional Case designer layout, keyed by author-level stage and trigger names. |
|
|
278
|
+
| `CaseNodeLayout` | interface | `dist/case/case-sdk.d.ts:590-610` | Supporting types | Designer-only fields the shipped Case transformer moves into `layout.nodes[id]`. |
|
|
279
|
+
| `casePlan` | function | `dist/case/case-sdk.d.ts:1276-1282` | Case authoring | Start building a case plan with the given id. |
|
|
280
|
+
| `CaseRule` | interface | `dist/case/case-sdk.d.ts:78-81` | Supporting types | A single DNF rule. |
|
|
281
|
+
| `CaseRuleGrid` | type | `dist/case/case-sdk.d.ts:113-114` | Supporting types | One rule, one AND-group, or a complete OR-of-AND condition grid. |
|
|
282
|
+
| `CaseRuleInput` | type | `dist/case/case-sdk.d.ts:111-112` | Supporting types | A concrete rule or a pure expression gate resolved by its receiving slot. |
|
|
283
|
+
| `CaseRuleType` | type | `dist/case/case-sdk.d.ts:27` | Supporting types | |
|
|
284
|
+
| `CaseTriggerKind` | type | `dist/case/case-sdk.d.ts:195` | Supporting types | |
|
|
285
|
+
| `CaseVarDecl` | interface | `dist/case/case-sdk.d.ts:557-571` | Supporting types | 6 field(s) |
|
|
286
|
+
| `ConnectorDescriptor` | type | `dist/core/connectors.d.ts:89-97` | Supporting types | A generated, typed connector descriptor: ConnectorMeta branded with phantom input/output types. |
|
|
287
|
+
| `ConnectorMeta` | interface | `dist/core/connectors.d.ts:60-88` | Supporting types | Runtime metadata a generated descriptor carries. |
|
|
288
|
+
| `ConnectorOpts` | interface | `dist/core/actions.d.ts:177-217` | Option shapes | 4 field(s) |
|
|
289
|
+
| `ConnectorSpecData` | type | `dist/case/case-sdk.d.ts:376-388` | Supporting types | An Integration Service connector task — the connector variant of the shared `ActionSpec`. |
|
|
290
|
+
| `EntryOpts` | interface | `dist/case/case-sdk.d.ts:649-661` | Option shapes | Options common to a stage/task entry condition. |
|
|
291
|
+
| `escalation` | function | `dist/case/case-sdk.d.ts:143-149` | Case authoring | Declare an escalation. |
|
|
292
|
+
| `EscalationOpts` | interface | `dist/case/case-sdk.d.ts:127-139` | Option shapes | 4 field(s) |
|
|
293
|
+
| `EscalationRecipient` | interface | `dist/case/case-sdk.d.ts:119-126` | Supporting types | Who an escalation notifies. |
|
|
294
|
+
| `EscalationTrigger` | type | `dist/case/case-sdk.d.ts:117-118` | Supporting types | When an escalation fires: as the deadline approaches (`at-risk`) or once it passes (`sla-breached`). |
|
|
295
|
+
| `EventFilter` | type | `dist/core/actions.d.ts:3076-3117` | Supporting types | One filter condition on the event payload. |
|
|
296
|
+
| `EventSubscription` | interface | `dist/core/actions.d.ts:3163-3201` | Option shapes | What a connector event subscribes to. |
|
|
297
|
+
| `eventTrigger` | function | `dist/case/case-sdk.d.ts:276-286` | Case authoring | An Integration Service **event** trigger — an external event (a new row, an email, a webhook) starts the case. |
|
|
298
|
+
| `eventTrigger` | function | `dist/case/case-sdk.d.ts:287-293` | Case authoring | An Integration Service event trigger in placeholder or stringly-resolved form. |
|
|
299
|
+
| `EventTriggerOpts` | interface | `dist/case/case-sdk.d.ts:239-263` | Option shapes | 4 field(s) |
|
|
300
|
+
| `ExitOpts` | interface | `dist/case/case-sdk.d.ts:662-698` | Option shapes | Options for `stage.exitWhen(rules, opts)` — one call per outcome. |
|
|
301
|
+
| `ExternalExecutionMode` | type | `dist/case/case-sdk.d.ts:389-390` | Supporting types | Whether an external Integration Service task blocks for its result or waits for a callback. |
|
|
302
|
+
| `ExternalTaskOptions` | interface | `dist/case/case-sdk.d.ts:391-401` | Option shapes | Required wiring and typed inputs for an external agent/workflow invocation. |
|
|
303
|
+
| `ExternalTaskSpecData` | interface | `dist/case/case-sdk.d.ts:402-408` | Supporting types | Normalized descriptor and execution mode stored on a built external task. |
|
|
304
|
+
| `jsonSchema` | function | `dist/case/case-sdk.d.ts:541-556` | Case authoring | Declare a structured (object/array) variable type. |
|
|
305
|
+
| `JsonSchemaType` | interface | `dist/case/case-sdk.d.ts:532-540` | Supporting types | A structured (object/array) variable type + its JSON-schema `body`, as returned by jsonSchema. |
|
|
306
|
+
| `LookupSpec` | interface | `dist/core/lookups.d.ts:11-36` | Supporting types | One lookup field's retrieval contract, generated from `reference`. |
|
|
307
|
+
| `LookupStrategy` | type | `dist/core/lookups.d.ts:1-10` | Supporting types | How `prepare` should retrieve the collection, chosen from the metadata. |
|
|
308
|
+
| `LookupToken` | interface | `dist/core/lookups.d.ts:37-52` | Supporting types | An unresolved lookup: what `.byEmail(…)` returns. |
|
|
309
|
+
| `manualTrigger` | function | `dist/case/case-sdk.d.ts:225-231` | Case authoring | A manual (user-initiated) case trigger. |
|
|
310
|
+
| `ManualTriggerOpts` | interface | `dist/case/case-sdk.d.ts:208-211` | Option shapes | 2 field(s) |
|
|
311
|
+
| `RecipientType` | type | `dist/case/case-sdk.d.ts:413-419` | Supporting types | Action-task recipient type. |
|
|
312
|
+
| `ResolvedEventTriggerOpts` | interface | `dist/case/case-sdk.d.ts:264-275` | Option shapes | Options for the typed `eventTrigger(Descriptor, options)` form. |
|
|
313
|
+
| `rule` | function | `dist/case/case-sdk.d.ts:82-91` | Case authoring | Declare a condition rule. |
|
|
314
|
+
| `RuleOpts` | interface | `dist/case/case-sdk.d.ts:28-77` | Option shapes | 6 field(s) |
|
|
315
|
+
| `SelectNextStageSpec` | interface | `dist/case/case-sdk.d.ts:300-318` | Supporting types | Data Fabric entity used by the Case runtime to deliver a person's next-stage selection. |
|
|
316
|
+
| `SlaOpts` | interface | `dist/case/case-sdk.d.ts:166-185` | Option shapes | 5 field(s) |
|
|
317
|
+
| `SlaUnit` | type | `dist/case/case-sdk.d.ts:115-116` | Supporting types | SLA deadline unit. |
|
|
318
|
+
| `StageBuilder` | class | `dist/case/case-sdk.d.ts:960-1031` | Builders | 6 member(s) |
|
|
319
|
+
| `StageExitType` | type | `dist/case/case-sdk.d.ts:299` | Supporting types | |
|
|
320
|
+
| `TaskBuilder` | class | `dist/case/case-sdk.d.ts:699-959` | Builders | 23 member(s) |
|
|
321
|
+
| `TaskInputBinding` | interface | `dist/case/case-sdk.d.ts:481-488` | Supporting types | A task input binding: a resource input parameter set to a literal or a `=`-expression. |
|
|
322
|
+
| `TaskKind` | type | `dist/case/case-sdk.d.ts:357` | Supporting types | |
|
|
323
|
+
| `TaskOutputBinding` | interface | `dist/case/case-sdk.d.ts:489-499` | Supporting types | A task output extraction: bind a field of the task's result (`source`) into a case variable (`var`) that later… |
|
|
324
|
+
| `TaskRef` | interface | `dist/case/case-sdk.d.ts:409-412` | Supporting types | 2 field(s) |
|
|
325
|
+
| `TimerSpecData` | type | `dist/case/case-sdk.d.ts:467-480` | Supporting types | Exactly one product-supported timer value. |
|
|
326
|
+
| `timerTrigger` | function | `dist/case/case-sdk.d.ts:232-238` | Case authoring | A timer (scheduled) case trigger. |
|
|
327
|
+
| `TimerTriggerOpts` | interface | `dist/case/case-sdk.d.ts:212-224` | Option shapes | 3 field(s) |
|
|
328
|
+
| `toGroup` | function | `dist/case/case-sdk.d.ts:158-165` | Case authoring | An escalation recipient that is a user group. |
|
|
329
|
+
| `toUser` | function | `dist/case/case-sdk.d.ts:150-157` | Case authoring | An escalation recipient that is a single user. |
|
|
330
|
+
| `TriggerDescriptor` | type | `dist/core/connectors.d.ts:130-138` | Supporting types | A generated, typed connector-trigger descriptor: TriggerMeta branded with phantom `where`/output types. |
|
|
331
|
+
| `TriggerMeta` | interface | `dist/core/connectors.d.ts:120-129` | Supporting types | Runtime metadata a generated trigger descriptor carries. |
|
|
332
|
+
| `TriggerOptions` | interface | `dist/core/actions.d.ts:3118-3162` | Option shapes | The typed `onEvent`/`waitForEvent` options — everything an EventSubscription carries except `connector`/`event`, which… |
|
|
333
|
+
| `TypeDesc` | type | `dist/core/expr.d.ts:323` | Supporting types | |
|
|
334
|
+
| `UnresolvedReferenceTaskKind` | type | `dist/case/case-sdk.d.ts:358-359` | Supporting types | Published-resource task kinds that the Case schema permits as unresolved skeletons. |
|
|
335
|
+
| `WaitConnectorPlaceholderSpec` | interface | `dist/case/case-sdk.d.ts:360-370` | Supporting types | A `wait-for-connector` subscription: suspend on an Integration Service event. |
|
|
336
|
+
| `WaitConnectorSpec` | type | `dist/case/case-sdk.d.ts:371-375` | Supporting types | A placeholder connector/operation pair, or a library-resolved event subscription using the same symbolic shape as Flow… |
|
|
337
|
+
| `when` | function | `dist/case/case-sdk.d.ts:104-110` | Case authoring | Gate a condition slot only on case data without naming its default event. |
|
|
338
|
+
| `WhenExpression` | interface | `dist/case/case-sdk.d.ts:92-103` | Supporting types | A pure expression gate. |
|
|
333
339
|
|
|
334
340
|
## `@uipath/maestro-builder-sdk/bpmn`
|
|
335
341
|
|
|
@@ -337,64 +343,64 @@ that is the thing to check first.
|
|
|
337
343
|
|
|
338
344
|
| Symbol | Kind | Declaration | Area | Summary |
|
|
339
345
|
| --- | --- | --- | --- | --- |
|
|
340
|
-
| `ActivityNodeFields` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
341
|
-
| `ActivityNodeOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
342
|
-
| `ActivityOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
343
|
-
| `BindingDecl` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
344
|
-
| `BindingOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
345
|
-
| `BindingsRegistry` | class | `dist/bpmn/bpmn-sdk.d.ts
|
|
346
|
-
| `BoundaryOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
347
|
-
| `bpmn` | function | `dist/bpmn/bpmn-sdk.d.ts
|
|
348
|
-
| `BpmnBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts
|
|
349
|
-
| `BpmnConnectorOpts` | type | `dist/bpmn/bpmn-sdk.d.ts
|
|
350
|
-
| `BpmnFlow` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
351
|
-
| `BpmnNode` | type | `dist/bpmn/bpmn-sdk.d.ts
|
|
352
|
-
| `BpmnVarDecl` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
353
|
-
| `BuiltBpmn` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
354
|
-
| `CatchOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
355
|
-
| `ConnectorDescriptor` | type | `dist/core/connectors.d.ts
|
|
356
|
-
| `ConnectorEventOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
357
|
-
| `ConnectorMeta` | interface | `dist/core/connectors.d.ts
|
|
358
|
-
| `ConnectorOpts` | interface | `dist/core/actions.d.ts
|
|
359
|
-
| `DefinitionsRegistry` | class | `dist/bpmn/bpmn-sdk.d.ts
|
|
360
|
-
| `EndOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
361
|
-
| `ErrorDecl` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
362
|
-
| `ErrorLike` | type | `dist/bpmn/bpmn-sdk.d.ts
|
|
363
|
-
| `ErrorMappingRow` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
364
|
-
| `errorSchema` | const | `dist/bpmn/bpmn-sdk.d.ts
|
|
365
|
-
| `errorSchemaWithResponse` | const | `dist/bpmn/bpmn-sdk.d.ts
|
|
366
|
-
| `EventDef` | type | `dist/bpmn/bpmn-sdk.d.ts
|
|
367
|
-
| `EventKind` | type | `dist/bpmn/bpmn-sdk.d.ts
|
|
368
|
-
| `ExtensionPayload` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
369
|
-
| `ExternalTaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
370
|
-
| `FlowOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
371
|
-
| `GatewayKind` | type | `dist/bpmn/bpmn-sdk.d.ts
|
|
372
|
-
| `GatewayOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
373
|
-
| `HttpOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
374
|
-
| `HumanTaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
375
|
-
| `LookupSpec` | interface | `dist/core/lookups.d.ts
|
|
376
|
-
| `LookupStrategy` | type | `dist/core/lookups.d.ts
|
|
377
|
-
| `LoopSpec` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
378
|
-
| `MessageDecl` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
379
|
-
| `OrchestratorAsyncOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
380
|
-
| `OrchestratorOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
381
|
-
| `PlainTaskElement` | type | `dist/bpmn/bpmn-sdk.d.ts
|
|
382
|
-
| `PlainTaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
383
|
-
| `ProcessMetadata` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
384
|
-
| `QueueItemOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
385
|
-
| `ReceiveMessageOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
386
|
-
| `RetrySpec` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
387
|
-
| `ScopeBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts
|
|
388
|
-
| `ScriptTaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
389
|
-
| `StartOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
390
|
-
| `SubProcessBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts
|
|
391
|
-
| `SubProcessOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
392
|
-
| `TaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
393
|
-
| `ThrowOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
394
|
-
| `TimerLike` | type | `dist/bpmn/bpmn-sdk.d.ts
|
|
395
|
-
| `TimerSpec` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
396
|
-
| `TypedContextRow` | interface | `dist/bpmn/typed-node.d.ts
|
|
397
|
-
| `TypeDesc` | type | `dist/core/expr.d.ts`
|
|
398
|
-
| `TypedOutputRow` | interface | `dist/bpmn/typed-node.d.ts
|
|
399
|
-
| `VarDirection` | type | `dist/bpmn/bpmn-sdk.d.ts
|
|
400
|
-
| `VarOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts
|
|
346
|
+
| `ActivityNodeFields` | interface | `dist/bpmn/bpmn-sdk.d.ts:301-316` | Supporting types | The fields every activity arm of BpmnNode carries — the built form of ActivityOpts. |
|
|
347
|
+
| `ActivityNodeOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1140-1206` | Option shapes | Options for `.activity()` — the generic registry-backed node. |
|
|
348
|
+
| `ActivityOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:700-733` | Option shapes | What every ACTIVITY accepts, on top of its own options — a script task, a variable task, a connector task, a… |
|
|
349
|
+
| `BindingDecl` | interface | `dist/bpmn/bpmn-sdk.d.ts:354-377` | Supporting types | A declared external identifier the process needs supplied at deploy time — a connection id, a folder key, a process… |
|
|
350
|
+
| `BindingOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:834-862` | Option shapes | Options for `.binding()`. |
|
|
351
|
+
| `BindingsRegistry` | class | `dist/bpmn/bpmn-sdk.d.ts:1256-1280` | Supporting types | Collects `uipath:binding` declarations, de-duped by id. |
|
|
352
|
+
| `BoundaryOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:625-649` | Option shapes | Options for `.boundaryEvent()`: the activity it attaches to, whether it interrupts that activity, and the event… |
|
|
353
|
+
| `bpmn` | function | `dist/bpmn/bpmn-sdk.d.ts:2238-2257` | BPMN authoring | Start building a BPMN process with the given id. |
|
|
354
|
+
| `BpmnBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:2037-2162` | Builders | The top-level process builder `bpmn()` returns — every graph method of the shared scope (events, gateways, tasks,… |
|
|
355
|
+
| `BpmnConnectorOpts` | type | `dist/bpmn/bpmn-sdk.d.ts:1955-1979` | Option shapes | `.connector()` options: the shared connector options, plus the BPMN-only display `name` and output-variable override. |
|
|
356
|
+
| `BpmnFlow` | interface | `dist/bpmn/bpmn-sdk.d.ts:317-329` | Supporting types | One sequence flow in the built graph — the edge from `source` to `target` (`bpmn:sequenceFlow`). |
|
|
357
|
+
| `BpmnNode` | type | `dist/bpmn/bpmn-sdk.d.ts:85-251` | Supporting types | One node in the built graph — a discriminated union with one arm per BPMN element kind, which the serializer walks into… |
|
|
358
|
+
| `BpmnVarDecl` | interface | `dist/bpmn/bpmn-sdk.d.ts:335-353` | Supporting types | A declared variable in the built graph (`uipath:input` / `uipath:inputOutput` / `uipath:output`, by `direction`). |
|
|
359
|
+
| `BuiltBpmn` | interface | `dist/bpmn/bpmn-sdk.d.ts:394-419` | Supporting types | The built in-memory process graph `.build()` returns — the IR `serialize()` walks into `.bpmn` XML. |
|
|
360
|
+
| `CatchOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:602-615` | Option shapes | Options for `.intermediateCatchEvent()`. |
|
|
361
|
+
| `ConnectorDescriptor` | type | `dist/core/connectors.d.ts:89-97` | Supporting types | A generated, typed connector descriptor: ConnectorMeta branded with phantom input/output types. |
|
|
362
|
+
| `ConnectorEventOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1076-1120` | Option shapes | Shared options for the two connector-event methods. |
|
|
363
|
+
| `ConnectorMeta` | interface | `dist/core/connectors.d.ts:60-88` | Supporting types | Runtime metadata a generated descriptor carries. |
|
|
364
|
+
| `ConnectorOpts` | interface | `dist/core/actions.d.ts:177-217` | Option shapes | 4 field(s) |
|
|
365
|
+
| `DefinitionsRegistry` | class | `dist/bpmn/bpmn-sdk.d.ts:1281-1304` | Supporting types | Collects definitions-level message/error declarations, de-duped by name. |
|
|
366
|
+
| `EndOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:577-601` | Option shapes | Options for `.endEvent()`. |
|
|
367
|
+
| `ErrorDecl` | interface | `dist/bpmn/bpmn-sdk.d.ts:385-393` | Supporting types | A definitions-level `bpmn:error` declaration, referenced by error events. |
|
|
368
|
+
| `ErrorLike` | type | `dist/bpmn/bpmn-sdk.d.ts:39-50` | Supporting types | What an author passes for an error definition. |
|
|
369
|
+
| `ErrorMappingRow` | interface | `dist/bpmn/bpmn-sdk.d.ts:252-300` | Supporting types | One row of `uipath:errorMapping` — how an activity classifies one kind of failure. |
|
|
370
|
+
| `errorSchema` | const | `dist/bpmn/bpmn-sdk.d.ts:2163-2204` | BPMN authoring | The `Error` variable's shape — the platform's own error envelope. |
|
|
371
|
+
| `errorSchemaWithResponse` | const | `dist/bpmn/bpmn-sdk.d.ts:2205-2237` | BPMN authoring | The same envelope plus `response` — what a node whose failure carries a payload writes, and what the same source calls… |
|
|
372
|
+
| `EventDef` | type | `dist/bpmn/bpmn-sdk.d.ts:51-69` | Supporting types | The resolved event definition attached to an event node. |
|
|
373
|
+
| `EventKind` | type | `dist/bpmn/bpmn-sdk.d.ts:72-73` | Supporting types | The four non-boundary event element kinds a BpmnNode can be. |
|
|
374
|
+
| `ExtensionPayload` | interface | `dist/bpmn/bpmn-sdk.d.ts:459-495` | Supporting types | An extension payload carried by an element the payload does not describe. |
|
|
375
|
+
| `ExternalTaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1121-1139` | Option shapes | Options for `.externalAgent()` / `.externalWorkflow()`. |
|
|
376
|
+
| `FlowOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1222-1230` | Option shapes | Options for `.sequenceFlow()`. |
|
|
377
|
+
| `GatewayKind` | type | `dist/bpmn/bpmn-sdk.d.ts:70-71` | Supporting types | The four gateway element kinds a BpmnNode can be. |
|
|
378
|
+
| `GatewayOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:650-656` | Option shapes | Options for `.exclusiveGateway()` / `.inclusiveGateway()`. |
|
|
379
|
+
| `HttpOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:863-900` | Option shapes | Options for `.http()` — an `Intsvc.UnifiedHttpRequest` node. |
|
|
380
|
+
| `HumanTaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:985-1031` | Option shapes | Options for `.humanTask()` — an `Actions.HITL` action-app task. |
|
|
381
|
+
| `LookupSpec` | interface | `dist/core/lookups.d.ts:11-36` | Supporting types | One lookup field's retrieval contract, generated from `reference`. |
|
|
382
|
+
| `LookupStrategy` | type | `dist/core/lookups.d.ts:1-10` | Supporting types | How `prepare` should retrieve the collection, chosen from the metadata. |
|
|
383
|
+
| `LoopSpec` | interface | `dist/bpmn/bpmn-sdk.d.ts:74-84` | Supporting types | Multi-instance loop over a collection (`uipath:loopCharacteristics`). |
|
|
384
|
+
| `MessageDecl` | interface | `dist/bpmn/bpmn-sdk.d.ts:378-384` | Supporting types | A definitions-level `bpmn:message` declaration, referenced by message events. |
|
|
385
|
+
| `OrchestratorAsyncOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:938-945` | Option shapes | Options for the two agentic/case call activities, which come in sync and async forms. |
|
|
386
|
+
| `OrchestratorOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:901-937` | Option shapes | What every Orchestrator invocation needs: which process, in which folder, with what input. |
|
|
387
|
+
| `PlainTaskElement` | type | `dist/bpmn/bpmn-sdk.d.ts:1207-1214` | Supporting types | The BPMN task elements that are legal with NO `uipath:*` payload. |
|
|
388
|
+
| `PlainTaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1215-1221` | Option shapes | Options for `.plainTask()`. |
|
|
389
|
+
| `ProcessMetadata` | interface | `dist/bpmn/bpmn-sdk.d.ts:420-458` | Supporting types | Process-level metadata — the `uipath:*` children of the process's own `extensionElements` that describe the DOCUMENT… |
|
|
390
|
+
| `QueueItemOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:946-984` | Option shapes | Options for `.queueItem()`. |
|
|
391
|
+
| `ReceiveMessageOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1032-1075` | Option shapes | Options for `.receiveMessage()` — `Maestro.ReceiveMessageEvent`. |
|
|
392
|
+
| `RetrySpec` | interface | `dist/bpmn/bpmn-sdk.d.ts:657-699` | Supporting types | Retry an activity that fails (`uipath:retry`). |
|
|
393
|
+
| `ScopeBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:1305-1954` | Builders | The set of node/flow/variable methods common to the process root and every sub-process. |
|
|
394
|
+
| `ScriptTaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:734-803` | Option shapes | Options for `.scriptTask()` — the Jint JavaScript body and its input/output mappings. |
|
|
395
|
+
| `StartOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:496-576` | Option shapes | Options for `.startEvent()`. |
|
|
396
|
+
| `SubProcessBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:2032-2036` | Builders | A sub-process body: the same graph methods, plus an internal node builder. |
|
|
397
|
+
| `SubProcessOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:819-833` | Option shapes | Options for `.subProcess()`. |
|
|
398
|
+
| `TaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:804-818` | Option shapes | Options for `.task()` — a display name and the variable assignments the task makes. |
|
|
399
|
+
| `ThrowOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:616-624` | Option shapes | Options for `.intermediateThrowEvent()` — a `message` to throw, or none. |
|
|
400
|
+
| `TimerLike` | type | `dist/bpmn/bpmn-sdk.d.ts:37-38` | Supporting types | A timer as an ISO-8601 duration string (shorthand for `{ duration }`) or a full spec. |
|
|
401
|
+
| `TimerSpec` | interface | `dist/bpmn/bpmn-sdk.d.ts:28-36` | Supporting types | ISO-8601 timer specification (one of duration / date / cycle). |
|
|
402
|
+
| `TypedContextRow` | interface | `dist/bpmn/typed-node.d.ts:141-172` | Supporting types | One `uipath:context` input row, spelled out. |
|
|
403
|
+
| `TypeDesc` | type | `dist/core/expr.d.ts:323` | Supporting types | |
|
|
404
|
+
| `TypedOutputRow` | interface | `dist/bpmn/typed-node.d.ts:173-197` | Supporting types | 8 field(s) |
|
|
405
|
+
| `VarDirection` | type | `dist/bpmn/bpmn-sdk.d.ts:330-334` | Supporting types | How a variable is exposed: `'input'` (read-only entry input), `'output'` (a return value), or `'inputOutput'` (a mutable… |
|
|
406
|
+
| `VarOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1231-1255` | Option shapes | Options for `.var()` / `.input()` / `.output()`. |
|