@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.
Files changed (129) hide show
  1. package/CHANGELOG.md +25 -0
  2. package/README.md +191 -135
  3. package/commands.js +2764 -471
  4. package/completions.js +4 -4
  5. package/man/roark-agent-build.1 +3 -3
  6. package/man/roark-agent-conversation-create.1 +106 -0
  7. package/man/roark-agent-create.1 +27 -3
  8. package/man/roark-agent-draft-update.1 +4 -1
  9. package/man/roark-agent-endpoint-create.1 +5 -5
  10. package/man/roark-agent-endpoint-get.1 +1 -1
  11. package/man/roark-agent-get.1 +1 -1
  12. package/man/roark-autoimprove-job-cancel.1 +1 -1
  13. package/man/roark-autoimprove-job-dismiss.1 +1 -1
  14. package/man/roark-autoimprove-job-guidance-send.1 +1 -1
  15. package/man/roark-autoimprove-job-promote.1 +1 -1
  16. package/man/roark-benchmark-target-history-list.1 +1 -1
  17. package/man/roark-call-create.1 +3 -0
  18. package/man/roark-call-get.1 +1 -1
  19. package/man/roark-connections-agent-backfill-cancel.1 +96 -0
  20. package/man/roark-connections-agent-backfill-create.1 +97 -0
  21. package/man/roark-connections-agent-backfill-list.1 +93 -0
  22. package/man/roark-connections-agent-create.1 +124 -0
  23. package/man/roark-connections-agent-delete.1 +93 -0
  24. package/man/roark-connections-agent-discover.1 +96 -0
  25. package/man/roark-connections-agent-get.1 +93 -0
  26. package/man/roark-connections-agent-list.1 +93 -0
  27. package/man/roark-connections-agent-provider-list.1 +89 -0
  28. package/man/roark-connections-agent-update.1 +128 -0
  29. package/man/roark-connections-calendar-calendar-list.1 +93 -0
  30. package/man/roark-connections-calendar-calendly-oauth-start.1 +99 -0
  31. package/man/{roark-calendar-connection-check.1 → roark-connections-calendar-check.1} +5 -5
  32. package/man/{roark-calendar-connection-create.1 → roark-connections-calendar-create.1} +7 -7
  33. package/man/{roark-calendar-connection-delete.1 → roark-connections-calendar-delete.1} +5 -5
  34. package/man/{roark-calendar-connection-get.1 → roark-connections-calendar-get.1} +5 -5
  35. package/man/roark-connections-calendar-google-oauth-start.1 +102 -0
  36. package/man/{roark-calendar-connection-list.1 → roark-connections-calendar-list.1} +6 -6
  37. package/man/roark-connections-calendar-target-create.1 +124 -0
  38. package/man/roark-connections-calendar-target-delete.1 +96 -0
  39. package/man/{roark-calendar-connection-target-get.1 → roark-connections-calendar-target-get.1} +5 -5
  40. package/man/{roark-calendar-connection-target-list.1 → roark-connections-calendar-target-list.1} +5 -5
  41. package/man/roark-connections-calendar-target-update.1 +124 -0
  42. package/man/{roark-calendar-connection-update.1 → roark-connections-calendar-update.1} +5 -5
  43. package/man/roark-connections-mcp-server-create.1 +105 -0
  44. package/man/roark-connections-mcp-server-delete.1 +93 -0
  45. package/man/roark-connections-mcp-server-discover.1 +99 -0
  46. package/man/roark-connections-mcp-server-get.1 +93 -0
  47. package/man/roark-connections-mcp-server-list.1 +89 -0
  48. package/man/roark-connections-mcp-server-refresh.1 +93 -0
  49. package/man/roark-connections-mcp-server-update.1 +100 -0
  50. package/man/roark-conversation-get.1 +93 -0
  51. package/man/roark-credential-create.1 +2 -2
  52. package/man/roark-credential-list.1 +2 -2
  53. package/man/roark-credential-revoke.1 +2 -2
  54. package/man/roark-customer-attribute-delete.1 +96 -0
  55. package/man/roark-customer-attribute-unlock.1 +96 -0
  56. package/man/roark-customer-attribute-update.1 +100 -0
  57. package/man/roark-customer-conversation-list.1 +100 -0
  58. package/man/roark-customer-delete.1 +93 -0
  59. package/man/roark-customer-field-create.1 +105 -0
  60. package/man/roark-customer-field-delete.1 +93 -0
  61. package/man/roark-customer-field-list.1 +89 -0
  62. package/man/roark-customer-field-update.1 +106 -0
  63. package/man/roark-customer-flow-edge-case-create.1 +1 -1
  64. package/man/roark-customer-flow-edge-case-update.1 +1 -1
  65. package/man/roark-customer-flow-folder-create.1 +99 -0
  66. package/man/roark-customer-flow-folder-delete.1 +93 -0
  67. package/man/roark-customer-flow-folder-list.1 +89 -0
  68. package/man/roark-customer-flow-get.1 +1 -1
  69. package/man/roark-customer-flow-happy-path-update.1 +1 -1
  70. package/man/roark-customer-flow-list.1 +3 -0
  71. package/man/roark-customer-flow-update.1 +4 -1
  72. package/man/roark-customer-get.1 +93 -0
  73. package/man/roark-customer-list.1 +123 -0
  74. package/man/roark-customer-notes-update.1 +97 -0
  75. package/man/roark-dashboard-list.1 +1 -1
  76. package/man/roark-dashboard-update.1 +1 -1
  77. package/man/roark-http-request-definition-create.1 +1 -1
  78. package/man/roark-http-request-definition-get.1 +1 -1
  79. package/man/roark-http-request-definition-update.1 +1 -1
  80. package/man/roark-metric-collection-job-get.1 +1 -1
  81. package/man/roark-metric-definition-create.1 +1 -1
  82. package/man/roark-metric-definition-update.1 +1 -1
  83. package/man/roark-metric-policy-create.1 +1 -1
  84. package/man/roark-metric-policy-get.1 +1 -1
  85. package/man/roark-metric-variant-list.1 +1 -1
  86. package/man/roark-metric-variant-update.1 +1 -1
  87. package/man/roark-project-list.1 +1 -1
  88. package/man/roark-simulation-environment-create.1 +12 -0
  89. package/man/roark-simulation-environment-get.1 +1 -1
  90. package/man/roark-simulation-environment-update.1 +12 -0
  91. package/man/roark-simulation-group-create.1 +2 -2
  92. package/man/roark-simulation-group-delete.1 +1 -1
  93. package/man/roark-simulation-group-get.1 +1 -1
  94. package/man/roark-simulation-group-list.1 +1 -1
  95. package/man/roark-simulation-group-run.1 +2 -2
  96. package/man/roark-simulation-group-update.1 +1 -1
  97. package/man/roark-simulation-job-get.1 +1 -1
  98. package/man/roark-simulation-job-lookup.1 +1 -1
  99. package/man/roark-simulation-persona-create.1 +1 -1
  100. package/man/roark-simulation-persona-get.1 +1 -1
  101. package/man/roark-simulation-persona-update.1 +1 -1
  102. package/man/roark-simulation-plan-get.1 +1 -1
  103. package/man/roark-simulation-plan-job-cancel.1 +1 -1
  104. package/man/roark-simulation-plan-job-cost-get.1 +1 -1
  105. package/man/roark-simulation-plan-job-debrief-create.1 +1 -1
  106. package/man/roark-simulation-plan-job-delete.1 +1 -1
  107. package/man/roark-simulation-plan-job-get.1 +1 -1
  108. package/man/roark-simulation-plan-job-list.1 +1 -1
  109. package/man/roark-simulation-plan-job-result-get.1 +1 -1
  110. package/man/roark-simulation-plan-update.1 +7 -1
  111. package/man/roark-simulation-resource-generate.1 +120 -0
  112. package/man/roark-simulation-resource-generation-answer.1 +97 -0
  113. package/man/roark-simulation-resource-generation-cancel.1 +93 -0
  114. package/man/roark-simulation-resource-generation-get.1 +93 -0
  115. package/man/roark-simulation-resource-generation-guidance-send.1 +97 -0
  116. package/man/roark-simulation-resource-generation-list.1 +96 -0
  117. package/man/roark-simulation-run-group-list.1 +1 -1
  118. package/man/roark-tool-create.1 +32 -2
  119. package/man/roark-tool-update.1 +32 -2
  120. package/man/roark-usage-get.1 +1 -1
  121. package/man/roark-webhook-create.1 +2 -2
  122. package/man/roark-webhook-delete.1 +1 -1
  123. package/man/roark-webhook-get.1 +1 -1
  124. package/man/roark-whoami.1 +1 -1
  125. package/man/roark.1 +208 -70
  126. package/npm-shrinkwrap.json +6 -6
  127. package/package.json +56 -10
  128. package/version.d.ts +1 -1
  129. 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\-FOLDER\-DELETE" "1" "" "roark-customer-flow-folder-delete" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-customer\-flow\-folder\-delete \- Delete a customer flow folder
