@roarkanalytics/cli 0.6.0 → 0.8.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/CHANGELOG.md +14 -0
- package/README.md +4 -0
- package/commands.js +183 -2
- package/completions.js +4 -4
- package/man/roark-customer-flow-duplicate.1 +93 -0
- package/man/roark-simulation-environment-create.1 +102 -0
- package/man/roark-simulation-environment-delete.1 +93 -0
- package/man/roark-simulation-environment-update.1 +106 -0
- package/man/roark-simulation-run.1 +4 -1
- package/man/roark.1 +12 -0
- package/npm-shrinkwrap.json +5 -5
- package/package.json +5 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CUSTOMER\-FLOW\-DUPLICATE" "1" "" "roark-customer-flow-duplicate" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-customer\-flow\-duplicate \- Duplicate a customer flow
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark customer\-flow duplicate
|
|
7
|
+
\fIflow\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Deep\-copies a flow into a new project\-owned flow. The copy carries the source's description, branching mode, linked agents, flow\-level expectations and flow\-owned metrics. A scripted flow copies its whole step graph; an improv flow copies its variants (personas, briefs, expectations). Duplicating a Roark\-managed flow is how you customise it. Voicemail flows are Roark\-managed and cannot be duplicated.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/customer\-flow/{flowId}/duplicate
|
|
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 duplicate <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,102 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-SIMULATION\-ENVIRONMENT\-CREATE" "1" "" "roark-simulation-environment-create" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-simulation\-environment\-create \- Create an environment
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark simulation environment create
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Creates an environment for the project: a noise bed and the level it plays at. Reference it by id when setting a customer flow variant's environment. Roark's curated presets always play at the default level, so this is how a project gets the same bed louder or quieter.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/simulation/environment
|
|
12
|
+
.SH "OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-name\fR \fI<value>\fR
|
|
15
|
+
Display name, shown wherever a flow variant references the environment Required.
|
|
16
|
+
.TP
|
|
17
|
+
\fB\-\-description\fR \fI<value>\fR
|
|
18
|
+
Optional note on when to use this environment Optional.
|
|
19
|
+
.TP
|
|
20
|
+
\fB\-\-background\-noise\fR \fI<value>\fR
|
|
21
|
+
The noise bed played underneath the simulated caller. NONE plays nothing. One of: NONE, AIRPORT, CHILDREN_PLAYING, CITY, COFFEE_SHOP, DRIVING, OFFICE, THUNDERSTORM. Required.
|
|
22
|
+
.TP
|
|
23
|
+
\fB\-\-background\-noise\-volume\fR \fI<value>\fR
|
|
24
|
+
How loud the bed plays, as a gain from 0 (silent) to 1 (as loud as the caller). Defaults to 0.1, which sits well under the caller. Ignored on Vapi endpoints, which have no level control. Optional.
|
|
25
|
+
.SH "GLOBAL OPTIONS"
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
28
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
31
|
+
Skip confirmation prompts.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-no\-input\fR
|
|
34
|
+
Never prompt; fail instead.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
37
|
+
API base URL.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
40
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
43
|
+
Request timeout in milliseconds.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
46
|
+
Retries for retryable failures.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
49
|
+
Output format: auto, json, jsonl, plain.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-\-json\fR
|
|
52
|
+
Shorthand for \-\-format json.
|
|
53
|
+
.TP
|
|
54
|
+
\fB\-\-no\-color\fR
|
|
55
|
+
Disable colour.
|
|
56
|
+
.TP
|
|
57
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
58
|
+
Suppress non\-essential output.
|
|
59
|
+
.TP
|
|
60
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
61
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
62
|
+
.SH "EXAMPLES"
|
|
63
|
+
.PP
|
|
64
|
+
.RS 4
|
|
65
|
+
.nf
|
|
66
|
+
roark simulation environment create \-\-name <value> \-\-background\-noise <value>
|
|
67
|
+
.fi
|
|
68
|
+
.RE
|
|
69
|
+
.SH "ENVIRONMENT"
|
|
70
|
+
.TP
|
|
71
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
72
|
+
Bearer token used when \-\-token is not given.
|
|
73
|
+
.TP
|
|
74
|
+
\fBROARK_BASE_URL\fR
|
|
75
|
+
API base URL.
|
|
76
|
+
.TP
|
|
77
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
78
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
79
|
+
.TP
|
|
80
|
+
\fBNO_COLOR\fR
|
|
81
|
+
Disables colour when set to any value.
|
|
82
|
+
.SH "EXIT STATUS"
|
|
83
|
+
.TP
|
|
84
|
+
\fB0\fR
|
|
85
|
+
The command succeeded.
|
|
86
|
+
.TP
|
|
87
|
+
\fB1\fR
|
|
88
|
+
The API rejected the request.
|
|
89
|
+
.TP
|
|
90
|
+
\fB2\fR
|
|
91
|
+
The command line was wrong.
|
|
92
|
+
.TP
|
|
93
|
+
\fB3\fR
|
|
94
|
+
No credential, or the credential was refused.
|
|
95
|
+
.TP
|
|
96
|
+
\fB4\fR
|
|
97
|
+
The addressed resource does not exist.
|
|
98
|
+
.TP
|
|
99
|
+
\fB5\fR
|
|
100
|
+
The request never completed: connection, timeout, or abort.
|
|
101
|
+
.SH "SEE ALSO"
|
|
102
|
+
.BR roark (1)
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-SIMULATION\-ENVIRONMENT\-DELETE" "1" "" "roark-simulation-environment-delete" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-simulation\-environment\-delete \- Delete an environment
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark simulation environment delete
|
|
7
|
+
\fIenvironment\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Soft\-deletes one of the project's environments. It disappears from reads and cannot be picked for new runs; runs already built keep their snapshot. Refused (409) while a live customer flow variant still uses it: move those variants first. Roark\-curated environments cannot be deleted (403).
|
|
10
|
+
.SH "API"
|
|
11
|
+
DELETE /v1/simulation/environment/{environmentId}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIenvironment\-id\fR
|
|
15
|
+
The environment\-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 simulation environment delete <environment\-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,106 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-SIMULATION\-ENVIRONMENT\-UPDATE" "1" "" "roark-simulation-environment-update" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-simulation\-environment\-update \- Update an environment
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark simulation environment update
|
|
7
|
+
\fIenvironment\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Updates one of the project's environments. Only the fields sent are changed. Runs already built keep the snapshot they were built with. Roark\-curated environments cannot be edited (403).
|
|
10
|
+
.SH "API"
|
|
11
|
+
PUT /v1/simulation/environment/{environmentId}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIenvironment\-id\fR
|
|
15
|
+
The environment\-id.
|
|
16
|
+
.SH "OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-name\fR \fI<value>\fR
|
|
19
|
+
Display name, shown wherever a flow variant references the environment Optional.
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-description\fR \fI<value>\fR
|
|
22
|
+
Optional note on when to use this environment Optional.
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-background\-noise\fR \fI<value>\fR
|
|
25
|
+
The noise bed played underneath the simulated caller. NONE plays nothing. One of: NONE, AIRPORT, CHILDREN_PLAYING, CITY, COFFEE_SHOP, DRIVING, OFFICE, THUNDERSTORM. Optional.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-background\-noise\-volume\fR \fI<value>\fR
|
|
28
|
+
How loud the bed plays, as a gain from 0 (silent) to 1 (as loud as the caller). Defaults to 0.1, which sits well under the caller. Ignored on Vapi endpoints, which have no level control. Optional.
|
|
29
|
+
.SH "GLOBAL OPTIONS"
|
|
30
|
+
.TP
|
|
31
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
32
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
33
|
+
.TP
|
|
34
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
35
|
+
Skip confirmation prompts.
|
|
36
|
+
.TP
|
|
37
|
+
\fB\-\-no\-input\fR
|
|
38
|
+
Never prompt; fail instead.
|
|
39
|
+
.TP
|
|
40
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
41
|
+
API base URL.
|
|
42
|
+
.TP
|
|
43
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
44
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
45
|
+
.TP
|
|
46
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
47
|
+
Request timeout in milliseconds.
|
|
48
|
+
.TP
|
|
49
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
50
|
+
Retries for retryable failures.
|
|
51
|
+
.TP
|
|
52
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
53
|
+
Output format: auto, json, jsonl, plain.
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-\-json\fR
|
|
56
|
+
Shorthand for \-\-format json.
|
|
57
|
+
.TP
|
|
58
|
+
\fB\-\-no\-color\fR
|
|
59
|
+
Disable colour.
|
|
60
|
+
.TP
|
|
61
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
62
|
+
Suppress non\-essential output.
|
|
63
|
+
.TP
|
|
64
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
65
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
66
|
+
.SH "EXAMPLES"
|
|
67
|
+
.PP
|
|
68
|
+
.RS 4
|
|
69
|
+
.nf
|
|
70
|
+
roark simulation environment update <environment\-id>
|
|
71
|
+
.fi
|
|
72
|
+
.RE
|
|
73
|
+
.SH "ENVIRONMENT"
|
|
74
|
+
.TP
|
|
75
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
76
|
+
Bearer token used when \-\-token is not given.
|
|
77
|
+
.TP
|
|
78
|
+
\fBROARK_BASE_URL\fR
|
|
79
|
+
API base URL.
|
|
80
|
+
.TP
|
|
81
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
82
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
83
|
+
.TP
|
|
84
|
+
\fBNO_COLOR\fR
|
|
85
|
+
Disables colour when set to any value.
|
|
86
|
+
.SH "EXIT STATUS"
|
|
87
|
+
.TP
|
|
88
|
+
\fB0\fR
|
|
89
|
+
The command succeeded.
|
|
90
|
+
.TP
|
|
91
|
+
\fB1\fR
|
|
92
|
+
The API rejected the request.
|
|
93
|
+
.TP
|
|
94
|
+
\fB2\fR
|
|
95
|
+
The command line was wrong.
|
|
96
|
+
.TP
|
|
97
|
+
\fB3\fR
|
|
98
|
+
No credential, or the credential was refused.
|
|
99
|
+
.TP
|
|
100
|
+
\fB4\fR
|
|
101
|
+
The addressed resource does not exist.
|
|
102
|
+
.TP
|
|
103
|
+
\fB5\fR
|
|
104
|
+
The request never completed: connection, timeout, or abort.
|
|
105
|
+
.SH "SEE ALSO"
|
|
106
|
+
.BR roark (1)
|
|
@@ -6,7 +6,7 @@ roark\-simulation\-run \- Run a simulation
|
|
|
6
6
|
.B roark simulation run
|
|
7
7
|
[\fIoptions\fR]
|
|
8
8
|
.SH "DESCRIPTION"
|
|
9
|
-
Starts a simulation and returns the run. Send `plan` to describe a simulation and run it once.
|
|
9
|
+
Starts a simulation and returns the run. Send `template` to run one of the built\-in templates: it supplies the metrics and checks, and for some templates the flows too, so the request only names the agent and the direction. Send `plan` to describe a simulation yourself and run it once. Send `planId` to run a plan you already have. `template` and `plan` both resolve to a run plan, returned as `simulationRunPlanId`. Add `saveAsPlan` to keep it, or read it back to see exactly what ran. A plan built from a template is a snapshot: retuning the template later never changes what that plan runs, which is what makes a saved one safe to pin in CI.
|
|
10
10
|
.SH "API"
|
|
11
11
|
POST /v1/simulation/run
|
|
12
12
|
.SH "REQUEST BODY"
|
|
@@ -17,6 +17,9 @@ Requires plan.
|
|
|
17
17
|
.TP
|
|
18
18
|
\fBRunSimulationFromPlanId\fR
|
|
19
19
|
Requires planId.
|
|
20
|
+
.TP
|
|
21
|
+
\fBRunSimulationFromTemplate\fR
|
|
22
|
+
Requires template, agentEndpoints, direction.
|
|
20
23
|
.SH "GLOBAL OPTIONS"
|
|
21
24
|
.TP
|
|
22
25
|
\fB\-\-data\fR \fI<json>\fR
|
package/man/roark.1
CHANGED
|
@@ -117,6 +117,9 @@ Create a customer flow See roark\-customer\-flow\-create(1).
|
|
|
117
117
|
\fBroark customer\-flow delete\fR
|
|
118
118
|
Delete a customer flow See roark\-customer\-flow\-delete(1).
|
|
119
119
|
.TP
|
|
120
|
+
\fBroark customer\-flow duplicate\fR
|
|
121
|
+
Duplicate a customer flow See roark\-customer\-flow\-duplicate(1).
|
|
122
|
+
.TP
|
|
120
123
|
\fBroark customer\-flow edge\-case create\fR
|
|
121
124
|
Add an edge case See roark\-customer\-flow\-edge\-case\-create(1).
|
|
122
125
|
.TP
|
|
@@ -207,12 +210,21 @@ List a metric’s variants See roark\-metric\-variant\-list(1).
|
|
|
207
210
|
\fBroark metric variant update\fR
|
|
208
211
|
Update a metric variant See roark\-metric\-variant\-update(1).
|
|
209
212
|
.TP
|
|
213
|
+
\fBroark simulation environment create\fR
|
|
214
|
+
Create an environment See roark\-simulation\-environment\-create(1).
|
|
215
|
+
.TP
|
|
216
|
+
\fBroark simulation environment delete\fR
|
|
217
|
+
Delete an environment See roark\-simulation\-environment\-delete(1).
|
|
218
|
+
.TP
|
|
210
219
|
\fBroark simulation environment get\fR
|
|
211
220
|
Get environment by ID See roark\-simulation\-environment\-get(1).
|
|
212
221
|
.TP
|
|
213
222
|
\fBroark simulation environment list\fR
|
|
214
223
|
List environments See roark\-simulation\-environment\-list(1).
|
|
215
224
|
.TP
|
|
225
|
+
\fBroark simulation environment update\fR
|
|
226
|
+
Update an environment See roark\-simulation\-environment\-update(1).
|
|
227
|
+
.TP
|
|
216
228
|
\fBroark simulation job get\fR
|
|
217
229
|
Get simulation by ID See roark\-simulation\-job\-get(1).
|
|
218
230
|
.TP
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@roarkanalytics/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.8.0",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "@roarkanalytics/cli",
|
|
9
|
-
"version": "0.
|
|
9
|
+
"version": "0.8.0",
|
|
10
10
|
"license": "Apache-2.0",
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"@roarkanalytics/sdk": "^3.2.1",
|
|
@@ -21,9 +21,9 @@
|
|
|
21
21
|
}
|
|
22
22
|
},
|
|
23
23
|
"node_modules/@roarkanalytics/sdk": {
|
|
24
|
-
"version": "3.
|
|
25
|
-
"resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-3.
|
|
26
|
-
"integrity": "sha512-
|
|
24
|
+
"version": "3.11.0",
|
|
25
|
+
"resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-3.11.0.tgz",
|
|
26
|
+
"integrity": "sha512-o+aE8tNpWeqVxwwI5gS1oW5/e+DdFhIs3R1Earg1mivCq1rif3mMWRqdQy8x7dLBvCYLWGuSjPmOna7kXBHUlw==",
|
|
27
27
|
"license": "Apache-2.0"
|
|
28
28
|
},
|
|
29
29
|
"node_modules/commander": {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@roarkanalytics/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.8.0",
|
|
4
4
|
"description": "The official command line interface for the Roark API",
|
|
5
5
|
"author": "Roark <james@roark.ai>",
|
|
6
6
|
"type": "commonjs",
|
|
@@ -54,6 +54,7 @@
|
|
|
54
54
|
"./man/roark-config-diff.1",
|
|
55
55
|
"./man/roark-customer-flow-create.1",
|
|
56
56
|
"./man/roark-customer-flow-delete.1",
|
|
57
|
+
"./man/roark-customer-flow-duplicate.1",
|
|
57
58
|
"./man/roark-customer-flow-edge-case-create.1",
|
|
58
59
|
"./man/roark-customer-flow-edge-case-delete.1",
|
|
59
60
|
"./man/roark-customer-flow-edge-case-promote.1",
|
|
@@ -84,8 +85,11 @@
|
|
|
84
85
|
"./man/roark-metric-variant-get.1",
|
|
85
86
|
"./man/roark-metric-variant-list.1",
|
|
86
87
|
"./man/roark-metric-variant-update.1",
|
|
88
|
+
"./man/roark-simulation-environment-create.1",
|
|
89
|
+
"./man/roark-simulation-environment-delete.1",
|
|
87
90
|
"./man/roark-simulation-environment-get.1",
|
|
88
91
|
"./man/roark-simulation-environment-list.1",
|
|
92
|
+
"./man/roark-simulation-environment-update.1",
|
|
89
93
|
"./man/roark-simulation-job-get.1",
|
|
90
94
|
"./man/roark-simulation-job-lookup.1",
|
|
91
95
|
"./man/roark-simulation-persona-create.1",
|
package/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const version = "0.
|
|
1
|
+
export declare const version = "0.8.0";
|
package/version.js
CHANGED