@roarkanalytics/cli 0.72.1 → 0.74.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 +25 -0
- package/README.md +191 -135
- package/commands.js +2764 -471
- package/completions.js +4 -4
- package/man/roark-agent-build.1 +3 -3
- package/man/roark-agent-conversation-create.1 +106 -0
- package/man/roark-agent-create.1 +27 -3
- package/man/roark-agent-draft-update.1 +4 -1
- package/man/roark-agent-endpoint-create.1 +5 -5
- package/man/roark-agent-endpoint-get.1 +1 -1
- package/man/roark-agent-get.1 +1 -1
- package/man/roark-autoimprove-job-cancel.1 +1 -1
- package/man/roark-autoimprove-job-dismiss.1 +1 -1
- package/man/roark-autoimprove-job-guidance-send.1 +1 -1
- package/man/roark-autoimprove-job-promote.1 +1 -1
- package/man/roark-benchmark-target-history-list.1 +1 -1
- package/man/roark-call-create.1 +3 -0
- package/man/roark-call-get.1 +1 -1
- package/man/roark-connections-agent-backfill-cancel.1 +96 -0
- package/man/roark-connections-agent-backfill-create.1 +97 -0
- package/man/roark-connections-agent-backfill-list.1 +93 -0
- package/man/roark-connections-agent-create.1 +124 -0
- package/man/roark-connections-agent-delete.1 +93 -0
- package/man/roark-connections-agent-discover.1 +96 -0
- package/man/roark-connections-agent-get.1 +93 -0
- package/man/roark-connections-agent-list.1 +93 -0
- package/man/roark-connections-agent-provider-list.1 +89 -0
- package/man/roark-connections-agent-update.1 +128 -0
- package/man/roark-connections-calendar-calendar-list.1 +93 -0
- package/man/roark-connections-calendar-calendly-oauth-start.1 +99 -0
- package/man/{roark-calendar-connection-check.1 → roark-connections-calendar-check.1} +5 -5
- package/man/{roark-calendar-connection-create.1 → roark-connections-calendar-create.1} +7 -7
- package/man/{roark-calendar-connection-delete.1 → roark-connections-calendar-delete.1} +5 -5
- package/man/{roark-calendar-connection-get.1 → roark-connections-calendar-get.1} +5 -5
- package/man/roark-connections-calendar-google-oauth-start.1 +102 -0
- package/man/{roark-calendar-connection-list.1 → roark-connections-calendar-list.1} +6 -6
- package/man/roark-connections-calendar-target-create.1 +124 -0
- package/man/roark-connections-calendar-target-delete.1 +96 -0
- package/man/{roark-calendar-connection-target-get.1 → roark-connections-calendar-target-get.1} +5 -5
- package/man/{roark-calendar-connection-target-list.1 → roark-connections-calendar-target-list.1} +5 -5
- package/man/roark-connections-calendar-target-update.1 +124 -0
- package/man/{roark-calendar-connection-update.1 → roark-connections-calendar-update.1} +5 -5
- package/man/roark-connections-mcp-server-create.1 +105 -0
- package/man/roark-connections-mcp-server-delete.1 +93 -0
- package/man/roark-connections-mcp-server-discover.1 +99 -0
- package/man/roark-connections-mcp-server-get.1 +93 -0
- package/man/roark-connections-mcp-server-list.1 +89 -0
- package/man/roark-connections-mcp-server-refresh.1 +93 -0
- package/man/roark-connections-mcp-server-update.1 +100 -0
- package/man/roark-conversation-get.1 +93 -0
- package/man/roark-credential-create.1 +2 -2
- package/man/roark-credential-list.1 +2 -2
- package/man/roark-credential-revoke.1 +2 -2
- package/man/roark-customer-attribute-delete.1 +96 -0
- package/man/roark-customer-attribute-unlock.1 +96 -0
- package/man/roark-customer-attribute-update.1 +100 -0
- package/man/roark-customer-conversation-list.1 +100 -0
- package/man/roark-customer-delete.1 +93 -0
- package/man/roark-customer-field-create.1 +105 -0
- package/man/roark-customer-field-delete.1 +93 -0
- package/man/roark-customer-field-list.1 +89 -0
- package/man/roark-customer-field-update.1 +106 -0
- package/man/roark-customer-flow-edge-case-create.1 +1 -1
- package/man/roark-customer-flow-edge-case-update.1 +1 -1
- package/man/roark-customer-flow-folder-create.1 +99 -0
- package/man/roark-customer-flow-folder-delete.1 +93 -0
- package/man/roark-customer-flow-folder-list.1 +89 -0
- package/man/roark-customer-flow-get.1 +1 -1
- package/man/roark-customer-flow-happy-path-update.1 +1 -1
- package/man/roark-customer-flow-list.1 +3 -0
- package/man/roark-customer-flow-update.1 +4 -1
- package/man/roark-customer-get.1 +93 -0
- package/man/roark-customer-list.1 +123 -0
- package/man/roark-customer-notes-update.1 +97 -0
- package/man/roark-dashboard-list.1 +1 -1
- package/man/roark-dashboard-update.1 +1 -1
- package/man/roark-http-request-definition-create.1 +1 -1
- package/man/roark-http-request-definition-get.1 +1 -1
- package/man/roark-http-request-definition-update.1 +1 -1
- package/man/roark-metric-collection-job-get.1 +1 -1
- package/man/roark-metric-definition-create.1 +1 -1
- package/man/roark-metric-definition-update.1 +1 -1
- package/man/roark-metric-policy-create.1 +1 -1
- package/man/roark-metric-policy-get.1 +1 -1
- package/man/roark-metric-variant-list.1 +1 -1
- package/man/roark-metric-variant-update.1 +1 -1
- package/man/roark-project-list.1 +1 -1
- package/man/roark-simulation-environment-create.1 +12 -0
- package/man/roark-simulation-environment-get.1 +1 -1
- package/man/roark-simulation-environment-update.1 +12 -0
- package/man/roark-simulation-group-create.1 +2 -2
- package/man/roark-simulation-group-delete.1 +1 -1
- package/man/roark-simulation-group-get.1 +1 -1
- package/man/roark-simulation-group-list.1 +1 -1
- package/man/roark-simulation-group-run.1 +2 -2
- package/man/roark-simulation-group-update.1 +1 -1
- package/man/roark-simulation-job-get.1 +1 -1
- package/man/roark-simulation-job-lookup.1 +1 -1
- package/man/roark-simulation-persona-create.1 +1 -1
- package/man/roark-simulation-persona-get.1 +1 -1
- package/man/roark-simulation-persona-update.1 +1 -1
- package/man/roark-simulation-plan-get.1 +1 -1
- package/man/roark-simulation-plan-job-cancel.1 +1 -1
- package/man/roark-simulation-plan-job-cost-get.1 +1 -1
- package/man/roark-simulation-plan-job-debrief-create.1 +1 -1
- package/man/roark-simulation-plan-job-delete.1 +1 -1
- package/man/roark-simulation-plan-job-get.1 +1 -1
- package/man/roark-simulation-plan-job-list.1 +1 -1
- package/man/roark-simulation-plan-job-result-get.1 +1 -1
- package/man/roark-simulation-plan-update.1 +7 -1
- package/man/roark-simulation-resource-generate.1 +120 -0
- package/man/roark-simulation-resource-generation-answer.1 +97 -0
- package/man/roark-simulation-resource-generation-cancel.1 +93 -0
- package/man/roark-simulation-resource-generation-get.1 +93 -0
- package/man/roark-simulation-resource-generation-guidance-send.1 +97 -0
- package/man/roark-simulation-resource-generation-list.1 +96 -0
- package/man/roark-simulation-run-group-list.1 +1 -1
- package/man/roark-tool-create.1 +32 -2
- package/man/roark-tool-update.1 +32 -2
- package/man/roark-usage-get.1 +1 -1
- package/man/roark-webhook-create.1 +2 -2
- package/man/roark-webhook-delete.1 +1 -1
- package/man/roark-webhook-get.1 +1 -1
- package/man/roark-whoami.1 +1 -1
- package/man/roark.1 +208 -70
- package/npm-shrinkwrap.json +6 -6
- package/package.json +56 -10
- package/version.d.ts +1 -1
- package/version.js +1 -1
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CUSTOMER\-CONVERSATION\-LIST" "1" "" "roark-customer-conversation-list" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-customer\-conversation\-list \- List a customer's conversations
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark customer conversation list
|
|
7
|
+
\fIcustomer\-profile\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Calls and chats with this customer, newest first.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/customer/{customerProfileId}/conversations
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIcustomer\-profile\-id\fR
|
|
15
|
+
The customer\-profile\-id.
|
|
16
|
+
.SH "OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-limit\fR \fI<value>\fR
|
|
19
|
+
Optional.
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-page\fR \fI<value>\fR
|
|
22
|
+
Optional.
|
|
23
|
+
.SH "GLOBAL OPTIONS"
|
|
24
|
+
.TP
|
|
25
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
26
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
27
|
+
.TP
|
|
28
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
29
|
+
Skip confirmation prompts.
|
|
30
|
+
.TP
|
|
31
|
+
\fB\-\-no\-input\fR
|
|
32
|
+
Never prompt; fail instead.
|
|
33
|
+
.TP
|
|
34
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
35
|
+
API base URL.
|
|
36
|
+
.TP
|
|
37
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
38
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
39
|
+
.TP
|
|
40
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
41
|
+
Request timeout in milliseconds.
|
|
42
|
+
.TP
|
|
43
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
44
|
+
Retries for retryable failures.
|
|
45
|
+
.TP
|
|
46
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
47
|
+
Output format: auto, json, jsonl, plain.
|
|
48
|
+
.TP
|
|
49
|
+
\fB\-\-json\fR
|
|
50
|
+
Shorthand for \-\-format json.
|
|
51
|
+
.TP
|
|
52
|
+
\fB\-\-no\-color\fR
|
|
53
|
+
Disable colour.
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
56
|
+
Suppress non\-essential output.
|
|
57
|
+
.TP
|
|
58
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
59
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
60
|
+
.SH "EXAMPLES"
|
|
61
|
+
.PP
|
|
62
|
+
.RS 4
|
|
63
|
+
.nf
|
|
64
|
+
roark customer conversation list <customer\-profile\-id>
|
|
65
|
+
.fi
|
|
66
|
+
.RE
|
|
67
|
+
.SH "ENVIRONMENT"
|
|
68
|
+
.TP
|
|
69
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
70
|
+
Bearer token used when \-\-token is not given.
|
|
71
|
+
.TP
|
|
72
|
+
\fBROARK_BASE_URL\fR
|
|
73
|
+
API base URL.
|
|
74
|
+
.TP
|
|
75
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
76
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
77
|
+
.TP
|
|
78
|
+
\fBNO_COLOR\fR
|
|
79
|
+
Disables colour when set to any value.
|
|
80
|
+
.SH "EXIT STATUS"
|
|
81
|
+
.TP
|
|
82
|
+
\fB0\fR
|
|
83
|
+
The command succeeded.
|
|
84
|
+
.TP
|
|
85
|
+
\fB1\fR
|
|
86
|
+
The API rejected the request.
|
|
87
|
+
.TP
|
|
88
|
+
\fB2\fR
|
|
89
|
+
The command line was wrong.
|
|
90
|
+
.TP
|
|
91
|
+
\fB3\fR
|
|
92
|
+
No credential, or the credential was refused.
|
|
93
|
+
.TP
|
|
94
|
+
\fB4\fR
|
|
95
|
+
The addressed resource does not exist.
|
|
96
|
+
.TP
|
|
97
|
+
\fB5\fR
|
|
98
|
+
The request never completed: connection, timeout, or abort.
|
|
99
|
+
.SH "SEE ALSO"
|
|
100
|
+
.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\-DELETE" "1" "" "roark-customer-delete" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-customer\-delete \- Erase a customer
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark customer delete
|
|
7
|
+
\fIcustomer\-profile\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Permanently removes the customer, with their fields, evidence and notes. Conversations are kept. A new conversation from the same identifier starts a new customer.
|
|
10
|
+
.SH "API"
|
|
11
|
+
DELETE /v1/customer/{customerProfileId}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIcustomer\-profile\-id\fR
|
|
15
|
+
The customer\-profile\-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 delete <customer\-profile\-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,105 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CUSTOMER\-FIELD\-CREATE" "1" "" "roark-customer-field-create" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-customer\-field\-create \- Create a customer field
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark customer field create
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Adds a field of your project's own. With extract on, conversations fill it from what customers say, guided by its description.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/customer/fields
|
|
12
|
+
.SH "OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-key\fR \fI<value>\fR
|
|
15
|
+
Starts with a letter; letters, numbers and underscores only. Fixed once created. Required.
|
|
16
|
+
.TP
|
|
17
|
+
\fB\-\-label\fR \fI<value>\fR
|
|
18
|
+
Required.
|
|
19
|
+
.TP
|
|
20
|
+
\fB\-\-description\fR \fI<value>\fR
|
|
21
|
+
What the agent listens for in a conversation. Required when extract is true. Optional.
|
|
22
|
+
.TP
|
|
23
|
+
\fB\-\-value\-type\fR \fI<value>\fR
|
|
24
|
+
One of: TEXT, NUMBER, BOOLEAN, DATE, PHONE_NUMBER, EMAIL, CURRENCY. Required.
|
|
25
|
+
.TP
|
|
26
|
+
\fB\-\-extract\fR
|
|
27
|
+
Whether conversations fill this field Required.
|
|
28
|
+
.SH "GLOBAL OPTIONS"
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
31
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
34
|
+
Skip confirmation prompts.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-no\-input\fR
|
|
37
|
+
Never prompt; fail instead.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
40
|
+
API base URL.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
43
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
46
|
+
Request timeout in milliseconds.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
49
|
+
Retries for retryable failures.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
52
|
+
Output format: auto, json, jsonl, plain.
|
|
53
|
+
.TP
|
|
54
|
+
\fB\-\-json\fR
|
|
55
|
+
Shorthand for \-\-format json.
|
|
56
|
+
.TP
|
|
57
|
+
\fB\-\-no\-color\fR
|
|
58
|
+
Disable colour.
|
|
59
|
+
.TP
|
|
60
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
61
|
+
Suppress non\-essential output.
|
|
62
|
+
.TP
|
|
63
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
64
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
65
|
+
.SH "EXAMPLES"
|
|
66
|
+
.PP
|
|
67
|
+
.RS 4
|
|
68
|
+
.nf
|
|
69
|
+
roark customer field create \-\-key <value> \-\-label <value> \-\-value\-type <value> \-\-extract <value>
|
|
70
|
+
.fi
|
|
71
|
+
.RE
|
|
72
|
+
.SH "ENVIRONMENT"
|
|
73
|
+
.TP
|
|
74
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
75
|
+
Bearer token used when \-\-token is not given.
|
|
76
|
+
.TP
|
|
77
|
+
\fBROARK_BASE_URL\fR
|
|
78
|
+
API base URL.
|
|
79
|
+
.TP
|
|
80
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
81
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
82
|
+
.TP
|
|
83
|
+
\fBNO_COLOR\fR
|
|
84
|
+
Disables colour when set to any value.
|
|
85
|
+
.SH "EXIT STATUS"
|
|
86
|
+
.TP
|
|
87
|
+
\fB0\fR
|
|
88
|
+
The command succeeded.
|
|
89
|
+
.TP
|
|
90
|
+
\fB1\fR
|
|
91
|
+
The API rejected the request.
|
|
92
|
+
.TP
|
|
93
|
+
\fB2\fR
|
|
94
|
+
The command line was wrong.
|
|
95
|
+
.TP
|
|
96
|
+
\fB3\fR
|
|
97
|
+
No credential, or the credential was refused.
|
|
98
|
+
.TP
|
|
99
|
+
\fB4\fR
|
|
100
|
+
The addressed resource does not exist.
|
|
101
|
+
.TP
|
|
102
|
+
\fB5\fR
|
|
103
|
+
The request never completed: connection, timeout, or abort.
|
|
104
|
+
.SH "SEE ALSO"
|
|
105
|
+
.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\-FIELD\-DELETE" "1" "" "roark-customer-field-delete" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-customer\-field\-delete \- Delete a customer field
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark customer field delete
|
|
7
|
+
\fIkey\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Deletes a field of your project's own. Its values stop showing on customers. A built\-in field cannot be deleted; turn it off instead.
|
|
10
|
+
.SH "API"
|
|
11
|
+
DELETE /v1/customer/fields/{key}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIkey\fR
|
|
15
|
+
The key.
|
|
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 field delete <key>
|
|
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,89 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CUSTOMER\-FIELD\-LIST" "1" "" "roark-customer-field-list" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-customer\-field\-list \- List customer fields
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark customer field list
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
The fields this project's customers can hold, in display order. Use a field's key to filter, sort and set attributes.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/customer/fields
|
|
12
|
+
.SH "GLOBAL OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
15
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
16
|
+
.TP
|
|
17
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
18
|
+
Skip confirmation prompts.
|
|
19
|
+
.TP
|
|
20
|
+
\fB\-\-no\-input\fR
|
|
21
|
+
Never prompt; fail instead.
|
|
22
|
+
.TP
|
|
23
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
24
|
+
API base URL.
|
|
25
|
+
.TP
|
|
26
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
27
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
30
|
+
Request timeout in milliseconds.
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
33
|
+
Retries for retryable failures.
|
|
34
|
+
.TP
|
|
35
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
36
|
+
Output format: auto, json, jsonl, plain.
|
|
37
|
+
.TP
|
|
38
|
+
\fB\-\-json\fR
|
|
39
|
+
Shorthand for \-\-format json.
|
|
40
|
+
.TP
|
|
41
|
+
\fB\-\-no\-color\fR
|
|
42
|
+
Disable colour.
|
|
43
|
+
.TP
|
|
44
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
45
|
+
Suppress non\-essential output.
|
|
46
|
+
.TP
|
|
47
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
48
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
49
|
+
.SH "EXAMPLES"
|
|
50
|
+
.PP
|
|
51
|
+
.RS 4
|
|
52
|
+
.nf
|
|
53
|
+
roark customer field list
|
|
54
|
+
.fi
|
|
55
|
+
.RE
|
|
56
|
+
.SH "ENVIRONMENT"
|
|
57
|
+
.TP
|
|
58
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
59
|
+
Bearer token used when \-\-token is not given.
|
|
60
|
+
.TP
|
|
61
|
+
\fBROARK_BASE_URL\fR
|
|
62
|
+
API base URL.
|
|
63
|
+
.TP
|
|
64
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
65
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
66
|
+
.TP
|
|
67
|
+
\fBNO_COLOR\fR
|
|
68
|
+
Disables colour when set to any value.
|
|
69
|
+
.SH "EXIT STATUS"
|
|
70
|
+
.TP
|
|
71
|
+
\fB0\fR
|
|
72
|
+
The command succeeded.
|
|
73
|
+
.TP
|
|
74
|
+
\fB1\fR
|
|
75
|
+
The API rejected the request.
|
|
76
|
+
.TP
|
|
77
|
+
\fB2\fR
|
|
78
|
+
The command line was wrong.
|
|
79
|
+
.TP
|
|
80
|
+
\fB3\fR
|
|
81
|
+
No credential, or the credential was refused.
|
|
82
|
+
.TP
|
|
83
|
+
\fB4\fR
|
|
84
|
+
The addressed resource does not exist.
|
|
85
|
+
.TP
|
|
86
|
+
\fB5\fR
|
|
87
|
+
The request never completed: connection, timeout, or abort.
|
|
88
|
+
.SH "SEE ALSO"
|
|
89
|
+
.BR roark (1)
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CUSTOMER\-FIELD\-UPDATE" "1" "" "roark-customer-field-update" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-customer\-field\-update \- Update a customer field
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark customer field update
|
|
7
|
+
\fIkey\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Changes a field. A built\-in field can only be turned on or off for your project; any field of your project's own can change everything but its key.
|
|
10
|
+
.SH "API"
|
|
11
|
+
PATCH /v1/customer/fields/{key}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIkey\fR
|
|
15
|
+
The key.
|
|
16
|
+
.SH "OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-label\fR \fI<value>\fR
|
|
19
|
+
Optional.
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-description\fR \fI<value>\fR
|
|
22
|
+
Optional.
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-value\-type\fR \fI<value>\fR
|
|
25
|
+
One of: TEXT, NUMBER, BOOLEAN, DATE, PHONE_NUMBER, EMAIL, CURRENCY. Optional.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-extract\fR
|
|
28
|
+
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 customer field update <key>
|
|
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)
|
|
@@ -22,7 +22,7 @@ Required.
|
|
|
22
22
|
Optional.
|
|
23
23
|
.TP
|
|
24
24
|
\fB\-\-prompt\fR \fI<value>\fR
|
|
25
|
-
Optional.
|
|
25
|
+
The brief the simulated customer improvises from. Caller cues steer the caller from that point in the brief: `#{emotion:<emotion>}`, `#{language:<ISO 639\-1 code>}`, `#{noise:<environmentId>}`, and `#{interrupt}`, whose sentence says when to cut in on your agent. Cues are voice only. See "Caller cues" in the customer flows concept. Optional.
|
|
26
26
|
.TP
|
|
27
27
|
\fB\-\-opening\-line\fR \fI<value>\fR
|
|
28
28
|
Optional.
|
|
@@ -25,7 +25,7 @@ Optional.
|
|
|
25
25
|
Optional.
|
|
26
26
|
.TP
|
|
27
27
|
\fB\-\-prompt\fR \fI<value>\fR
|
|
28
|
-
Optional.
|
|
28
|
+
Improv flows only. The brief the simulated customer improvises from. Caller cues steer the caller from that point in the brief: `#{emotion:<emotion>}`, `#{language:<ISO 639\-1 code>}`, `#{noise:<environmentId>}`, and `#{interrupt}`, whose sentence says when to cut in on your agent. Cues are voice only. See "Caller cues" in the customer flows concept. Optional.
|
|
29
29
|
.TP
|
|
30
30
|
\fB\-\-opening\-line\fR \fI<value>\fR
|
|
31
31
|
Optional.
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CUSTOMER\-FLOW\-FOLDER\-CREATE" "1" "" "roark-customer-flow-folder-create" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-customer\-flow\-folder\-create \- Create a customer flow folder
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark customer\-flow folder create
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Creates a folder to group customer flows. File a flow into it by sending its `folderId` when you create or update the flow. Names are unique within a project, ignoring case. Customer flows were previously called scenarios.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/customer\-flow/folder
|
|
12
|
+
.SH "OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-name\fR \fI<value>\fR
|
|
15
|
+
The folder name. Must be unique in the project. Required.
|
|
16
|
+
.TP
|
|
17
|
+
\fB\-\-color\fR \fI<value>\fR
|
|
18
|
+
The color the folder is shown with in the app. Folders share the palette labels use. Defaults to GREY. One of: GREEN, RED, ORANGE, PURPLE, GREY, BLUE, PEACH, TEAL, INDIGO, AMBER, ROSE, CYAN. Optional.
|
|
19
|
+
.TP
|
|
20
|
+
\fB\-\-description\fR \fI<value>\fR
|
|
21
|
+
What belongs in this folder. Optional.
|
|
22
|
+
.SH "GLOBAL OPTIONS"
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
25
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
28
|
+
Skip confirmation prompts.
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-no\-input\fR
|
|
31
|
+
Never prompt; fail instead.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
34
|
+
API base URL.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
37
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
40
|
+
Request timeout in milliseconds.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
43
|
+
Retries for retryable failures.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
46
|
+
Output format: auto, json, jsonl, plain.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-\-json\fR
|
|
49
|
+
Shorthand for \-\-format json.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-\-no\-color\fR
|
|
52
|
+
Disable colour.
|
|
53
|
+
.TP
|
|
54
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
55
|
+
Suppress non\-essential output.
|
|
56
|
+
.TP
|
|
57
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
58
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
59
|
+
.SH "EXAMPLES"
|
|
60
|
+
.PP
|
|
61
|
+
.RS 4
|
|
62
|
+
.nf
|
|
63
|
+
roark customer\-flow folder create \-\-name <value>
|
|
64
|
+
.fi
|
|
65
|
+
.RE
|
|
66
|
+
.SH "ENVIRONMENT"
|
|
67
|
+
.TP
|
|
68
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
69
|
+
Bearer token used when \-\-token is not given.
|
|
70
|
+
.TP
|
|
71
|
+
\fBROARK_BASE_URL\fR
|
|
72
|
+
API base URL.
|
|
73
|
+
.TP
|
|
74
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
75
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
76
|
+
.TP
|
|
77
|
+
\fBNO_COLOR\fR
|
|
78
|
+
Disables colour when set to any value.
|
|
79
|
+
.SH "EXIT STATUS"
|
|
80
|
+
.TP
|
|
81
|
+
\fB0\fR
|
|
82
|
+
The command succeeded.
|
|
83
|
+
.TP
|
|
84
|
+
\fB1\fR
|
|
85
|
+
The API rejected the request.
|
|
86
|
+
.TP
|
|
87
|
+
\fB2\fR
|
|
88
|
+
The command line was wrong.
|
|
89
|
+
.TP
|
|
90
|
+
\fB3\fR
|
|
91
|
+
No credential, or the credential was refused.
|
|
92
|
+
.TP
|
|
93
|
+
\fB4\fR
|
|
94
|
+
The addressed resource does not exist.
|
|
95
|
+
.TP
|
|
96
|
+
\fB5\fR
|
|
97
|
+
The request never completed: connection, timeout, or abort.
|
|
98
|
+
.SH "SEE ALSO"
|
|
99
|
+
.BR roark (1)
|