5
+ .SH "SYNOPSIS"
6
+ .B roark customer\-flow folder delete
7
+ \fIfolder\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Deletes a folder. The flows in it are kept and no longer sit in any folder. Built\-in folders cannot be deleted.
10
+ .SH "API"
11
+ DELETE /v1/customer\-flow/folder/{folderId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIfolder\-id\fR
15
+ The folder\-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 folder delete <folder\-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,89 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-CUSTOMER\-FLOW\-FOLDER\-LIST" "1" "" "roark-customer-flow-folder-list" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-customer\-flow\-folder\-list \- List customer flow folders
5
+ .SH "SYNOPSIS"
6
+ .B roark customer\-flow folder list
7
+ [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Returns every folder the project groups its customer flows into, with how many flows each holds, in the order the app shows them. Filter the flow list to one folder with `GET /v1/customer\-flow?folderId=`. Customer flows were previously called scenarios.
10
+ .SH "API"
11
+ GET /v1/customer\-flow/folder
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\-flow folder 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)
@@ -1,7 +1,7 @@
1
1
  .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
2
  .TH "ROARK\-CUSTOMER\-FLOW\-GET" "1" "" "roark-customer-flow-get" "Roark Analytics API Manual"
3
3
  .SH "NAME"
4
- roark\-customer\-flow\-get \- Get customer flow by ID
4
+ roark\-customer\-flow\-get \- Get a customer flow
5
5
  .SH "SYNOPSIS"
6
6
  .B roark customer\-flow get
7
7
  \fIflow\-id\fR [\fIoptions\fR]
@@ -22,7 +22,7 @@ Optional.
22
22
  Optional.
23
23
  .TP
24
24
  \fB\-\-prompt\fR \fI<value>\fR
25
- Optional.
25
+ 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.
26
26
  .TP
27
27
  \fB\-\-opening\-line\fR \fI<value>\fR
28
28
  Optional.
@@ -23,6 +23,9 @@ Optional.
23
23
  \fB\-\-type\fR \fI<value>\fR
24
24
  One of: SCRIPTED, IMPROV, VOICEMAIL. Optional.
25
25
  .TP
26
+ \fB\-\-folder\-id\fR \fI<value>\fR
27
+ Optional.
28
+ .TP
26
29
  \fB\-\-include\-system\fR \fI<value>\fR
27
30
  One of: true, false. Optional.
28
31
  .SH "GLOBAL OPTIONS"
@@ -6,7 +6,7 @@ roark\-customer\-flow\-update \- Update a customer flow
6
6
  .B roark customer\-flow update
7
7
  \fIflow\-id\fR [\fIoptions\fR]
8
8
  .SH "DESCRIPTION"
9
- Updates a flow's title, description, branching mode, linked agents or flow\-level expectations. The step graph is replaced through PUT /graph.
9
+ Updates a flow's title, description, branching mode, linked agents, flow\-level expectations or folder. The step graph is replaced through PUT /graph.
10
10
  .SH "API"
11
11
  PUT /v1/customer\-flow/{flowId}
12
12
  .SH "ARGUMENTS"
@@ -50,6 +50,9 @@ Replaces the linked agents. Omit to leave them unchanged. An improv flow must ke
50
50
  .TP
51
51
  \fB\-\-agent\-expectations\fR \fI<value>\fR
52
52
  Replaces the flow\-level expectations. Omit to leave them unchanged. Optional.
53
+ .TP
54
+ \fB\-\-folder\-id\fR \fI<value>\fR
55
+ Moves the flow into this folder. Null takes it out of its folder; omit to leave it where it is. Optional.
53
56
  .SH "GLOBAL OPTIONS"
54
57
  .TP
55
58
  \fB\-\-data\fR \fI<json>\fR
@@ -0,0 +1,93 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-CUSTOMER\-GET" "1" "" "roark-customer-get" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-customer\-get \- Get a customer
5
+ .SH "SYNOPSIS"
6
+ .B roark customer get
7
+ \fIcustomer\-profile\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Get a customer
10
+ .SH "API"
11
+ GET /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 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\-LIST" "1" "" "roark-customer-list" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-customer\-list \- List customers
5
+ .SH "SYNOPSIS"
6
+ .B roark customer 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
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: voice, chat, call. 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
+ lastSeenAt (the default), firstSeenAt, conversationCount, voiceCount, chatCount, talkTimeMs or displayName, or field.<key> (for example field.COMPANY) to sort by a field's value. Field keys come from GET /v1/customer/fields. Customers without a value sort last. 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, a key from GET /v1/customer/fields. Use with fieldOperator and, unless checking presence, fieldValue. 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 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)
@@ -0,0 +1,97 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-CUSTOMER\-NOTES\-UPDATE" "1" "" "roark-customer-notes-update" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-customer\-notes\-update \- Update the notes on a customer
5
+ .SH "SYNOPSIS"
6
+ .B roark customer 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/{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 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)
@@ -6,7 +6,7 @@ roark\-dashboard\-list \- List dashboards
6
6
  .B roark dashboard list
7
7
  [\fIoptions\fR]
8
8
  .SH "DESCRIPTION"
9
- Lists the project's dashboards, the default first. GET /v1/dashboard/{dashboardId} returns the widgets.
9
+ Lists the project's dashboards, the default first. `GET /v1/dashboard/{dashboardId}` returns the widgets.
10
10
  .SH "API"
11
11
  GET /v1/dashboard
12
12
  .SH "GLOBAL OPTIONS"
@@ -6,7 +6,7 @@ roark\-dashboard\-update \- Update a dashboard
6
6
  .B roark dashboard update
7
7
  \fIdashboard\-id\fR [\fIoptions\fR]
8
8
  .SH "DESCRIPTION"
9
- Edits a dashboard. Omitted fields keep their current value. `widgets`, when sent, replaces the list: widgets are matched by name, so a widget that keeps its name keeps its id; a new name adds a widget and a name no longer listed removes it. To change one widget, PUT /v1/dashboard/{dashboardId}/widget/{widgetId}.
9
+ Edits a dashboard. Omitted fields keep their current value. `widgets`, when sent, replaces the list: widgets are matched by name, so a widget that keeps its name keeps its id; a new name adds a widget and a name no longer listed removes it. To change one widget, `PUT /v1/dashboard/{dashboardId}/widget/{widgetId}`.
10
10
  .SH "API"
11
11
  PUT /v1/dashboard/{dashboardId}
12
12
  .SH "ARGUMENTS"
@@ -1,7 +1,7 @@
1
1
  .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
2
  .TH "ROARK\-HTTP\-REQUEST\-DEFINITION\-CREATE" "1" "" "roark-http-request-definition-create" "Roark Analytics API Manual"
3
3
  .SH "NAME"
4
- roark\-http\-request\-definition\-create \- Create HTTP request definition
4
+ roark\-http\-request\-definition\-create \- Create an HTTP request definition
5
5
  .SH "SYNOPSIS"
6
6
  .B roark http\-request\-definition create
7
7
  [\fIoptions\fR]
@@ -1,7 +1,7 @@
1
1
  .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
2
  .TH "ROARK\-HTTP\-REQUEST\-DEFINITION\-GET" "1" "" "roark-http-request-definition-get" "Roark Analytics API Manual"
3
3
  .SH "NAME"
4
- roark\-http\-request\-definition\-get \- Get HTTP request definition by ID
4
+ roark\-http\-request\-definition\-get \- Get an HTTP request definition
5
5
  .SH "SYNOPSIS"
6
6
  .B roark http\-request\-definition get
7
7
  \fIdefinition\-id\fR [\fIoptions\fR]
@@ -1,7 +1,7 @@
1
1
  .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
2
  .TH "ROARK\-HTTP\-REQUEST\-DEFINITION\-UPDATE" "1" "" "roark-http-request-definition-update" "Roark Analytics API Manual"
3
3
  .SH "NAME"
4
- roark\-http\-request\-definition\-update \- Update HTTP request definition
4
+ roark\-http\-request\-definition\-update \- Update an HTTP request definition
5
5
  .SH "SYNOPSIS"
6
6
  .B roark http\-request\-definition update
7
7
  \fIdefinition\-id\fR [\fIoptions\fR]
@@ -1,7 +1,7 @@
1
1
  .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
2
  .TH "ROARK\-METRIC\-COLLECTION\-JOB\-GET" "1" "" "roark-metric-collection-job-get" "Roark Analytics API Manual"
3
3
  .SH "NAME"
4
- roark\-metric\-collection\-job\-get \- Get metric collection job by ID
4
+ roark\-metric\-collection\-job\-get \- Get a metric collection job
5
5
  .SH "SYNOPSIS"
6
6
  .B roark metric collection\-job get
7
7
  \fIjob\-id\fR [\fIoptions\fR]
@@ -1,7 +1,7 @@
1
1
  .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
2
  .TH "ROARK\-METRIC\-DEFINITION\-CREATE" "1" "" "roark-metric-definition-create" "Roark Analytics API Manual"
3
3
  .SH "NAME"
4
- roark\-metric\-definition\-create \- Create custom metric definition
4
+ roark\-metric\-definition\-create \- Create a metric definition
5
5
  .SH "SYNOPSIS"
6
6
  .B roark metric definition create
7
7
  [\fIoptions\fR]
@@ -19,7 +19,7 @@ The metric definition's Roark ID (UUID) or its stable `slug` (e.g. `customer_sat
19
19
  New name (only for metrics whose name is editable) Optional.
20
20
  .TP
21
21
  \fB\-\-llm\-prompt\fR \fI<value>\fR
22
- New LLM prompt (only for LLM_JUDGE metrics whose prompt is editable) Optional.
22
+ New LLM prompt (only for LLM_JUDGE metrics whose prompt is editable). A custom metric prompt must include a transcript variable such as `{{transcript}}` and `{{world_context}}`, which gives the judge the current date and time when it grades. Optional.
23
23
  .TP
24
24
  \fB\-\-scale\-min\fR \fI<value>\fR
25
25
  New scale minimum (SCALE output only) Optional.
@@ -18,7 +18,7 @@ Name of the metric policy Required.
18
18
  Status of the policy (default: ACTIVE) One of: ACTIVE, INACTIVE. Optional.
19
19
  .TP
20
20
  \fB\-\-modality\fR \fI<value>\fR
21
- Modality this policy targets. A policy fires for exactly one modality and can only reference metrics that support that modality. One of: call, chat. Required.
21
+ Modality this policy targets: `voice` or `chat` (`call` is still accepted for `voice`). A policy fires for exactly one modality and can only reference metrics that support that modality. One of: voice, chat, call. Required.
22
22
  .TP
23
23
  \fB\-\-conditions\fR \fI<value>\fR
24
24
  Condition groups. Omit to match all calls. Optional.
@@ -1,7 +1,7 @@
1
1
  .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
2
  .TH "ROARK\-METRIC\-POLICY\-GET" "1" "" "roark-metric-policy-get" "Roark Analytics API Manual"
3
3
  .SH "NAME"
4
- roark\-metric\-policy\-get \- Get metric policy by ID
4
+ roark\-metric\-policy\-get \- Get a metric policy
5
5
  .SH "SYNOPSIS"
6
6
  .B roark metric policy get
7
7
  \fIpolicy\-id\fR [\fIoptions\fR]
@@ -1,7 +1,7 @@
1
1
  .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
2
  .TH "ROARK\-METRIC\-VARIANT\-LIST" "1" "" "roark-metric-variant-list" "Roark Analytics API Manual"
3
3
  .SH "NAME"
4
- roark\-metric\-variant\-list \- List a metric’s variants
4
+ roark\-metric\-variant\-list \- List a metric's variants
5
5
  .SH "SYNOPSIS"
6
6
  .B roark metric variant list
7
7
  \fIid\-or\-slug\fR [\fIoptions\fR]
@@ -22,7 +22,7 @@ Variant UUID.
22
22
  Rename the variant. Does not change its configuration, so `versionId` is unaffected. `Default` is reserved. Optional.
23
23
  .TP
24
24
  \fB\-\-llm\-prompt\fR \fI<value>\fR
25
- The rubric this variant applies. LLM judge metrics only. Optional.
25
+ The rubric this variant applies. LLM judge metrics only. A custom metric prompt must include a transcript variable such as `{{transcript}}` and `{{world_context}}`, which gives the judge the current date and time when it grades. Optional.
26
26
  .TP
27
27
  \fB\-\-scale\-min\fR \fI<value>\fR
28
28
  Scale minimum. SCALE output only. Optional.
@@ -1,7 +1,7 @@
1
1
  .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
2
  .TH "ROARK\-PROJECT\-LIST" "1" "" "roark-project-list" "Roark Analytics API Manual"
3
3
  .SH "NAME"
4
- roark\-project\-list \- List projects available to this credential
4
+ roark\-project\-list \- List accessible projects
5
5
  .SH "SYNOPSIS"
6
6
  .B roark project list
7
7
  [\fIoptions\fR]