@roarkanalytics/cli 0.72.1 → 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 +14 -0
- package/README.md +13 -0
- package/commands.js +369 -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.1 +24 -0
- package/npm-shrinkwrap.json +6 -6
- package/package.json +10 -2
- package/version.d.ts +1 -1
- package/version.js +1 -1
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CUSTOMER\-PROFILE\-NOTES\-UPDATE" "1" "" "roark-customer-profile-notes-update" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-customer\-profile\-notes\-update \- Update the notes on a customer profile
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark customer\-profile notes update
|
|
7
|
+
\fIcustomer\-profile\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Replaces your team's shared notes. Null or empty clears them. The last save wins.
|
|
10
|
+
.SH "API"
|
|
11
|
+
PUT /v1/customer\-profile/{customerProfileId}/notes
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIcustomer\-profile\-id\fR
|
|
15
|
+
The customer\-profile\-id.
|
|
16
|
+
.SH "OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-notes\fR \fI<value>\fR
|
|
19
|
+
Replaces the existing notes. Null or empty clears them. Required.
|
|
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\-profile notes update <customer\-profile\-id> \-\-notes <value>
|
|
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)
|
package/man/roark.1
CHANGED
|
@@ -294,6 +294,30 @@ List customer flows See roark\-customer\-flow\-list(1).
|
|
|
294
294
|
\fBroark customer\-flow update\fR
|
|
295
295
|
Update a customer flow See roark\-customer\-flow\-update(1).
|
|
296
296
|
.TP
|
|
297
|
+
\fBroark customer\-profile attribute delete\fR
|
|
298
|
+
Clear a customer profile field See roark\-customer\-profile\-attribute\-delete(1).
|
|
299
|
+
.TP
|
|
300
|
+
\fBroark customer\-profile attribute unlock\fR
|
|
301
|
+
Unlock a customer profile field See roark\-customer\-profile\-attribute\-unlock(1).
|
|
302
|
+
.TP
|
|
303
|
+
\fBroark customer\-profile attribute update\fR
|
|
304
|
+
Set a customer profile field See roark\-customer\-profile\-attribute\-update(1).
|
|
305
|
+
.TP
|
|
306
|
+
\fBroark customer\-profile conversation list\fR
|
|
307
|
+
List a customer's conversations See roark\-customer\-profile\-conversation\-list(1).
|
|
308
|
+
.TP
|
|
309
|
+
\fBroark customer\-profile delete\fR
|
|
310
|
+
Erase a customer profile See roark\-customer\-profile\-delete(1).
|
|
311
|
+
.TP
|
|
312
|
+
\fBroark customer\-profile get\fR
|
|
313
|
+
Get a customer profile See roark\-customer\-profile\-get(1).
|
|
314
|
+
.TP
|
|
315
|
+
\fBroark customer\-profile list\fR
|
|
316
|
+
List customer profiles See roark\-customer\-profile\-list(1).
|
|
317
|
+
.TP
|
|
318
|
+
\fBroark customer\-profile notes update\fR
|
|
319
|
+
Update the notes on a customer profile See roark\-customer\-profile\-notes\-update(1).
|
|
320
|
+
.TP
|
|
297
321
|
\fBroark dashboard create\fR
|
|
298
322
|
Create a dashboard See roark\-dashboard\-create(1).
|
|
299
323
|
.TP
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@roarkanalytics/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.73.1",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "@roarkanalytics/cli",
|
|
9
|
-
"version": "0.
|
|
9
|
+
"version": "0.73.1",
|
|
10
10
|
"license": "Apache-2.0",
|
|
11
11
|
"dependencies": {
|
|
12
|
-
"@roarkanalytics/sdk": "^7.
|
|
12
|
+
"@roarkanalytics/sdk": "^7.8.0",
|
|
13
13
|
"commander": "^14.0.3",
|
|
14
14
|
"jiti": "^2.4.2",
|
|
15
15
|
"yaml": "^2.9.0"
|
|
@@ -22,9 +22,9 @@
|
|
|
22
22
|
}
|
|
23
23
|
},
|
|
24
24
|
"node_modules/@roarkanalytics/sdk": {
|
|
25
|
-
"version": "7.
|
|
26
|
-
"resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-7.
|
|
27
|
-
"integrity": "sha512-
|
|
25
|
+
"version": "7.8.0",
|
|
26
|
+
"resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-7.8.0.tgz",
|
|
27
|
+
"integrity": "sha512-VaWqzBWoFRuA0yo+s446Fo4UQhfYyYlKCPOQZvx2diLWPFdB7JpE9qLFIUBcINgThSVJVxYOTEcrBTPRgw1Yug==",
|
|
28
28
|
"license": "Apache-2.0"
|
|
29
29
|
},
|
|
30
30
|
"node_modules/commander": {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@roarkanalytics/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.73.1",
|
|
4
4
|
"description": "The official command line interface for the Roark API",
|
|
5
5
|
"author": "Roark <james@roark.ai>",
|
|
6
6
|
"type": "commonjs",
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
"fix": "eslint --fix . && prettier --write ."
|
|
30
30
|
},
|
|
31
31
|
"dependencies": {
|
|
32
|
-
"@roarkanalytics/sdk": "^7.
|
|
32
|
+
"@roarkanalytics/sdk": "^7.8.0",
|
|
33
33
|
"commander": "^14.0.3",
|
|
34
34
|
"jiti": "^2.4.2",
|
|
35
35
|
"yaml": "^2.9.0"
|
|
@@ -114,6 +114,14 @@
|
|
|
114
114
|
"./man/roark-customer-flow-happy-path-update.1",
|
|
115
115
|
"./man/roark-customer-flow-list.1",
|
|
116
116
|
"./man/roark-customer-flow-update.1",
|
|
117
|
+
"./man/roark-customer-profile-attribute-delete.1",
|
|
118
|
+
"./man/roark-customer-profile-attribute-unlock.1",
|
|
119
|
+
"./man/roark-customer-profile-attribute-update.1",
|
|
120
|
+
"./man/roark-customer-profile-conversation-list.1",
|
|
121
|
+
"./man/roark-customer-profile-delete.1",
|
|
122
|
+
"./man/roark-customer-profile-get.1",
|
|
123
|
+
"./man/roark-customer-profile-list.1",
|
|
124
|
+
"./man/roark-customer-profile-notes-update.1",
|
|
117
125
|
"./man/roark-dashboard-create.1",
|
|
118
126
|
"./man/roark-dashboard-data-get.1",
|
|
119
127
|
"./man/roark-dashboard-delete.1",
|
package/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const version = "0.
|
|
1
|
+
export declare const version = "0.73.1";
|
package/version.js
CHANGED