@roarkanalytics/cli 0.1.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/LICENSE +201 -0
- package/README.md +225 -0
- package/bin.d.ts +2 -0
- package/bin.js +14 -0
- package/commands.d.ts +5 -0
- package/commands.js +3553 -0
- package/completions.d.ts +1 -0
- package/completions.js +13 -0
- package/index.d.ts +6 -0
- package/index.js +26 -0
- package/man/roark-agent-create.1 +99 -0
- package/man/roark-agent-endpoint-create.1 +108 -0
- package/man/roark-agent-endpoint-get.1 +93 -0
- package/man/roark-agent-endpoint-list.1 +102 -0
- package/man/roark-agent-endpoint-update.1 +103 -0
- package/man/roark-agent-get.1 +93 -0
- package/man/roark-agent-list.1 +99 -0
- package/man/roark-agent-update.1 +100 -0
- package/man/roark-call-create.1 +150 -0
- package/man/roark-call-get.1 +93 -0
- package/man/roark-call-list.1 +111 -0
- package/man/roark-call-metric-list.1 +100 -0
- package/man/roark-call-sentiment-run-list.1 +93 -0
- package/man/roark-call-transcript-get.1 +97 -0
- package/man/roark-config-apply.1 +96 -0
- package/man/roark-config-diff.1 +96 -0
- package/man/roark-customer-flow-create.1 +97 -0
- package/man/roark-customer-flow-delete.1 +93 -0
- package/man/roark-customer-flow-edge-case-create.1 +112 -0
- package/man/roark-customer-flow-edge-case-delete.1 +96 -0
- package/man/roark-customer-flow-edge-case-promote.1 +96 -0
- package/man/roark-customer-flow-edge-case-update.1 +118 -0
- package/man/roark-customer-flow-get.1 +93 -0
- package/man/roark-customer-flow-graph-replace.1 +100 -0
- package/man/roark-customer-flow-happy-path-update.1 +115 -0
- package/man/roark-customer-flow-list.1 +105 -0
- package/man/roark-customer-flow-update.1 +109 -0
- package/man/roark-health.1 +89 -0
- package/man/roark-http-request-definition-create.1 +108 -0
- package/man/roark-http-request-definition-get.1 +93 -0
- package/man/roark-http-request-definition-list.1 +96 -0
- package/man/roark-http-request-definition-update.1 +109 -0
- package/man/roark-metric-collection-job-create.1 +99 -0
- package/man/roark-metric-collection-job-get.1 +93 -0
- package/man/roark-metric-collection-job-list.1 +99 -0
- package/man/roark-metric-definition-create.1 +100 -0
- package/man/roark-metric-definition-list.1 +89 -0
- package/man/roark-metric-policy-create.1 +105 -0
- package/man/roark-metric-policy-delete.1 +93 -0
- package/man/roark-metric-policy-get.1 +93 -0
- package/man/roark-metric-policy-list.1 +99 -0
- package/man/roark-metric-policy-update.1 +106 -0
- package/man/roark-simulation-environment-get.1 +93 -0
- package/man/roark-simulation-environment-list.1 +96 -0
- package/man/roark-simulation-job-get.1 +93 -0
- package/man/roark-simulation-job-lookup.1 +96 -0
- package/man/roark-simulation-persona-create.1 +156 -0
- package/man/roark-simulation-persona-get.1 +93 -0
- package/man/roark-simulation-persona-list.1 +99 -0
- package/man/roark-simulation-persona-update.1 +160 -0
- package/man/roark-simulation-plan-create.1 +138 -0
- package/man/roark-simulation-plan-delete.1 +93 -0
- package/man/roark-simulation-plan-get.1 +93 -0
- package/man/roark-simulation-plan-job-get.1 +93 -0
- package/man/roark-simulation-plan-job-list.1 +108 -0
- package/man/roark-simulation-plan-job-start.1 +97 -0
- package/man/roark-simulation-plan-list.1 +102 -0
- package/man/roark-simulation-plan-update.1 +142 -0
- package/man/roark-simulation-run.1 +97 -0
- package/man/roark-webhook-create.1 +102 -0
- package/man/roark-webhook-delete.1 +93 -0
- package/man/roark-webhook-get.1 +93 -0
- package/man/roark-webhook-list.1 +96 -0
- package/man/roark.1 +287 -0
- package/package.json +102 -0
- package/runtime/commands/api.d.ts +26 -0
- package/runtime/commands/api.js +85 -0
- package/runtime/commands/auth.d.ts +9 -0
- package/runtime/commands/auth.js +111 -0
- package/runtime/commands/completion.d.ts +9 -0
- package/runtime/commands/completion.js +42 -0
- package/runtime/commands/config.d.ts +15 -0
- package/runtime/commands/config.js +125 -0
- package/runtime/config.d.ts +65 -0
- package/runtime/config.js +163 -0
- package/runtime/confirm.d.ts +16 -0
- package/runtime/confirm.js +34 -0
- package/runtime/errors.d.ts +45 -0
- package/runtime/errors.js +91 -0
- package/runtime/input.d.ts +52 -0
- package/runtime/input.js +211 -0
- package/runtime/output.d.ts +41 -0
- package/runtime/output.js +90 -0
- package/runtime/program.d.ts +45 -0
- package/runtime/program.js +305 -0
- package/runtime/types.d.ts +53 -0
- package/runtime/types.js +10 -0
- package/version.d.ts +1 -0
- package/version.js +8 -0
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CUSTOMER\-FLOW\-CREATE" "1" "" "roark-customer-flow-create" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-customer\-flow\-create \- Create a customer flow
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark customer\-flow create
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Creates a customer flow. A SCRIPTED flow carries a step graph and gets one way of running it per path through the graph; an IMPROV flow carries the briefs you send. Customer flows replace the older simulation scenarios, so build a flow for anything new.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/customer\-flow
|
|
12
|
+
.SH "REQUEST BODY"
|
|
13
|
+
This endpoint accepts one of several request shapes, so the body is supplied as JSON through \e\-\e\-data or on standard input rather than as individual flags.
|
|
14
|
+
.TP
|
|
15
|
+
\fBCreateScriptedCustomerFlowInput\fR
|
|
16
|
+
Requires type, title, graph.
|
|
17
|
+
.TP
|
|
18
|
+
\fBCreateImprovCustomerFlowInput\fR
|
|
19
|
+
Requires type, title, agentIds, happyPath.
|
|
20
|
+
.SH "GLOBAL OPTIONS"
|
|
21
|
+
.TP
|
|
22
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
23
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
24
|
+
.TP
|
|
25
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
26
|
+
Skip confirmation prompts.
|
|
27
|
+
.TP
|
|
28
|
+
\fB\-\-no\-input\fR
|
|
29
|
+
Never prompt; fail instead.
|
|
30
|
+
.TP
|
|
31
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
32
|
+
API base URL.
|
|
33
|
+
.TP
|
|
34
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
35
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
36
|
+
.TP
|
|
37
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
38
|
+
Request timeout in milliseconds.
|
|
39
|
+
.TP
|
|
40
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
41
|
+
Retries for retryable failures.
|
|
42
|
+
.TP
|
|
43
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
44
|
+
Output format: auto, json, jsonl, plain.
|
|
45
|
+
.TP
|
|
46
|
+
\fB\-\-json\fR
|
|
47
|
+
Shorthand for \-\-format json.
|
|
48
|
+
.TP
|
|
49
|
+
\fB\-\-no\-color\fR
|
|
50
|
+
Disable colour.
|
|
51
|
+
.TP
|
|
52
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
53
|
+
Suppress non\-essential output.
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
56
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
57
|
+
.SH "EXAMPLES"
|
|
58
|
+
.PP
|
|
59
|
+
.RS 4
|
|
60
|
+
.nf
|
|
61
|
+
roark customer\-flow create \-\-data '{ ... }'
|
|
62
|
+
.fi
|
|
63
|
+
.RE
|
|
64
|
+
.SH "ENVIRONMENT"
|
|
65
|
+
.TP
|
|
66
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
67
|
+
Bearer token used when \-\-token is not given.
|
|
68
|
+
.TP
|
|
69
|
+
\fBROARK_BASE_URL\fR
|
|
70
|
+
API base URL.
|
|
71
|
+
.TP
|
|
72
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
73
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
74
|
+
.TP
|
|
75
|
+
\fBNO_COLOR\fR
|
|
76
|
+
Disables colour when set to any value.
|
|
77
|
+
.SH "EXIT STATUS"
|
|
78
|
+
.TP
|
|
79
|
+
\fB0\fR
|
|
80
|
+
The command succeeded.
|
|
81
|
+
.TP
|
|
82
|
+
\fB1\fR
|
|
83
|
+
The API rejected the request.
|
|
84
|
+
.TP
|
|
85
|
+
\fB2\fR
|
|
86
|
+
The command line was wrong.
|
|
87
|
+
.TP
|
|
88
|
+
\fB3\fR
|
|
89
|
+
No credential, or the credential was refused.
|
|
90
|
+
.TP
|
|
91
|
+
\fB4\fR
|
|
92
|
+
The addressed resource does not exist.
|
|
93
|
+
.TP
|
|
94
|
+
\fB5\fR
|
|
95
|
+
The request never completed: connection, timeout, or abort.
|
|
96
|
+
.SH "SEE ALSO"
|
|
97
|
+
.BR roark (1)
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CUSTOMER\-FLOW\-DELETE" "1" "" "roark-customer-flow-delete" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-customer\-flow\-delete \- Delete a customer flow
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark customer\-flow delete
|
|
7
|
+
\fIflow\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Soft\-deletes a customer flow along with its edge cases, expectations and (for scripted flows) its step graph. Run plans that linked it drop it from their test cases.
|
|
10
|
+
.SH "API"
|
|
11
|
+
DELETE /v1/customer\-flow/{flowId}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIflow\-id\fR
|
|
15
|
+
The flow\-id.
|
|
16
|
+
.SH "GLOBAL OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
19
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
22
|
+
Skip confirmation prompts.
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-no\-input\fR
|
|
25
|
+
Never prompt; fail instead.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
28
|
+
API base URL.
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
31
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
34
|
+
Request timeout in milliseconds.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
37
|
+
Retries for retryable failures.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
40
|
+
Output format: auto, json, jsonl, plain.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-json\fR
|
|
43
|
+
Shorthand for \-\-format json.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-no\-color\fR
|
|
46
|
+
Disable colour.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
49
|
+
Suppress non\-essential output.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
52
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
53
|
+
.SH "EXAMPLES"
|
|
54
|
+
.PP
|
|
55
|
+
.RS 4
|
|
56
|
+
.nf
|
|
57
|
+
roark customer\-flow delete <flow\-id>
|
|
58
|
+
.fi
|
|
59
|
+
.RE
|
|
60
|
+
.SH "ENVIRONMENT"
|
|
61
|
+
.TP
|
|
62
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
63
|
+
Bearer token used when \-\-token is not given.
|
|
64
|
+
.TP
|
|
65
|
+
\fBROARK_BASE_URL\fR
|
|
66
|
+
API base URL.
|
|
67
|
+
.TP
|
|
68
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
69
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
70
|
+
.TP
|
|
71
|
+
\fBNO_COLOR\fR
|
|
72
|
+
Disables colour when set to any value.
|
|
73
|
+
.SH "EXIT STATUS"
|
|
74
|
+
.TP
|
|
75
|
+
\fB0\fR
|
|
76
|
+
The command succeeded.
|
|
77
|
+
.TP
|
|
78
|
+
\fB1\fR
|
|
79
|
+
The API rejected the request.
|
|
80
|
+
.TP
|
|
81
|
+
\fB2\fR
|
|
82
|
+
The command line was wrong.
|
|
83
|
+
.TP
|
|
84
|
+
\fB3\fR
|
|
85
|
+
No credential, or the credential was refused.
|
|
86
|
+
.TP
|
|
87
|
+
\fB4\fR
|
|
88
|
+
The addressed resource does not exist.
|
|
89
|
+
.TP
|
|
90
|
+
\fB5\fR
|
|
91
|
+
The request never completed: connection, timeout, or abort.
|
|
92
|
+
.SH "SEE ALSO"
|
|
93
|
+
.BR roark (1)
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CUSTOMER\-FLOW\-EDGE\-CASE\-CREATE" "1" "" "roark-customer-flow-edge-case-create" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-customer\-flow\-edge\-case\-create \- Add an edge case
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark customer\-flow edge\-case create
|
|
7
|
+
\fIflow\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Adds a variant to an IMPROV flow. A scripted flow's variants are owned by the path engine, one per path through the graph, so they are created by editing the graph through PUT /v1/customer\-flow/{flowId}/graph rather than here. Leave personaOverrideId or environmentId unset to inherit the happy path's.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/customer\-flow/{flowId}/edge\-case
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIflow\-id\fR
|
|
15
|
+
The flow\-id.
|
|
16
|
+
.SH "OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-title\fR \fI<value>\fR
|
|
19
|
+
Required.
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-environment\-id\fR \fI<value>\fR
|
|
22
|
+
Optional.
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-prompt\fR \fI<value>\fR
|
|
25
|
+
Optional.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-preceded\-by\-customer\-flow\-id\fR \fI<value>\fR
|
|
28
|
+
Optional.
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-preceded\-by\-customer\-flow\-variant\-id\fR \fI<value>\fR
|
|
31
|
+
Optional.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-persona\-override\-id\fR \fI<value>\fR
|
|
34
|
+
The persona this runs as. Omit to inherit the happy path's. Optional.
|
|
35
|
+
.SH "GLOBAL OPTIONS"
|
|
36
|
+
.TP
|
|
37
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
38
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
39
|
+
.TP
|
|
40
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
41
|
+
Skip confirmation prompts.
|
|
42
|
+
.TP
|
|
43
|
+
\fB\-\-no\-input\fR
|
|
44
|
+
Never prompt; fail instead.
|
|
45
|
+
.TP
|
|
46
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
47
|
+
API base URL.
|
|
48
|
+
.TP
|
|
49
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
50
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
51
|
+
.TP
|
|
52
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
53
|
+
Request timeout in milliseconds.
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
56
|
+
Retries for retryable failures.
|
|
57
|
+
.TP
|
|
58
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
59
|
+
Output format: auto, json, jsonl, plain.
|
|
60
|
+
.TP
|
|
61
|
+
\fB\-\-json\fR
|
|
62
|
+
Shorthand for \-\-format json.
|
|
63
|
+
.TP
|
|
64
|
+
\fB\-\-no\-color\fR
|
|
65
|
+
Disable colour.
|
|
66
|
+
.TP
|
|
67
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
68
|
+
Suppress non\-essential output.
|
|
69
|
+
.TP
|
|
70
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
71
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
72
|
+
.SH "EXAMPLES"
|
|
73
|
+
.PP
|
|
74
|
+
.RS 4
|
|
75
|
+
.nf
|
|
76
|
+
roark customer\-flow edge\-case create <flow\-id> \-\-title <value>
|
|
77
|
+
.fi
|
|
78
|
+
.RE
|
|
79
|
+
.SH "ENVIRONMENT"
|
|
80
|
+
.TP
|
|
81
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
82
|
+
Bearer token used when \-\-token is not given.
|
|
83
|
+
.TP
|
|
84
|
+
\fBROARK_BASE_URL\fR
|
|
85
|
+
API base URL.
|
|
86
|
+
.TP
|
|
87
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
88
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
89
|
+
.TP
|
|
90
|
+
\fBNO_COLOR\fR
|
|
91
|
+
Disables colour when set to any value.
|
|
92
|
+
.SH "EXIT STATUS"
|
|
93
|
+
.TP
|
|
94
|
+
\fB0\fR
|
|
95
|
+
The command succeeded.
|
|
96
|
+
.TP
|
|
97
|
+
\fB1\fR
|
|
98
|
+
The API rejected the request.
|
|
99
|
+
.TP
|
|
100
|
+
\fB2\fR
|
|
101
|
+
The command line was wrong.
|
|
102
|
+
.TP
|
|
103
|
+
\fB3\fR
|
|
104
|
+
No credential, or the credential was refused.
|
|
105
|
+
.TP
|
|
106
|
+
\fB4\fR
|
|
107
|
+
The addressed resource does not exist.
|
|
108
|
+
.TP
|
|
109
|
+
\fB5\fR
|
|
110
|
+
The request never completed: connection, timeout, or abort.
|
|
111
|
+
.SH "SEE ALSO"
|
|
112
|
+
.BR roark (1)
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CUSTOMER\-FLOW\-EDGE\-CASE\-DELETE" "1" "" "roark-customer-flow-edge-case-delete" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-customer\-flow\-edge\-case\-delete \- Remove an edge case
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark customer\-flow edge\-case delete
|
|
7
|
+
\fIflow\-id\fR \fIedge\-case\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Soft\-deletes a variant. On a scripted flow the path engine re\-creates a variant for any path still in the graph, so remove the path through PUT /graph instead if that is what you meant.
|
|
10
|
+
.SH "API"
|
|
11
|
+
DELETE /v1/customer\-flow/{flowId}/edge\-case/{edgeCaseId}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIflow\-id\fR
|
|
15
|
+
The flow\-id.
|
|
16
|
+
.TP
|
|
17
|
+
\fIedge\-case\-id\fR
|
|
18
|
+
The edge\-case\-id.
|
|
19
|
+
.SH "GLOBAL OPTIONS"
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
22
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
25
|
+
Skip confirmation prompts.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-no\-input\fR
|
|
28
|
+
Never prompt; fail instead.
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
31
|
+
API base URL.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
34
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
37
|
+
Request timeout in milliseconds.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
40
|
+
Retries for retryable failures.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
43
|
+
Output format: auto, json, jsonl, plain.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-json\fR
|
|
46
|
+
Shorthand for \-\-format json.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-\-no\-color\fR
|
|
49
|
+
Disable colour.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
52
|
+
Suppress non\-essential output.
|
|
53
|
+
.TP
|
|
54
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
55
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
56
|
+
.SH "EXAMPLES"
|
|
57
|
+
.PP
|
|
58
|
+
.RS 4
|
|
59
|
+
.nf
|
|
60
|
+
roark customer\-flow edge\-case delete <flow\-id> <edge\-case\-id>
|
|
61
|
+
.fi
|
|
62
|
+
.RE
|
|
63
|
+
.SH "ENVIRONMENT"
|
|
64
|
+
.TP
|
|
65
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
66
|
+
Bearer token used when \-\-token is not given.
|
|
67
|
+
.TP
|
|
68
|
+
\fBROARK_BASE_URL\fR
|
|
69
|
+
API base URL.
|
|
70
|
+
.TP
|
|
71
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
72
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
73
|
+
.TP
|
|
74
|
+
\fBNO_COLOR\fR
|
|
75
|
+
Disables colour when set to any value.
|
|
76
|
+
.SH "EXIT STATUS"
|
|
77
|
+
.TP
|
|
78
|
+
\fB0\fR
|
|
79
|
+
The command succeeded.
|
|
80
|
+
.TP
|
|
81
|
+
\fB1\fR
|
|
82
|
+
The API rejected the request.
|
|
83
|
+
.TP
|
|
84
|
+
\fB2\fR
|
|
85
|
+
The command line was wrong.
|
|
86
|
+
.TP
|
|
87
|
+
\fB3\fR
|
|
88
|
+
No credential, or the credential was refused.
|
|
89
|
+
.TP
|
|
90
|
+
\fB4\fR
|
|
91
|
+
The addressed resource does not exist.
|
|
92
|
+
.TP
|
|
93
|
+
\fB5\fR
|
|
94
|
+
The request never completed: connection, timeout, or abort.
|
|
95
|
+
.SH "SEE ALSO"
|
|
96
|
+
.BR roark (1)
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CUSTOMER\-FLOW\-EDGE\-CASE\-PROMOTE" "1" "" "roark-customer-flow-edge-case-promote" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-customer\-flow\-edge\-case\-promote \- Promote an edge case to the happy path
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark customer\-flow edge\-case promote
|
|
7
|
+
\fIflow\-id\fR \fIedge\-case\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Makes this edge case the flow's happy path, and the outgoing happy path an edge case. Its persona and environment are baked into it first, so edge cases that were inheriting keep the configuration they had.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/customer\-flow/{flowId}/edge\-case/{edgeCaseId}/promote
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIflow\-id\fR
|
|
15
|
+
The flow\-id.
|
|
16
|
+
.TP
|
|
17
|
+
\fIedge\-case\-id\fR
|
|
18
|
+
The edge\-case\-id.
|
|
19
|
+
.SH "GLOBAL OPTIONS"
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
22
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
25
|
+
Skip confirmation prompts.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-no\-input\fR
|
|
28
|
+
Never prompt; fail instead.
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
31
|
+
API base URL.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
34
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
37
|
+
Request timeout in milliseconds.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
40
|
+
Retries for retryable failures.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
43
|
+
Output format: auto, json, jsonl, plain.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-json\fR
|
|
46
|
+
Shorthand for \-\-format json.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-\-no\-color\fR
|
|
49
|
+
Disable colour.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
52
|
+
Suppress non\-essential output.
|
|
53
|
+
.TP
|
|
54
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
55
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
56
|
+
.SH "EXAMPLES"
|
|
57
|
+
.PP
|
|
58
|
+
.RS 4
|
|
59
|
+
.nf
|
|
60
|
+
roark customer\-flow edge\-case promote <flow\-id> <edge\-case\-id>
|
|
61
|
+
.fi
|
|
62
|
+
.RE
|
|
63
|
+
.SH "ENVIRONMENT"
|
|
64
|
+
.TP
|
|
65
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
66
|
+
Bearer token used when \-\-token is not given.
|
|
67
|
+
.TP
|
|
68
|
+
\fBROARK_BASE_URL\fR
|
|
69
|
+
API base URL.
|
|
70
|
+
.TP
|
|
71
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
72
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
73
|
+
.TP
|
|
74
|
+
\fBNO_COLOR\fR
|
|
75
|
+
Disables colour when set to any value.
|
|
76
|
+
.SH "EXIT STATUS"
|
|
77
|
+
.TP
|
|
78
|
+
\fB0\fR
|
|
79
|
+
The command succeeded.
|
|
80
|
+
.TP
|
|
81
|
+
\fB1\fR
|
|
82
|
+
The API rejected the request.
|
|
83
|
+
.TP
|
|
84
|
+
\fB2\fR
|
|
85
|
+
The command line was wrong.
|
|
86
|
+
.TP
|
|
87
|
+
\fB3\fR
|
|
88
|
+
No credential, or the credential was refused.
|
|
89
|
+
.TP
|
|
90
|
+
\fB4\fR
|
|
91
|
+
The addressed resource does not exist.
|
|
92
|
+
.TP
|
|
93
|
+
\fB5\fR
|
|
94
|
+
The request never completed: connection, timeout, or abort.
|
|
95
|
+
.SH "SEE ALSO"
|
|
96
|
+
.BR roark (1)
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CUSTOMER\-FLOW\-EDGE\-CASE\-UPDATE" "1" "" "roark-customer-flow-edge-case-update" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-customer\-flow\-edge\-case\-update \- Update an edge case
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark customer\-flow edge\-case update
|
|
7
|
+
\fIflow\-id\fR \fIedge\-case\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Updates an edge case's title, persona, environment, brief, preceded\-by link or expectations. Omitted fields are left alone; `additionalExpectations` replaces the set wholesale rather than appending. Promoting it to the happy path is a separate call, since that also demotes the incumbent.
|
|
10
|
+
.SH "API"
|
|
11
|
+
PUT /v1/customer\-flow/{flowId}/edge\-case/{edgeCaseId}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIflow\-id\fR
|
|
15
|
+
The flow\-id.
|
|
16
|
+
.TP
|
|
17
|
+
\fIedge\-case\-id\fR
|
|
18
|
+
The edge\-case\-id.
|
|
19
|
+
.SH "OPTIONS"
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-title\fR \fI<value>\fR
|
|
22
|
+
Optional.
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-environment\-id\fR \fI<value>\fR
|
|
25
|
+
Optional.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-prompt\fR \fI<value>\fR
|
|
28
|
+
Optional.
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-preceded\-by\-customer\-flow\-id\fR \fI<value>\fR
|
|
31
|
+
Optional.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-preceded\-by\-customer\-flow\-variant\-id\fR \fI<value>\fR
|
|
34
|
+
Optional.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-persona\-override\-id\fR \fI<value>\fR
|
|
37
|
+
The persona this runs as. Null on an edge case inherits the happy path's. Optional.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-additional\-expectations\fR \fI<value>\fR
|
|
40
|
+
Replaces the expectations that apply to this variant on top of the flow's. Omit to leave them alone, send [] to clear. Improv flows only: a scripted variant's expectations come from the agent turns on its path and are rewritten on the next graph edit. Optional.
|
|
41
|
+
.SH "GLOBAL OPTIONS"
|
|
42
|
+
.TP
|
|
43
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
44
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
45
|
+
.TP
|
|
46
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
47
|
+
Skip confirmation prompts.
|
|
48
|
+
.TP
|
|
49
|
+
\fB\-\-no\-input\fR
|
|
50
|
+
Never prompt; fail instead.
|
|
51
|
+
.TP
|
|
52
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
53
|
+
API base URL.
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
56
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
57
|
+
.TP
|
|
58
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
59
|
+
Request timeout in milliseconds.
|
|
60
|
+
.TP
|
|
61
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
62
|
+
Retries for retryable failures.
|
|
63
|
+
.TP
|
|
64
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
65
|
+
Output format: auto, json, jsonl, plain.
|
|
66
|
+
.TP
|
|
67
|
+
\fB\-\-json\fR
|
|
68
|
+
Shorthand for \-\-format json.
|
|
69
|
+
.TP
|
|
70
|
+
\fB\-\-no\-color\fR
|
|
71
|
+
Disable colour.
|
|
72
|
+
.TP
|
|
73
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
74
|
+
Suppress non\-essential output.
|
|
75
|
+
.TP
|
|
76
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
77
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
78
|
+
.SH "EXAMPLES"
|
|
79
|
+
.PP
|
|
80
|
+
.RS 4
|
|
81
|
+
.nf
|
|
82
|
+
roark customer\-flow edge\-case update <flow\-id> <edge\-case\-id>
|
|
83
|
+
.fi
|
|
84
|
+
.RE
|
|
85
|
+
.SH "ENVIRONMENT"
|
|
86
|
+
.TP
|
|
87
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
88
|
+
Bearer token used when \-\-token is not given.
|
|
89
|
+
.TP
|
|
90
|
+
\fBROARK_BASE_URL\fR
|
|
91
|
+
API base URL.
|
|
92
|
+
.TP
|
|
93
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
94
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
95
|
+
.TP
|
|
96
|
+
\fBNO_COLOR\fR
|
|
97
|
+
Disables colour when set to any value.
|
|
98
|
+
.SH "EXIT STATUS"
|
|
99
|
+
.TP
|
|
100
|
+
\fB0\fR
|
|
101
|
+
The command succeeded.
|
|
102
|
+
.TP
|
|
103
|
+
\fB1\fR
|
|
104
|
+
The API rejected the request.
|
|
105
|
+
.TP
|
|
106
|
+
\fB2\fR
|
|
107
|
+
The command line was wrong.
|
|
108
|
+
.TP
|
|
109
|
+
\fB3\fR
|
|
110
|
+
No credential, or the credential was refused.
|
|
111
|
+
.TP
|
|
112
|
+
\fB4\fR
|
|
113
|
+
The addressed resource does not exist.
|
|
114
|
+
.TP
|
|
115
|
+
\fB5\fR
|
|
116
|
+
The request never completed: connection, timeout, or abort.
|
|
117
|
+
.SH "SEE ALSO"
|
|
118
|
+
.BR roark (1)
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CUSTOMER\-FLOW\-GET" "1" "" "roark-customer-flow-get" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-customer\-flow\-get \- Get customer flow by ID
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark customer\-flow get
|
|
7
|
+
\fIflow\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Returns a customer flow with its happy path, edge cases, expectations and linked agents. Scripted flows also carry their step graph.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/customer\-flow/{flowId}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIflow\-id\fR
|
|
15
|
+
The flow\-id.
|
|
16
|
+
.SH "GLOBAL OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
19
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
22
|
+
Skip confirmation prompts.
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-no\-input\fR
|
|
25
|
+
Never prompt; fail instead.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
28
|
+
API base URL.
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
31
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
34
|
+
Request timeout in milliseconds.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
37
|
+
Retries for retryable failures.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
40
|
+
Output format: auto, json, jsonl, plain.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-json\fR
|
|
43
|
+
Shorthand for \-\-format json.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-no\-color\fR
|
|
46
|
+
Disable colour.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
49
|
+
Suppress non\-essential output.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
52
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
53
|
+
.SH "EXAMPLES"
|
|
54
|
+
.PP
|
|
55
|
+
.RS 4
|
|
56
|
+
.nf
|
|
57
|
+
roark customer\-flow get <flow\-id>
|
|
58
|
+
.fi
|
|
59
|
+
.RE
|
|
60
|
+
.SH "ENVIRONMENT"
|
|
61
|
+
.TP
|
|
62
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
63
|
+
Bearer token used when \-\-token is not given.
|
|
64
|
+
.TP
|
|
65
|
+
\fBROARK_BASE_URL\fR
|
|
66
|
+
API base URL.
|
|
67
|
+
.TP
|
|
68
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
69
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
70
|
+
.TP
|
|
71
|
+
\fBNO_COLOR\fR
|
|
72
|
+
Disables colour when set to any value.
|
|
73
|
+
.SH "EXIT STATUS"
|
|
74
|
+
.TP
|
|
75
|
+
\fB0\fR
|
|
76
|
+
The command succeeded.
|
|
77
|
+
.TP
|
|
78
|
+
\fB1\fR
|
|
79
|
+
The API rejected the request.
|
|
80
|
+
.TP
|
|
81
|
+
\fB2\fR
|
|
82
|
+
The command line was wrong.
|
|
83
|
+
.TP
|
|
84
|
+
\fB3\fR
|
|
85
|
+
No credential, or the credential was refused.
|
|
86
|
+
.TP
|
|
87
|
+
\fB4\fR
|
|
88
|
+
The addressed resource does not exist.
|
|
89
|
+
.TP
|
|
90
|
+
\fB5\fR
|
|
91
|
+
The request never completed: connection, timeout, or abort.
|
|
92
|
+
.SH "SEE ALSO"
|
|
93
|
+
.BR roark (1)
|