@culvii/cli 0.0.7 → 0.0.8
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/COMMANDS.md +5 -5
- package/README.md +15 -6
- package/USAGE.md +11 -10
- package/dist/DeployView-D4UEXMDJ.js +2 -0
- package/dist/DevView-GPKSSOLA.js +2 -0
- package/dist/EnvView-3ZURMIZS.js +2 -0
- package/dist/{HelpView-YLCEPIFY.js → HelpView-E7HS4SVF.js} +1 -1
- package/dist/WhoamiView-TKSYSHQ2.js +2 -0
- package/dist/{WorkspaceView-RNFALIPM.js → WorkspaceView-ID7ZMBHV.js} +1 -1
- package/dist/{chunk-IRZMWFC3.js → chunk-IPETC2TK.js} +1 -1
- package/dist/index.js +33 -683
- package/dist/lib/evaluator.js +2 -2
- package/dist/login-OGOHEHFE.js +39 -0
- package/dist/{logout-TDZA462P.js → logout-BRUJBFUK.js} +1 -1
- package/dist/skill-bundle-7KYK5GBL.js +1377 -0
- package/package.json +9 -5
- package/skills/culvii/.culvii-skill.json +59 -0
- package/skills/culvii/SKILL.md +73 -0
- package/skills/culvii/agents/openai.yaml +4 -0
- package/skills/culvii/examples/agent-workflow.culvii.ts +24 -0
- package/skills/culvii/examples/complete-workflow.culvii.ts +37 -0
- package/skills/culvii/examples/output-surface.culvii.ts +45 -0
- package/skills/culvii/examples/wait-surface.culvii.ts +24 -0
- package/skills/culvii/references/agents.md +29 -0
- package/skills/culvii/references/authoring-files.md +21 -0
- package/skills/culvii/references/cli-guide.md +22 -0
- package/skills/culvii/references/cli-reference.md +184 -0
- package/skills/culvii/references/feedback-cycle.md +43 -0
- package/skills/culvii/references/integrations.md +13 -0
- package/skills/culvii/references/kit-api.md +35 -0
- package/skills/culvii/references/node-core-agent.md +27 -0
- package/skills/culvii/references/node-core-browser-automation.md +53 -0
- package/skills/culvii/references/node-core-code.md +28 -0
- package/skills/culvii/references/node-core-http.md +42 -0
- package/skills/culvii/references/node-core-if.md +26 -0
- package/skills/culvii/references/node-core-jwt.md +31 -0
- package/skills/culvii/references/node-core-set.md +24 -0
- package/skills/culvii/references/node-cron-trigger.md +25 -0
- package/skills/culvii/references/node-elasticsearch.md +39 -0
- package/skills/culvii/references/node-gmail-trigger.md +44 -0
- package/skills/culvii/references/node-gmail.md +57 -0
- package/skills/culvii/references/node-google-calendar.md +51 -0
- package/skills/culvii/references/node-google-docs.md +46 -0
- package/skills/culvii/references/node-manual-trigger.md +24 -0
- package/skills/culvii/references/node-microsoft-outlook-trigger.md +41 -0
- package/skills/culvii/references/node-microsoft-outlook.md +55 -0
- package/skills/culvii/references/node-microsoft-sharepoint.md +40 -0
- package/skills/culvii/references/node-s3.md +40 -0
- package/skills/culvii/references/node-slack-trigger.md +40 -0
- package/skills/culvii/references/node-slack.md +38 -0
- package/skills/culvii/references/node-twilio.md +39 -0
- package/skills/culvii/references/node-wait-timer.md +24 -0
- package/skills/culvii/references/node-webhook-trigger.md +24 -0
- package/skills/culvii/references/nodes-index.md +27 -0
- package/skills/culvii/references/runtime-values.md +36 -0
- package/skills/culvii/references/surface-authoring.md +27 -0
- package/skills/culvii/references/surface-display.md +390 -0
- package/skills/culvii/references/surface-feedback.md +41 -0
- package/skills/culvii/references/surface-input-actions.md +143 -0
- package/skills/culvii/references/surface-layout.md +97 -0
- package/skills/culvii/references/validation.md +18 -0
- package/skills/culvii/references/workflows.md +30 -0
- package/dist/DeployView-GEJNL26A.js +0 -2
- package/dist/DevView-SOPAMSZ4.js +0 -2
- package/dist/EnvView-MCZC2NBO.js +0 -2
- package/dist/WhoamiView-67HV2L5J.js +0 -2
- package/dist/chunk-MPKGJC7N.js +0 -2
- package/dist/login-G5QUR55L.js +0 -36
- /package/dist/{chunk-5NBKYMD7.js → chunk-56C3DFV2.js} +0 -0
- /package/dist/{chunk-JFIFRAAR.js → chunk-RS5GDTRN.js} +0 -0
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# Kit API
|
|
2
|
+
|
|
3
|
+
Generated from the public `@culvii/kit` source exports. Import authoring APIs only from `@culvii/kit`.
|
|
4
|
+
|
|
5
|
+
## Key signatures
|
|
6
|
+
|
|
7
|
+
- `new MultiAgentEngine(primaryConfig: PrimaryAgentConfig)`
|
|
8
|
+
- `createAgentModelConfigFromRef(modelRef, credentialId, options?)`
|
|
9
|
+
- `defineWorkflowTool({ name, description, workflowId, triggerNodeName?, inputSchema? })`
|
|
10
|
+
- `new Workflow({ id, name, active?, steps? })`
|
|
11
|
+
- `new Step({ id?, name, type, params?, credentials?, disabled?, onError?, ui? })`
|
|
12
|
+
- `step.connectTo(nextStep, { fromPort?, fromOutputIndex?, toInputIndex? })`
|
|
13
|
+
- `new Surface({ id, name, description?, slot, definition })`
|
|
14
|
+
|
|
15
|
+
## Agents
|
|
16
|
+
|
|
17
|
+
`AgentBaseConfig`, `AgentMetadata`, `AgentModel`, `AgentModelConfig`, `AgentModelConfigOptions`, `AgentModelRef`, `AgentPermissions`, `AgentRole`, `AgentRuntimeDetails`, `BUILTIN_AGENT_PERMISSIONS`, `BuiltInModelProvider`, `BuiltinAgentPermission`, `BuiltinAgentToolName`, `MultiAgentEngine`, `Permission`, `PrimaryAgentConfig`, `SecondaryAgentConfig`, `Tool`, `WorkflowToolConfig`, `assertValidAgentPermissions`, `createAgentModelConfigFromRef`, `defineWorkflowTool`, `parseAgentModelRef`, `validateAgentPermissions`
|
|
18
|
+
|
|
19
|
+
## Development registry
|
|
20
|
+
|
|
21
|
+
`DevRegistry`
|
|
22
|
+
|
|
23
|
+
## Shared types
|
|
24
|
+
|
|
25
|
+
`CulviiConfig`, `CulviiRuntime`, `DIDDocument`, `Guard`, `HealthReport`, `HookContext`, `IdentityConfig`, `IdentityRef`, `MaybePromise`, `MemoryConfig`, `MemoryType`, `Message`, `ObserveConfig`, `Permission`, `Plan`, `Policy`, `RetryConfig`, `SandboxConfig`, `Schema`, `Skill`, `StepTrace`, `Tool`, `ToolCallEvent`, `ToolResultEvent`, `Usage`
|
|
26
|
+
|
|
27
|
+
## Surfaces
|
|
28
|
+
|
|
29
|
+
`BinaryDescriptor`, `DefaultSurfaceSelection`, `ExecutionUiBinaryNodeValues`, `ExecutionUiDataModel`, `ExecutionUiNodeValues`, `ExecutionUiSurfaceEntry`, `ExecutionUiSurfaceMap`, `NodeSurfaceSlot`, `RuntimeSurface`, `RuntimeSurfaceAction`, `RuntimeSurfaceComponent`, `SerializedNodeUiConfig`, `SerializedSurface`, `SerializedSurfaceSelection`, `Surface`, `SurfaceAction`, `SurfaceBinding`, `SurfaceComponent`, `SurfaceConfig`, `SurfaceFormField`, `SurfaceReference`, `UISurfaceDefinition`, `UIValue`, `isSurface`
|
|
30
|
+
|
|
31
|
+
## Workflows and steps
|
|
32
|
+
|
|
33
|
+
`ConnectStepOptions`, `CredentialedNodeType`, `NodeExpression`, `NodeParams`, `NodeParamsBase`, `NodeType`, `NodeTypeInput`, `NodeTypeParamsMap`, `NodeUiConfig`, `RegisteredNodeType`, `Resolvable`, `SerializedWorkflow`, `SerializedWorkflowStep`, `Step`, `StepCredentials`, `StepSurfaceSelection`, `Workflow`, `WorkflowConfig`, `WorkflowRuntimeConnection`, `WorkflowRuntimeConnections`, `WorkflowRuntimeNode`, `WorkflowRuntimeShape`, `WorkflowStepConfig`, `WorkflowStepConnection`
|
|
34
|
+
|
|
35
|
+
Further reading: [Workflow API](https://culvii.com/docs/sdk-reference/api-reference/workflow-api/), [Multi-Agent API](https://culvii.com/docs/sdk-reference/api-reference/multi-agent-api/), and [Authentication](https://culvii.com/docs/sdk-reference/guides/authentication/).
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# core.agent
|
|
2
|
+
|
|
3
|
+
- Type ID: `core.agent`
|
|
4
|
+
- Kind: `action`
|
|
5
|
+
- Credentials: not required
|
|
6
|
+
- Feedback mock: not required
|
|
7
|
+
|
|
8
|
+
## Props
|
|
9
|
+
|
|
10
|
+
- `agentReferenceKey`: string; required
|
|
11
|
+
- `prompt`: string; required
|
|
12
|
+
- `autoCloseSession`: boolean; optional
|
|
13
|
+
- `outputFormat`: json; optional
|
|
14
|
+
- `pauseAfterExecution`: boolean; optional
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ts
|
|
19
|
+
new Step({
|
|
20
|
+
id: 'core-agent',
|
|
21
|
+
name: 'core.agent',
|
|
22
|
+
type: 'core.agent',
|
|
23
|
+
params: { /* use the required props and conditional values above */ },
|
|
24
|
+
});
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Further reading: [Culvii core.agent node](https://culvii.com/docs/nodes/core/agent/).
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# core.browserAutomation
|
|
2
|
+
|
|
3
|
+
- Type ID: `core.browserAutomation`
|
|
4
|
+
- Kind: `action`
|
|
5
|
+
- Credentials: not required
|
|
6
|
+
- Feedback mock: required
|
|
7
|
+
|
|
8
|
+
## Props
|
|
9
|
+
|
|
10
|
+
- `url`: string; required
|
|
11
|
+
- `timeoutMs`: number; optional
|
|
12
|
+
- `includeHtml`: boolean; optional
|
|
13
|
+
- `auth`: object; required
|
|
14
|
+
- `type`: options; required
|
|
15
|
+
- Values: `none`, `form`
|
|
16
|
+
- `loginUrl`: string; optional; when type=form
|
|
17
|
+
- `usernameSelector`: string; optional; when type=form
|
|
18
|
+
- `passwordSelector`: string; optional; when type=form
|
|
19
|
+
- `submitSelector`: string; optional; when type=form
|
|
20
|
+
- `otpSelector`: string; optional; when type=form
|
|
21
|
+
- `otpSubmitSelector`: string; optional; when type=form
|
|
22
|
+
- `useTotp`: boolean; optional; when type=form
|
|
23
|
+
- `steps`: array; optional
|
|
24
|
+
- `step`: object; optional
|
|
25
|
+
- `type`: options; optional
|
|
26
|
+
- Values: `goto`, `fill`, `click`, `waitForSelector`, `waitForTimeout`, `extract`
|
|
27
|
+
- `url`: string; optional; when type=goto
|
|
28
|
+
- `waitUntil`: options; optional; when type=goto
|
|
29
|
+
- Values: `load`, `domcontentloaded`, `networkidle`
|
|
30
|
+
- `selector`: string; optional; when type=fill|click|waitForSelector
|
|
31
|
+
- `value`: string; optional; when type=fill
|
|
32
|
+
- `timeoutMs`: number; optional; when type=waitForSelector|waitForTimeout
|
|
33
|
+
- `selectors`: array; optional; when type=extract
|
|
34
|
+
- `selectorRule`: object; optional
|
|
35
|
+
- `key`: string; optional
|
|
36
|
+
- `selector`: string; optional
|
|
37
|
+
- `type`: options; optional
|
|
38
|
+
- Values: `text`, `texts`, `attr`, `attrs`
|
|
39
|
+
- `attrName`: string; optional; when type=attr|attrs
|
|
40
|
+
- `pauseAfterExecution`: boolean; optional
|
|
41
|
+
|
|
42
|
+
## Example
|
|
43
|
+
|
|
44
|
+
```ts
|
|
45
|
+
new Step({
|
|
46
|
+
id: 'core-browser-automation',
|
|
47
|
+
name: 'core.browserAutomation',
|
|
48
|
+
type: 'core.browserAutomation',
|
|
49
|
+
params: { /* use the required props and conditional values above */ },
|
|
50
|
+
});
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Further reading: [Culvii core.browserAutomation node](https://culvii.com/docs/nodes/core/browser-automation/).
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# core.code
|
|
2
|
+
|
|
3
|
+
- Type ID: `core.code`
|
|
4
|
+
- Kind: `action`
|
|
5
|
+
- Credentials: not required
|
|
6
|
+
- Feedback mock: not required
|
|
7
|
+
|
|
8
|
+
## Props
|
|
9
|
+
|
|
10
|
+
- `code`: string; required
|
|
11
|
+
- `codeType`: options; optional
|
|
12
|
+
- Values: `js`, `py`
|
|
13
|
+
- `codeParams`: object; optional
|
|
14
|
+
- `globalParams`: object; optional
|
|
15
|
+
- `pauseAfterExecution`: boolean; optional
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```ts
|
|
20
|
+
new Step({
|
|
21
|
+
id: 'core-code',
|
|
22
|
+
name: 'core.code',
|
|
23
|
+
type: 'core.code',
|
|
24
|
+
params: { /* use the required props and conditional values above */ },
|
|
25
|
+
});
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Further reading: [Culvii core.code node](https://culvii.com/docs/nodes/core/code/).
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# core.http
|
|
2
|
+
|
|
3
|
+
- Type ID: `core.http`
|
|
4
|
+
- Kind: `action`
|
|
5
|
+
- Credentials: not required
|
|
6
|
+
- Feedback mock: required
|
|
7
|
+
|
|
8
|
+
## Props
|
|
9
|
+
|
|
10
|
+
- `method`: options; required
|
|
11
|
+
- Values: `GET`, `POST`, `PUT`, `PATCH`, `DELETE`, `HEAD`, `OPTIONS`
|
|
12
|
+
- `url`: string; required
|
|
13
|
+
- `authentication`: options; optional
|
|
14
|
+
- Values: `none`, `bearerToken`, `basicAuth`
|
|
15
|
+
- `bearerToken`: string; optional; when authentication=bearerToken
|
|
16
|
+
- `username`: string; optional; when authentication=basicAuth
|
|
17
|
+
- `password`: string; optional; when authentication=basicAuth
|
|
18
|
+
- `queryParameters`: object; optional
|
|
19
|
+
- `headers`: object; optional
|
|
20
|
+
- `bodyContentType`: options; optional
|
|
21
|
+
- Values: `json`, `form`, `form-urlencoded`, `raw`
|
|
22
|
+
- `body`: string; optional
|
|
23
|
+
- `responseFormat`: options; optional
|
|
24
|
+
- Values: `json`, `text`, `autodetect`
|
|
25
|
+
- `options`: object; optional
|
|
26
|
+
- `timeout`: number; optional
|
|
27
|
+
- `followRedirects`: boolean; optional
|
|
28
|
+
- `ignoreSSL`: boolean; optional
|
|
29
|
+
- `pauseAfterExecution`: boolean; optional
|
|
30
|
+
|
|
31
|
+
## Example
|
|
32
|
+
|
|
33
|
+
```ts
|
|
34
|
+
new Step({
|
|
35
|
+
id: 'core-http',
|
|
36
|
+
name: 'core.http',
|
|
37
|
+
type: 'core.http',
|
|
38
|
+
params: { /* use the required props and conditional values above */ },
|
|
39
|
+
});
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Further reading: [Culvii core.http node](https://culvii.com/docs/nodes/core/http/).
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# core.if
|
|
2
|
+
|
|
3
|
+
- Type ID: `core.if`
|
|
4
|
+
- Kind: `action`
|
|
5
|
+
- Credentials: not required
|
|
6
|
+
- Feedback mock: not required
|
|
7
|
+
|
|
8
|
+
## Props
|
|
9
|
+
|
|
10
|
+
- `conditions`: array; required
|
|
11
|
+
- `combineOperation`: options; required
|
|
12
|
+
- Values: `all`, `any`
|
|
13
|
+
- `pauseAfterExecution`: boolean; optional
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
new Step({
|
|
19
|
+
id: 'core-if',
|
|
20
|
+
name: 'core.if',
|
|
21
|
+
type: 'core.if',
|
|
22
|
+
params: { /* use the required props and conditional values above */ },
|
|
23
|
+
});
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Further reading: [Culvii core.if node](https://culvii.com/docs/nodes/core/if/).
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# core.jwt
|
|
2
|
+
|
|
3
|
+
- Type ID: `core.jwt`
|
|
4
|
+
- Kind: `action`
|
|
5
|
+
- Credentials: not required
|
|
6
|
+
- Feedback mock: not required
|
|
7
|
+
|
|
8
|
+
## Props
|
|
9
|
+
|
|
10
|
+
- `operation`: options; required
|
|
11
|
+
- Values: `sign`, `verify`
|
|
12
|
+
- `payload`: object; optional; when operation=sign
|
|
13
|
+
- `token`: string; optional; when operation=verify
|
|
14
|
+
- `secret`: string; required
|
|
15
|
+
- `expiresIn`: string; optional; when operation=sign
|
|
16
|
+
- `issuer`: string; optional
|
|
17
|
+
- `audience`: string; optional
|
|
18
|
+
- `pauseAfterExecution`: boolean; optional
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ts
|
|
23
|
+
new Step({
|
|
24
|
+
id: 'core-jwt',
|
|
25
|
+
name: 'core.jwt',
|
|
26
|
+
type: 'core.jwt',
|
|
27
|
+
params: { /* use the required props and conditional values above */ },
|
|
28
|
+
});
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Further reading: [Culvii core.jwt node](https://culvii.com/docs/nodes/core/jwt/).
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# core.set
|
|
2
|
+
|
|
3
|
+
- Type ID: `core.set`
|
|
4
|
+
- Kind: `action`
|
|
5
|
+
- Credentials: not required
|
|
6
|
+
- Feedback mock: not required
|
|
7
|
+
|
|
8
|
+
## Props
|
|
9
|
+
|
|
10
|
+
- `values`: object; required
|
|
11
|
+
- `pauseAfterExecution`: boolean; optional
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
new Step({
|
|
17
|
+
id: 'core-set',
|
|
18
|
+
name: 'core.set',
|
|
19
|
+
type: 'core.set',
|
|
20
|
+
params: { /* use the required props and conditional values above */ },
|
|
21
|
+
});
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Further reading: [Culvii core.set node](https://culvii.com/docs/nodes/core/set/).
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# cronTrigger
|
|
2
|
+
|
|
3
|
+
- Type ID: `cronTrigger`
|
|
4
|
+
- Kind: `trigger`
|
|
5
|
+
- Credentials: not required
|
|
6
|
+
- Feedback mock: not required
|
|
7
|
+
|
|
8
|
+
## Props
|
|
9
|
+
|
|
10
|
+
- `cronExpression`: string; optional
|
|
11
|
+
- `pollIntervalMs`: number; optional
|
|
12
|
+
- `pauseAfterExecution`: boolean; optional
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
new Step({
|
|
18
|
+
id: 'cron-trigger',
|
|
19
|
+
name: 'cronTrigger',
|
|
20
|
+
type: 'cronTrigger',
|
|
21
|
+
params: { /* use the required props and conditional values above */ },
|
|
22
|
+
});
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Further reading: [Culvii cronTrigger node](https://culvii.com/docs/nodes/triggers/cron-trigger/).
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# elasticsearch
|
|
2
|
+
|
|
3
|
+
- Type ID: `elasticsearch`
|
|
4
|
+
- Kind: `action`
|
|
5
|
+
- Credentials: required as `credentials: { name, id }`
|
|
6
|
+
- Feedback mock: required
|
|
7
|
+
|
|
8
|
+
Resolve the credential through [integration selection](integrations.md); never ask the user to copy a credential ID.
|
|
9
|
+
|
|
10
|
+
## Props
|
|
11
|
+
|
|
12
|
+
- `resource`: options; required
|
|
13
|
+
- Values: `document`
|
|
14
|
+
- `operation`: options; required; when resource=document
|
|
15
|
+
- Values: `search`, `updateDocument`
|
|
16
|
+
- `index`: string; required; when resource=document, operation=search
|
|
17
|
+
- `query`: json; required; when resource=document, operation=search
|
|
18
|
+
- `size`: number; optional; when resource=document, operation=search
|
|
19
|
+
- `sort`: json; optional; when resource=document, operation=search
|
|
20
|
+
- `retryOnEmptyHits`: boolean; optional; when resource=document, operation=search
|
|
21
|
+
- `retryDelaysSec`: array; optional; when resource=document, operation=search, retryOnEmptyHits=true
|
|
22
|
+
- `index`: string; required; when resource=document, operation=updateDocument
|
|
23
|
+
- `id`: string; required; when resource=document, operation=updateDocument
|
|
24
|
+
- `fields`: json; required; when resource=document, operation=updateDocument
|
|
25
|
+
- `pauseAfterExecution`: boolean; optional
|
|
26
|
+
|
|
27
|
+
## Example
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
new Step({
|
|
31
|
+
id: 'elasticsearch',
|
|
32
|
+
name: 'elasticsearch',
|
|
33
|
+
type: 'elasticsearch',
|
|
34
|
+
credentials: { name: 'Stored credential', id: 'credential-id' },
|
|
35
|
+
params: { /* use the required props and conditional values above */ },
|
|
36
|
+
});
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Further reading: [Culvii elasticsearch node](https://culvii.com/docs/nodes/elasticsearch/).
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# gmailTrigger
|
|
2
|
+
|
|
3
|
+
- Type ID: `gmailTrigger`
|
|
4
|
+
- Kind: `trigger`
|
|
5
|
+
- Credentials: required as `credentials: { name, id }`
|
|
6
|
+
- Feedback mock: required
|
|
7
|
+
|
|
8
|
+
Resolve the credential through [integration selection](integrations.md); never ask the user to copy a credential ID.
|
|
9
|
+
|
|
10
|
+
## Props
|
|
11
|
+
|
|
12
|
+
- `pollIntervalMs`: number; required
|
|
13
|
+
- `event`: options; required
|
|
14
|
+
- Values: `messageReceived`
|
|
15
|
+
- `output`: options; optional
|
|
16
|
+
- Values: `simple`, `raw`, `fields`
|
|
17
|
+
- `fields`: checkbox; required; when output=fields
|
|
18
|
+
- Values: `id`, `threadId`, `labelIds`, `snippet`, `historyId`, `internalDate`, `payload`, `sizeEstimate`, `raw`, `classificationLabelValues`
|
|
19
|
+
- `includeAttachments`: boolean; optional
|
|
20
|
+
- `filters`: object; optional
|
|
21
|
+
- `readStatus`: options; optional
|
|
22
|
+
- Values: `both`, `unread`, `read`
|
|
23
|
+
- `sender`: string; optional
|
|
24
|
+
- `subjectContains`: string; optional
|
|
25
|
+
- `hasAttachment`: boolean; optional
|
|
26
|
+
- `label`: string; optional
|
|
27
|
+
- `options`: object; optional
|
|
28
|
+
- `markAsRead`: boolean; optional
|
|
29
|
+
- `maxEmails`: number; optional
|
|
30
|
+
- `pauseAfterExecution`: boolean; optional
|
|
31
|
+
|
|
32
|
+
## Example
|
|
33
|
+
|
|
34
|
+
```ts
|
|
35
|
+
new Step({
|
|
36
|
+
id: 'gmail-trigger',
|
|
37
|
+
name: 'gmailTrigger',
|
|
38
|
+
type: 'gmailTrigger',
|
|
39
|
+
credentials: { name: 'Stored credential', id: 'credential-id' },
|
|
40
|
+
params: { /* use the required props and conditional values above */ },
|
|
41
|
+
});
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Further reading: [Culvii gmailTrigger node](https://culvii.com/docs/nodes/triggers/gmail-trigger/).
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# gmail
|
|
2
|
+
|
|
3
|
+
- Type ID: `gmail`
|
|
4
|
+
- Kind: `action`
|
|
5
|
+
- Credentials: required as `credentials: { name, id }`
|
|
6
|
+
- Feedback mock: required
|
|
7
|
+
|
|
8
|
+
Resolve the credential through [integration selection](integrations.md); never ask the user to copy a credential ID.
|
|
9
|
+
|
|
10
|
+
## Props
|
|
11
|
+
|
|
12
|
+
- `resource`: options; optional
|
|
13
|
+
- Values: `message`
|
|
14
|
+
- `operation`: options; optional; when resource=message
|
|
15
|
+
- Values: `send`, `readAll`
|
|
16
|
+
- `toRecipients`: string; required; when resource=message, operation=send
|
|
17
|
+
- `subject`: string; optional; when resource=message, operation=send
|
|
18
|
+
- `bodyContent`: string; optional; when resource=message, operation=send
|
|
19
|
+
- `additionalFields`: object; optional; when resource=message, operation=send
|
|
20
|
+
- `bccRecipients`: string; optional
|
|
21
|
+
- `ccRecipients`: string; optional
|
|
22
|
+
- `bodyContentType`: options; optional
|
|
23
|
+
- Values: `html`, `text`
|
|
24
|
+
- `replyTo`: string; optional
|
|
25
|
+
- `output`: options; optional; when resource=message, operation=readAll
|
|
26
|
+
- Values: `simple`, `raw`, `fields`
|
|
27
|
+
- `limit`: number; required; when resource=message, operation=readAll
|
|
28
|
+
- `includeAttachments`: boolean; optional; when resource=message, operation=readAll
|
|
29
|
+
- `fields`: checkbox; required; when output=fields, resource=message, operation=readAll
|
|
30
|
+
- Values: `id`, `threadId`, `labelIds`, `snippet`, `historyId`, `internalDate`, `payload`, `sizeEstimate`, `raw`, `classificationLabelValues`
|
|
31
|
+
- `userFilters`: object; optional; when resource=message, operation=readAll
|
|
32
|
+
- `filterBy`: options; optional
|
|
33
|
+
- Values: `filters`, `search`
|
|
34
|
+
- `search`: string; optional; when filterBy=search
|
|
35
|
+
- `filters`: object; optional; when filterBy=filters
|
|
36
|
+
- `readStatus`: options; optional
|
|
37
|
+
- Values: `both`, `unread`, `read`
|
|
38
|
+
- `receivedAfter`: dateTime; optional
|
|
39
|
+
- `receivedBefore`: dateTime; optional
|
|
40
|
+
- `sender`: string; optional
|
|
41
|
+
- `hasAttachment`: boolean; optional
|
|
42
|
+
- `label`: string; optional
|
|
43
|
+
- `pauseAfterExecution`: boolean; optional
|
|
44
|
+
|
|
45
|
+
## Example
|
|
46
|
+
|
|
47
|
+
```ts
|
|
48
|
+
new Step({
|
|
49
|
+
id: 'gmail',
|
|
50
|
+
name: 'gmail',
|
|
51
|
+
type: 'gmail',
|
|
52
|
+
credentials: { name: 'Stored credential', id: 'credential-id' },
|
|
53
|
+
params: { /* use the required props and conditional values above */ },
|
|
54
|
+
});
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Further reading: [Culvii gmail node](https://culvii.com/docs/nodes/gmail/).
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# googleCalendar
|
|
2
|
+
|
|
3
|
+
- Type ID: `googleCalendar`
|
|
4
|
+
- Kind: `action`
|
|
5
|
+
- Credentials: required as `credentials: { name, id }`
|
|
6
|
+
- Feedback mock: required
|
|
7
|
+
|
|
8
|
+
Resolve the credential through [integration selection](integrations.md); never ask the user to copy a credential ID.
|
|
9
|
+
|
|
10
|
+
## Props
|
|
11
|
+
|
|
12
|
+
- `resource`: options; optional
|
|
13
|
+
- Values: `event`
|
|
14
|
+
- `operation`: options; optional; when resource=event
|
|
15
|
+
- Values: `create`, `readAll`
|
|
16
|
+
- `calendarId`: string; required; when resource=event, operation=create
|
|
17
|
+
- `summary`: string; optional; when resource=event, operation=create
|
|
18
|
+
- `start`: dateTime; required; when resource=event, operation=create
|
|
19
|
+
- `end`: dateTime; required; when resource=event, operation=create
|
|
20
|
+
- `additionalFields`: object; optional; when resource=event, operation=create
|
|
21
|
+
- `description`: string; optional
|
|
22
|
+
- `location`: string; optional
|
|
23
|
+
- `timeZone`: string; optional
|
|
24
|
+
- `calendarId`: string; required; when resource=event, operation=readAll
|
|
25
|
+
- `output`: options; optional; when resource=event, operation=readAll
|
|
26
|
+
- Values: `simple`, `raw`, `fields`
|
|
27
|
+
- `limit`: number; required; when resource=event, operation=readAll
|
|
28
|
+
- `fields`: checkbox; required; when output=fields, resource=event, operation=readAll
|
|
29
|
+
- Values: `id`, `status`, `summary`, `description`, `location`, `htmlLink`, `updated`, `start`, `end`
|
|
30
|
+
- `userFilters`: object; optional; when resource=event, operation=readAll
|
|
31
|
+
- `query`: string; optional
|
|
32
|
+
- `timeMin`: dateTime; optional
|
|
33
|
+
- `timeMax`: dateTime; optional
|
|
34
|
+
- `singleEvents`: boolean; optional
|
|
35
|
+
- `showDeleted`: boolean; optional
|
|
36
|
+
- `timeZone`: string; optional
|
|
37
|
+
- `pauseAfterExecution`: boolean; optional
|
|
38
|
+
|
|
39
|
+
## Example
|
|
40
|
+
|
|
41
|
+
```ts
|
|
42
|
+
new Step({
|
|
43
|
+
id: 'google-calendar',
|
|
44
|
+
name: 'googleCalendar',
|
|
45
|
+
type: 'googleCalendar',
|
|
46
|
+
credentials: { name: 'Stored credential', id: 'credential-id' },
|
|
47
|
+
params: { /* use the required props and conditional values above */ },
|
|
48
|
+
});
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Further reading: [Culvii googleCalendar node](https://culvii.com/docs/nodes/google-calendar/).
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# googleDocs
|
|
2
|
+
|
|
3
|
+
- Type ID: `googleDocs`
|
|
4
|
+
- Kind: `action`
|
|
5
|
+
- Credentials: required as `credentials: { name, id }`
|
|
6
|
+
- Feedback mock: required
|
|
7
|
+
|
|
8
|
+
Resolve the credential through [integration selection](integrations.md); never ask the user to copy a credential ID.
|
|
9
|
+
|
|
10
|
+
## Props
|
|
11
|
+
|
|
12
|
+
- `resource`: options; optional
|
|
13
|
+
- Values: `document`
|
|
14
|
+
- `operation`: options; optional; when resource=document
|
|
15
|
+
- Values: `create`, `get`, `replaceText`, `appendText`
|
|
16
|
+
- `title`: string; required; when resource=document, operation=create
|
|
17
|
+
- `documentId`: string; required; when resource=document, operation=get
|
|
18
|
+
- `includeTabsContent`: boolean; optional; when resource=document, operation=get
|
|
19
|
+
- `fields`: string; optional; when resource=document, operation=get
|
|
20
|
+
- `documentId`: string; required; when resource=document, operation=replaceText
|
|
21
|
+
- `searchText`: string; required; when resource=document, operation=replaceText
|
|
22
|
+
- `replacementText`: string; optional; when resource=document, operation=replaceText
|
|
23
|
+
- `additionalFields`: object; optional; when resource=document, operation=replaceText
|
|
24
|
+
- `matchCase`: boolean; optional
|
|
25
|
+
- `requiredRevisionId`: string; optional
|
|
26
|
+
- `targetRevisionId`: string; optional
|
|
27
|
+
- `documentId`: string; required; when resource=document, operation=appendText
|
|
28
|
+
- `text`: string; required; when resource=document, operation=appendText
|
|
29
|
+
- `additionalFields`: object; optional; when resource=document, operation=appendText
|
|
30
|
+
- `requiredRevisionId`: string; optional
|
|
31
|
+
- `targetRevisionId`: string; optional
|
|
32
|
+
- `pauseAfterExecution`: boolean; optional
|
|
33
|
+
|
|
34
|
+
## Example
|
|
35
|
+
|
|
36
|
+
```ts
|
|
37
|
+
new Step({
|
|
38
|
+
id: 'google-docs',
|
|
39
|
+
name: 'googleDocs',
|
|
40
|
+
type: 'googleDocs',
|
|
41
|
+
credentials: { name: 'Stored credential', id: 'credential-id' },
|
|
42
|
+
params: { /* use the required props and conditional values above */ },
|
|
43
|
+
});
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Further reading: [Culvii googleDocs node](https://culvii.com/docs/nodes/google-docs/).
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# manualTrigger
|
|
2
|
+
|
|
3
|
+
- Type ID: `manualTrigger`
|
|
4
|
+
- Kind: `trigger`
|
|
5
|
+
- Credentials: not required
|
|
6
|
+
- Feedback mock: not required
|
|
7
|
+
|
|
8
|
+
## Props
|
|
9
|
+
|
|
10
|
+
- `payloadSchema`: array; optional
|
|
11
|
+
- `pauseAfterExecution`: boolean; optional
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
new Step({
|
|
17
|
+
id: 'manual-trigger',
|
|
18
|
+
name: 'manualTrigger',
|
|
19
|
+
type: 'manualTrigger',
|
|
20
|
+
params: { /* use the required props and conditional values above */ },
|
|
21
|
+
});
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Further reading: [Culvii manualTrigger node](https://culvii.com/docs/nodes/triggers/manual-trigger/).
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# microsoftOutlookTrigger
|
|
2
|
+
|
|
3
|
+
- Type ID: `microsoftOutlookTrigger`
|
|
4
|
+
- Kind: `trigger`
|
|
5
|
+
- Credentials: required as `credentials: { name, id }`
|
|
6
|
+
- Feedback mock: required
|
|
7
|
+
|
|
8
|
+
Resolve the credential through [integration selection](integrations.md); never ask the user to copy a credential ID.
|
|
9
|
+
|
|
10
|
+
## Props
|
|
11
|
+
|
|
12
|
+
- `pollIntervalMs`: number; required
|
|
13
|
+
- `event`: options; required
|
|
14
|
+
- Values: `messageReceived`
|
|
15
|
+
- `output`: options; optional
|
|
16
|
+
- Values: `simple`, `raw`, `fields`
|
|
17
|
+
- `fields`: checkbox; required; when output=fields
|
|
18
|
+
- Values: `bccRecipients`, `body`, `bodyPreview`, `categories`, `ccRecipients`, `changeKey`, `conversationId`, `createdDateTime`, `flag`, `from`, `hasAttachments`, `importance`, `inferenceClassification`, `internetMessageId`, `isDeliveryReceiptRequested`, `isDraft`, `isRead`, `isReadReceiptRequested`, `lastModifiedDateTime`, `parentFolderId`, `receivedDateTime`, `replyTo`, `sender`, `sentDateTime`, `subject`, `toRecipients`, `webLink`
|
|
19
|
+
- `filters`: object; optional
|
|
20
|
+
- `onlyUnread`: boolean; optional
|
|
21
|
+
- `sender`: string; optional
|
|
22
|
+
- `subjectContains`: string; optional
|
|
23
|
+
- `folder`: string; optional
|
|
24
|
+
- `options`: object; optional
|
|
25
|
+
- `markAsRead`: boolean; optional
|
|
26
|
+
- `maxEmails`: number; optional
|
|
27
|
+
- `pauseAfterExecution`: boolean; optional
|
|
28
|
+
|
|
29
|
+
## Example
|
|
30
|
+
|
|
31
|
+
```ts
|
|
32
|
+
new Step({
|
|
33
|
+
id: 'microsoft-outlook-trigger',
|
|
34
|
+
name: 'microsoftOutlookTrigger',
|
|
35
|
+
type: 'microsoftOutlookTrigger',
|
|
36
|
+
credentials: { name: 'Stored credential', id: 'credential-id' },
|
|
37
|
+
params: { /* use the required props and conditional values above */ },
|
|
38
|
+
});
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Further reading: [Culvii microsoftOutlookTrigger node](https://culvii.com/docs/nodes/triggers/microsoft-outlook-trigger/).
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# microsoftOutlook
|
|
2
|
+
|
|
3
|
+
- Type ID: `microsoftOutlook`
|
|
4
|
+
- Kind: `action`
|
|
5
|
+
- Credentials: required as `credentials: { name, id }`
|
|
6
|
+
- Feedback mock: required
|
|
7
|
+
|
|
8
|
+
Resolve the credential through [integration selection](integrations.md); never ask the user to copy a credential ID.
|
|
9
|
+
|
|
10
|
+
## Props
|
|
11
|
+
|
|
12
|
+
- `resource`: options; optional
|
|
13
|
+
- Values: `message`
|
|
14
|
+
- `operation`: options; optional; when resource=message
|
|
15
|
+
- Values: `send`, `readAll`
|
|
16
|
+
- `toRecipients`: string; required; when resource=message, operation=send
|
|
17
|
+
- `subject`: string; optional; when resource=message, operation=send
|
|
18
|
+
- `bodyContent`: string; optional; when resource=message, operation=send
|
|
19
|
+
- `additionalFields`: object; optional; when resource=message, operation=send
|
|
20
|
+
- `bccRecipients`: string; optional
|
|
21
|
+
- `ccRecipients`: string; optional
|
|
22
|
+
- `bodyContentType`: options; optional
|
|
23
|
+
- Values: `html`, `Text`
|
|
24
|
+
- `replyTo`: string; optional
|
|
25
|
+
- `saveToSentItems`: boolean; optional
|
|
26
|
+
- `output`: options; optional; when resource=message, operation=readAll
|
|
27
|
+
- Values: `simple`, `raw`, `fields`
|
|
28
|
+
- `limit`: number; required; when resource=message, operation=readAll
|
|
29
|
+
- `fields`: checkbox; required; when output=fields, resource=message, operation=readAll
|
|
30
|
+
- Values: `bccRecipients`, `body`, `bodyPreview`, `categories`, `ccRecipients`, `changeKey`, `conversationId`, `createdDateTime`, `flag`, `from`, `hasAttachments`, `importance`, `inferenceClassification`, `internetMessageId`, `isDeliveryReceiptRequested`, `isDraft`, `isRead`, `isReadReceiptRequested`, `lastModifiedDateTime`, `parentFolderId`, `receivedDateTime`, `replyTo`, `sender`, `sentDateTime`, `subject`, `toRecipients`, `webLink`
|
|
31
|
+
- `userFilters`: object; optional; when resource=message, operation=readAll
|
|
32
|
+
- `filterBy`: options; optional
|
|
33
|
+
- Values: `filters`, `search`
|
|
34
|
+
- `search`: string; optional; when filterBy=search
|
|
35
|
+
- `filters`: object; optional; when filterBy=filters
|
|
36
|
+
- `readStatus`: options; optional
|
|
37
|
+
- Values: `both`, `unread`, `read`
|
|
38
|
+
- `receivedAfter`: dateTime; optional
|
|
39
|
+
- `receivedBefore`: dateTime; optional
|
|
40
|
+
- `sender`: string; optional
|
|
41
|
+
- `pauseAfterExecution`: boolean; optional
|
|
42
|
+
|
|
43
|
+
## Example
|
|
44
|
+
|
|
45
|
+
```ts
|
|
46
|
+
new Step({
|
|
47
|
+
id: 'microsoft-outlook',
|
|
48
|
+
name: 'microsoftOutlook',
|
|
49
|
+
type: 'microsoftOutlook',
|
|
50
|
+
credentials: { name: 'Stored credential', id: 'credential-id' },
|
|
51
|
+
params: { /* use the required props and conditional values above */ },
|
|
52
|
+
});
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Further reading: [Culvii microsoftOutlook node](https://culvii.com/docs/nodes/microsoft-outlook/).
|