@roarkanalytics/cli 0.71.0 → 0.73.1
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 +28 -0
- package/README.md +14 -0
- package/commands.js +392 -0
- package/completions.js +4 -4
- package/man/roark-call-create.1 +3 -0
- package/man/roark-customer-profile-attribute-delete.1 +96 -0
- package/man/roark-customer-profile-attribute-unlock.1 +96 -0
- package/man/roark-customer-profile-attribute-update.1 +100 -0
- package/man/roark-customer-profile-conversation-list.1 +100 -0
- package/man/roark-customer-profile-delete.1 +93 -0
- package/man/roark-customer-profile-get.1 +93 -0
- package/man/roark-customer-profile-list.1 +123 -0
- package/man/roark-customer-profile-notes-update.1 +97 -0
- package/man/roark-simulation-plan-job-delete.1 +93 -0
- package/man/roark.1 +27 -0
- package/npm-shrinkwrap.json +6 -6
- package/package.json +11 -2
- package/version.d.ts +1 -1
- package/version.js +1 -1
package/man/roark-call-create.1
CHANGED
|
@@ -68,6 +68,9 @@ Label to identify this customer in the transcript (e.g., "speaker\-01", "speaker
|
|
|
68
68
|
\fB\-\-customer.phone\-number\-e164\fR \fI<value>\fR
|
|
69
69
|
Customer phone number in E.164 format (e.g., +14155551234) Required.
|
|
70
70
|
.TP
|
|
71
|
+
\fB\-\-customer.external\-id\fR \fI<value>\fR
|
|
72
|
+
Your own stable id for this person. Links conversations to one customer profile where there is no phone number, such as web calls. Optional.
|
|
73
|
+
.TP
|
|
71
74
|
\fB\-\-customers\fR \fI<value>\fR
|
|
72
75
|
Customers participating in the call. Optional.
|
|
73
76
|
.SH "GLOBAL OPTIONS"
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CUSTOMER\-PROFILE\-ATTRIBUTE\-DELETE" "1" "" "roark-customer-profile-attribute-delete" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-customer\-profile\-attribute\-delete \- Clear a customer profile field
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark customer\-profile attribute delete
|
|
7
|
+
\fIcustomer\-profile\-id\fR \fIkey\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Removes the value and any lock, so a later conversation can fill it again.
|
|
10
|
+
.SH "API"
|
|
11
|
+
DELETE /v1/customer\-profile/{customerProfileId}/attributes/{key}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIcustomer\-profile\-id\fR
|
|
15
|
+
The customer\-profile\-id.
|
|
16
|
+
.TP
|
|
17
|
+
\fIkey\fR
|
|
18
|
+
The key.
|
|
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\-profile attribute delete <customer\-profile\-id> <key>
|
|
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\-PROFILE\-ATTRIBUTE\-UNLOCK" "1" "" "roark-customer-profile-attribute-unlock" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-customer\-profile\-attribute\-unlock \- Unlock a customer profile field
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark customer\-profile attribute unlock
|
|
7
|
+
\fIcustomer\-profile\-id\fR \fIkey\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Lets newer conversations change this field again. The current value stays until one does.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/customer\-profile/{customerProfileId}/attributes/{key}/unlock
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIcustomer\-profile\-id\fR
|
|
15
|
+
The customer\-profile\-id.
|
|
16
|
+
.TP
|
|
17
|
+
\fIkey\fR
|
|
18
|
+
The key.
|
|
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\-profile attribute unlock <customer\-profile\-id> <key>
|
|
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,100 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CUSTOMER\-PROFILE\-ATTRIBUTE\-UPDATE" "1" "" "roark-customer-profile-attribute-update" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-customer\-profile\-attribute\-update \- Set a customer profile field
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark customer\-profile attribute update
|
|
7
|
+
\fIcustomer\-profile\-id\fR \fIkey\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Sets the value and locks the field, so newer conversations cannot change it.
|
|
10
|
+
.SH "API"
|
|
11
|
+
PUT /v1/customer\-profile/{customerProfileId}/attributes/{key}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIcustomer\-profile\-id\fR
|
|
15
|
+
The customer\-profile\-id.
|
|
16
|
+
.TP
|
|
17
|
+
\fIkey\fR
|
|
18
|
+
The key.
|
|
19
|
+
.SH "OPTIONS"
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-value\fR \fI<value>\fR
|
|
22
|
+
The new value. Setting a field locks it, so newer conversations cannot change it. Required.
|
|
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\-profile attribute update <customer\-profile\-id> <key> \-\-value <value>
|
|
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,100 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CUSTOMER\-PROFILE\-CONVERSATION\-LIST" "1" "" "roark-customer-profile-conversation-list" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-customer\-profile\-conversation\-list \- List a customer's conversations
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark customer\-profile 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\-profile/{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\-profile 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\-PROFILE\-DELETE" "1" "" "roark-customer-profile-delete" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-customer\-profile\-delete \- Erase a customer profile
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark customer\-profile delete
|
|
7
|
+
\fIcustomer\-profile\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Permanently removes the profile, its fields, evidence and notes. Conversations are kept. A new conversation from the same identifier creates a new profile.
|
|
10
|
+
.SH "API"
|
|
11
|
+
DELETE /v1/customer\-profile/{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\-profile 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,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CUSTOMER\-PROFILE\-GET" "1" "" "roark-customer-profile-get" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-customer\-profile\-get \- Get a customer profile
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark customer\-profile get
|
|
7
|
+
\fIcustomer\-profile\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Get a customer profile
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/customer\-profile/{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\-profile get <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,123 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CUSTOMER\-PROFILE\-LIST" "1" "" "roark-customer-profile-list" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-customer\-profile\-list \- List customer profiles
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark customer\-profile list
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Returns the people who have talked to your agents in this project. Customers we hold nothing about beyond their identifier are left out unless includeNoData is true.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/customer\-profile
|
|
12
|
+
.SH "OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-limit\fR \fI<value>\fR
|
|
15
|
+
Optional.
|
|
16
|
+
.TP
|
|
17
|
+
\fB\-\-page\fR \fI<value>\fR
|
|
18
|
+
Optional.
|
|
19
|
+
.TP
|
|
20
|
+
\fB\-\-search\fR \fI<value>\fR
|
|
21
|
+
Optional.
|
|
22
|
+
.TP
|
|
23
|
+
\fB\-\-agent\-id\fR \fI<value>\fR
|
|
24
|
+
Optional.
|
|
25
|
+
.TP
|
|
26
|
+
\fB\-\-modality\fR \fI<value>\fR
|
|
27
|
+
One of: call, chat. Optional.
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-\-include\-no\-data\fR \fI<value>\fR
|
|
30
|
+
Include customers we hold nothing about beyond their identifier. Defaults to false. One of: true, false. Optional.
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-\-sort\-by\fR \fI<value>\fR
|
|
33
|
+
A column, or field.<KEY> (for example field.COMPANY) to sort by a field's value. Customers without a value sort last. One of: lastSeenAt, firstSeenAt, conversationCount, voiceCount, chatCount, talkTimeMs, displayName, field.FULL_NAME, field.PREFERRED_NAME, field.ACCOUNT_ID, field.COMPANY, field.JOB_TITLE, field.EMAIL, field.ALTERNATE_PHONE, field.AGE, field.GENDER, field.LANGUAGE, field.LOCATION, field.TIMEZONE, field.BEST_TIME_TO_REACH, field.PREFERRED_CHANNEL. Optional.
|
|
34
|
+
.TP
|
|
35
|
+
\fB\-\-sort\-direction\fR \fI<value>\fR
|
|
36
|
+
One of: asc, desc. Optional.
|
|
37
|
+
.TP
|
|
38
|
+
\fB\-\-field\-key\fR \fI<value>\fR
|
|
39
|
+
Filter by this field. Use with fieldOperator and, unless checking presence, fieldValue. One of: FULL_NAME, PREFERRED_NAME, ACCOUNT_ID, COMPANY, JOB_TITLE, EMAIL, ALTERNATE_PHONE, AGE, GENDER, LANGUAGE, LOCATION, TIMEZONE, BEST_TIME_TO_REACH, PREFERRED_CHANNEL. Optional.
|
|
40
|
+
.TP
|
|
41
|
+
\fB\-\-field\-operator\fR \fI<value>\fR
|
|
42
|
+
How fieldValue is compared, ignoring case. NOT_EQUALS includes customers without the field. One of: EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, IS_SET, IS_NOT_SET. Optional.
|
|
43
|
+
.TP
|
|
44
|
+
\fB\-\-field\-value\fR \fI<value>\fR
|
|
45
|
+
Optional.
|
|
46
|
+
.SH "GLOBAL OPTIONS"
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
49
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
52
|
+
Skip confirmation prompts.
|
|
53
|
+
.TP
|
|
54
|
+
\fB\-\-no\-input\fR
|
|
55
|
+
Never prompt; fail instead.
|
|
56
|
+
.TP
|
|
57
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
58
|
+
API base URL.
|
|
59
|
+
.TP
|
|
60
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
61
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
62
|
+
.TP
|
|
63
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
64
|
+
Request timeout in milliseconds.
|
|
65
|
+
.TP
|
|
66
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
67
|
+
Retries for retryable failures.
|
|
68
|
+
.TP
|
|
69
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
70
|
+
Output format: auto, json, jsonl, plain.
|
|
71
|
+
.TP
|
|
72
|
+
\fB\-\-json\fR
|
|
73
|
+
Shorthand for \-\-format json.
|
|
74
|
+
.TP
|
|
75
|
+
\fB\-\-no\-color\fR
|
|
76
|
+
Disable colour.
|
|
77
|
+
.TP
|
|
78
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
79
|
+
Suppress non\-essential output.
|
|
80
|
+
.TP
|
|
81
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
82
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
83
|
+
.SH "EXAMPLES"
|
|
84
|
+
.PP
|
|
85
|
+
.RS 4
|
|
86
|
+
.nf
|
|
87
|
+
roark customer\-profile list
|
|
88
|
+
.fi
|
|
89
|
+
.RE
|
|
90
|
+
.SH "ENVIRONMENT"
|
|
91
|
+
.TP
|
|
92
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
93
|
+
Bearer token used when \-\-token is not given.
|
|
94
|
+
.TP
|
|
95
|
+
\fBROARK_BASE_URL\fR
|
|
96
|
+
API base URL.
|
|
97
|
+
.TP
|
|
98
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
99
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
100
|
+
.TP
|
|
101
|
+
\fBNO_COLOR\fR
|
|
102
|
+
Disables colour when set to any value.
|
|
103
|
+
.SH "EXIT STATUS"
|
|
104
|
+
.TP
|
|
105
|
+
\fB0\fR
|
|
106
|
+
The command succeeded.
|
|
107
|
+
.TP
|
|
108
|
+
\fB1\fR
|
|
109
|
+
The API rejected the request.
|
|
110
|
+
.TP
|
|
111
|
+
\fB2\fR
|
|
112
|
+
The command line was wrong.
|
|
113
|
+
.TP
|
|
114
|
+
\fB3\fR
|
|
115
|
+
No credential, or the credential was refused.
|
|
116
|
+
.TP
|
|
117
|
+
\fB4\fR
|
|
118
|
+
The addressed resource does not exist.
|
|
119
|
+
.TP
|
|
120
|
+
\fB5\fR
|
|
121
|
+
The request never completed: connection, timeout, or abort.
|
|
122
|
+
.SH "SEE ALSO"
|
|
123
|
+
.BR roark (1)
|