@roarkanalytics/cli 0.73.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 (128) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/README.md +191 -148
  3. package/commands.js +2868 -944
  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-get.1 +1 -1
  18. package/man/roark-connections-agent-backfill-cancel.1 +96 -0
  19. package/man/roark-connections-agent-backfill-create.1 +97 -0
  20. package/man/roark-connections-agent-backfill-list.1 +93 -0
  21. package/man/roark-connections-agent-create.1 +124 -0
  22. package/man/roark-connections-agent-delete.1 +93 -0
  23. package/man/roark-connections-agent-discover.1 +96 -0
  24. package/man/roark-connections-agent-get.1 +93 -0
  25. package/man/roark-connections-agent-list.1 +93 -0
  26. package/man/roark-connections-agent-provider-list.1 +89 -0
  27. package/man/roark-connections-agent-update.1 +128 -0
  28. package/man/roark-connections-calendar-calendar-list.1 +93 -0
  29. package/man/roark-connections-calendar-calendly-oauth-start.1 +99 -0
  30. package/man/{roark-calendar-connection-check.1 → roark-connections-calendar-check.1} +5 -5
  31. package/man/{roark-calendar-connection-create.1 → roark-connections-calendar-create.1} +7 -7
  32. package/man/{roark-calendar-connection-delete.1 → roark-connections-calendar-delete.1} +5 -5
  33. package/man/{roark-calendar-connection-get.1 → roark-connections-calendar-get.1} +5 -5
  34. package/man/roark-connections-calendar-google-oauth-start.1 +102 -0
  35. package/man/{roark-calendar-connection-list.1 → roark-connections-calendar-list.1} +6 -6
  36. package/man/roark-connections-calendar-target-create.1 +124 -0
  37. package/man/roark-connections-calendar-target-delete.1 +96 -0
  38. package/man/{roark-calendar-connection-target-get.1 → roark-connections-calendar-target-get.1} +5 -5
  39. package/man/{roark-calendar-connection-target-list.1 → roark-connections-calendar-target-list.1} +5 -5
  40. package/man/roark-connections-calendar-target-update.1 +124 -0
  41. package/man/{roark-calendar-connection-update.1 → roark-connections-calendar-update.1} +5 -5
  42. package/man/roark-connections-mcp-server-create.1 +105 -0
  43. package/man/roark-connections-mcp-server-delete.1 +93 -0
  44. package/man/roark-connections-mcp-server-discover.1 +99 -0
  45. package/man/roark-connections-mcp-server-get.1 +93 -0
  46. package/man/roark-connections-mcp-server-list.1 +89 -0
  47. package/man/roark-connections-mcp-server-refresh.1 +93 -0
  48. package/man/roark-connections-mcp-server-update.1 +100 -0
  49. package/man/roark-conversation-get.1 +93 -0
  50. package/man/roark-credential-create.1 +2 -2
  51. package/man/roark-credential-list.1 +2 -2
  52. package/man/roark-credential-revoke.1 +2 -2
  53. package/man/{roark-customer-profile-attribute-delete.1 → roark-customer-attribute-delete.1} +5 -5
  54. package/man/{roark-customer-profile-attribute-unlock.1 → roark-customer-attribute-unlock.1} +5 -5
  55. package/man/{roark-customer-profile-attribute-update.1 → roark-customer-attribute-update.1} +5 -5
  56. package/man/{roark-customer-profile-conversation-list.1 → roark-customer-conversation-list.1} +5 -5
  57. package/man/{roark-customer-profile-delete.1 → roark-customer-delete.1} +6 -6
  58. package/man/roark-customer-field-create.1 +105 -0
  59. package/man/roark-customer-field-delete.1 +93 -0
  60. package/man/roark-customer-field-list.1 +89 -0
  61. package/man/roark-customer-field-update.1 +106 -0
  62. package/man/roark-customer-flow-edge-case-create.1 +1 -1
  63. package/man/roark-customer-flow-edge-case-update.1 +1 -1
  64. package/man/roark-customer-flow-folder-create.1 +99 -0
  65. package/man/roark-customer-flow-folder-delete.1 +93 -0
  66. package/man/roark-customer-flow-folder-list.1 +89 -0
  67. package/man/roark-customer-flow-get.1 +1 -1
  68. package/man/roark-customer-flow-happy-path-update.1 +1 -1
  69. package/man/roark-customer-flow-list.1 +3 -0
  70. package/man/roark-customer-flow-update.1 +4 -1
  71. package/man/{roark-customer-profile-get.1 → roark-customer-get.1} +6 -6
  72. package/man/{roark-customer-profile-list.1 → roark-customer-list.1} +8 -8
  73. package/man/{roark-customer-profile-notes-update.1 → roark-customer-notes-update.1} +5 -5
  74. package/man/roark-dashboard-list.1 +1 -1
  75. package/man/roark-dashboard-update.1 +1 -1
  76. package/man/roark-http-request-definition-create.1 +1 -1
  77. package/man/roark-http-request-definition-get.1 +1 -1
  78. package/man/roark-http-request-definition-update.1 +1 -1
  79. package/man/roark-metric-collection-job-get.1 +1 -1
  80. package/man/roark-metric-definition-create.1 +1 -1
  81. package/man/roark-metric-definition-update.1 +1 -1
  82. package/man/roark-metric-policy-create.1 +1 -1
  83. package/man/roark-metric-policy-get.1 +1 -1
  84. package/man/roark-metric-variant-list.1 +1 -1
  85. package/man/roark-metric-variant-update.1 +1 -1
  86. package/man/roark-project-list.1 +1 -1
  87. package/man/roark-simulation-environment-create.1 +12 -0
  88. package/man/roark-simulation-environment-get.1 +1 -1
  89. package/man/roark-simulation-environment-update.1 +12 -0
  90. package/man/roark-simulation-group-create.1 +2 -2
  91. package/man/roark-simulation-group-delete.1 +1 -1
  92. package/man/roark-simulation-group-get.1 +1 -1
  93. package/man/roark-simulation-group-list.1 +1 -1
  94. package/man/roark-simulation-group-run.1 +2 -2
  95. package/man/roark-simulation-group-update.1 +1 -1
  96. package/man/roark-simulation-job-get.1 +1 -1
  97. package/man/roark-simulation-job-lookup.1 +1 -1
  98. package/man/roark-simulation-persona-create.1 +1 -1
  99. package/man/roark-simulation-persona-get.1 +1 -1
  100. package/man/roark-simulation-persona-update.1 +1 -1
  101. package/man/roark-simulation-plan-get.1 +1 -1
  102. package/man/roark-simulation-plan-job-cancel.1 +1 -1
  103. package/man/roark-simulation-plan-job-cost-get.1 +1 -1
  104. package/man/roark-simulation-plan-job-debrief-create.1 +1 -1
  105. package/man/roark-simulation-plan-job-delete.1 +1 -1
  106. package/man/roark-simulation-plan-job-get.1 +1 -1
  107. package/man/roark-simulation-plan-job-list.1 +1 -1
  108. package/man/roark-simulation-plan-job-result-get.1 +1 -1
  109. package/man/roark-simulation-plan-update.1 +7 -1
  110. package/man/roark-simulation-resource-generate.1 +120 -0
  111. package/man/roark-simulation-resource-generation-answer.1 +97 -0
  112. package/man/roark-simulation-resource-generation-cancel.1 +93 -0
  113. package/man/roark-simulation-resource-generation-get.1 +93 -0
  114. package/man/roark-simulation-resource-generation-guidance-send.1 +97 -0
  115. package/man/roark-simulation-resource-generation-list.1 +96 -0
  116. package/man/roark-simulation-run-group-list.1 +1 -1
  117. package/man/roark-tool-create.1 +32 -2
  118. package/man/roark-tool-update.1 +32 -2
  119. package/man/roark-usage-get.1 +1 -1
  120. package/man/roark-webhook-create.1 +2 -2
  121. package/man/roark-webhook-delete.1 +1 -1
  122. package/man/roark-webhook-get.1 +1 -1
  123. package/man/roark-whoami.1 +1 -1
  124. package/man/roark.1 +208 -94
  125. package/npm-shrinkwrap.json +6 -6
  126. package/package.json +56 -18
  127. package/version.d.ts +1 -1
  128. 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\-CONNECTIONS\-MCP\-SERVER\-REFRESH" "1" "" "roark-connections-mcp-server-refresh" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-connections\-mcp\-server\-refresh \- Refresh an MCP server
5
+ .SH "SYNOPSIS"
6
+ .B roark connections mcp\-server refresh
7
+ \fIserver\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Connects to the server again and records the tools it offers now. Agents keep calling the tools they were given; a new tool reaches an agent only once you add it.
10
+ .SH "API"
11
+ POST /v1/connections/mcp\-server/{serverId}/refresh
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIserver\-id\fR
15
+ The server\-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 connections mcp\-server refresh <server\-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,100 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-CONNECTIONS\-MCP\-SERVER\-UPDATE" "1" "" "roark-connections-mcp-server-update" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-connections\-mcp\-server\-update \- Update an MCP server
5
+ .SH "SYNOPSIS"
6
+ .B roark connections mcp\-server update
7
+ \fIserver\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Renames the server or replaces its credential. A new credential is checked by connecting with it first; one the server refuses returns 400 and changes nothing.
10
+ .SH "API"
11
+ PATCH /v1/connections/mcp\-server/{serverId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIserver\-id\fR
15
+ The server\-id.
16
+ .SH "OPTIONS"
17
+ .TP
18
+ \fB\-\-label\fR \fI<value>\fR
19
+ Optional.
20
+ .TP
21
+ \fB\-\-auth\fR \fI<value>\fR
22
+ How the server authenticates. Stored encrypted; never returned. 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 connections mcp\-server update <server\-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\-CONVERSATION\-GET" "1" "" "roark-conversation-get" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-conversation\-get \- Get a conversation
5
+ .SH "SYNOPSIS"
6
+ .B roark conversation get
7
+ \fIconversation\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Fetches one conversation by its id, whether it is a call or a chat. The same endpoint reads both modalities, and `modality` in the response says which one it is, so you do not need to know it up front. A conversation started with `POST /v1/agent/{agentId}/conversations` reads back from the moment it is created, before it is recorded as a call or chat. For its transcript and metrics, use the call or chat endpoints that match its `modality`.
10
+ .SH "API"
11
+ GET /v1/conversation/{conversationId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIconversation\-id\fR
15
+ The conversation\-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 conversation get <conversation\-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)
@@ -1,12 +1,12 @@
1
1
  .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
2
  .TH "ROARK\-CREDENTIAL\-CREATE" "1" "" "roark-credential-create" "Roark Analytics API Manual"
3
3
  .SH "NAME"
4
- roark\-credential\-create \- Create a personal credential
4
+ roark\-credential\-create \- Create a personal API key
5
5
  .SH "SYNOPSIS"
6
6
  .B roark credential create
7
7
  [\fIoptions\fR]
8
8
  .SH "DESCRIPTION"
9
- Mints a credential that acts as you, for a CLI or an automation. The key value is returned exactly once, in the `key` field: capture it now, it is unreadable afterwards. Requires a personal credential (a project API key is refused) and admin on the project the credential defaults to. The new credential can never exceed the one that created it: not in scope, not in permissions, and not in lifetime. Omit a field to copy it from the calling credential.
9
+ Requires a personal API key (a project API key is refused) and admin on the project the new key defaults to. Mints a personal API key that acts as you, for a CLI or an automation. The key value is returned exactly once, in the `key` field: capture it now, it is unreadable afterwards. The new key can never exceed the one that created it: not in scope, not in permissions, and not in lifetime. Omit a field to copy it from the calling credential.
10
10
  .SH "API"
11
11
  POST /v1/me/api\-keys
12
12
  .SH "OPTIONS"
@@ -1,12 +1,12 @@
1
1
  .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
2
  .TH "ROARK\-CREDENTIAL\-LIST" "1" "" "roark-credential-list" "Roark Analytics API Manual"
3
3
  .SH "NAME"
4
- roark\-credential\-list \- List your personal credentials
4
+ roark\-credential\-list \- List personal API keys
5
5
  .SH "SYNOPSIS"
6
6
  .B roark credential list
7
7
  [\fIoptions\fR]
8
8
  .SH "DESCRIPTION"
9
- Returns the credentials that act as you: the ones created in the dashboard, from `roark auth login`, and MCP connectors. Requires a personal credential; a project API key is refused. Defaults to ACTIVE, pass ?status=REVOKED to see revoked ones. The key value itself is never returned.
9
+ Requires a personal API key; a project API key is refused. Returns the personal API keys that act as you: the ones created in the dashboard, from `roark auth login`, and MCP connectors. Defaults to ACTIVE, pass ?status=REVOKED to see revoked ones. The key value itself is never returned.
10
10
  .SH "API"
11
11
  GET /v1/me/api\-keys
12
12
  .SH "OPTIONS"
@@ -1,12 +1,12 @@
1
1
  .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
2
  .TH "ROARK\-CREDENTIAL\-REVOKE" "1" "" "roark-credential-revoke" "Roark Analytics API Manual"
3
3
  .SH "NAME"
4
- roark\-credential\-revoke \- Revoke one of your personal credentials
4
+ roark\-credential\-revoke \- Revoke a personal API key
5
5
  .SH "SYNOPSIS"
6
6
  .B roark credential revoke
7
7
  \fIcredential\-id\fR [\fIoptions\fR]
8
8
  .SH "DESCRIPTION"
9
- Revokes a credential that acts as you. It stops working immediately. A credential may revoke itself, which is what `roark auth logout` does. Repeating the call is safe; an unknown id, or one belonging to someone else, answers 404.
9
+ Requires a personal API key. Revokes one of your personal API keys; it stops working immediately. A key may revoke itself, which is what `roark auth logout` does. Repeating the call is safe; an unknown id, or one belonging to someone else, answers 404.
10
10
  .SH "API"
11
11
  DELETE /v1/me/api\-keys/{id}
12
12
  .SH "ARGUMENTS"
@@ -1,14 +1,14 @@
1
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"
2
+ .TH "ROARK\-CUSTOMER\-ATTRIBUTE\-DELETE" "1" "" "roark-customer-attribute-delete" "Roark Analytics API Manual"
3
3
  .SH "NAME"
4
- roark\-customer\-profile\-attribute\-delete \- Clear a customer profile field
4
+ roark\-customer\-attribute\-delete \- Clear a field on a customer
5
5
  .SH "SYNOPSIS"
6
- .B roark customer\-profile attribute delete
6
+ .B roark customer attribute delete
7
7
  \fIcustomer\-profile\-id\fR \fIkey\fR [\fIoptions\fR]
8
8
  .SH "DESCRIPTION"
9
9
  Removes the value and any lock, so a later conversation can fill it again.
10
10
  .SH "API"
11
- DELETE /v1/customer\-profile/{customerProfileId}/attributes/{key}
11
+ DELETE /v1/customer/{customerProfileId}/attributes/{key}
12
12
  .SH "ARGUMENTS"
13
13
  .TP
14
14
  \fIcustomer\-profile\-id\fR
@@ -57,7 +57,7 @@ Send the stored credential to a base URL set by a project .roark.json. Refused b
57
57
  .PP
58
58
  .RS 4
59
59
  .nf
60
- roark customer\-profile attribute delete <customer\-profile\-id> <key>
60
+ roark customer attribute delete <customer\-profile\-id> <key>
61
61
  .fi
62
62
  .RE
63
63
  .SH "ENVIRONMENT"
@@ -1,14 +1,14 @@
1
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"
2
+ .TH "ROARK\-CUSTOMER\-ATTRIBUTE\-UNLOCK" "1" "" "roark-customer-attribute-unlock" "Roark Analytics API Manual"
3
3
  .SH "NAME"
4
- roark\-customer\-profile\-attribute\-unlock \- Unlock a customer profile field
4
+ roark\-customer\-attribute\-unlock \- Unlock a field on a customer
5
5
  .SH "SYNOPSIS"
6
- .B roark customer\-profile attribute unlock
6
+ .B roark customer attribute unlock
7
7
  \fIcustomer\-profile\-id\fR \fIkey\fR [\fIoptions\fR]
8
8
  .SH "DESCRIPTION"
9
9
  Lets newer conversations change this field again. The current value stays until one does.
10
10
  .SH "API"
11
- POST /v1/customer\-profile/{customerProfileId}/attributes/{key}/unlock
11
+ POST /v1/customer/{customerProfileId}/attributes/{key}/unlock
12
12
  .SH "ARGUMENTS"
13
13
  .TP
14
14
  \fIcustomer\-profile\-id\fR
@@ -57,7 +57,7 @@ Send the stored credential to a base URL set by a project .roark.json. Refused b
57
57
  .PP
58
58
  .RS 4
59
59
  .nf
60
- roark customer\-profile attribute unlock <customer\-profile\-id> <key>
60
+ roark customer attribute unlock <customer\-profile\-id> <key>
61
61
  .fi
62
62
  .RE
63
63
  .SH "ENVIRONMENT"
@@ -1,14 +1,14 @@
1
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"
2
+ .TH "ROARK\-CUSTOMER\-ATTRIBUTE\-UPDATE" "1" "" "roark-customer-attribute-update" "Roark Analytics API Manual"
3
3
  .SH "NAME"
4
- roark\-customer\-profile\-attribute\-update \- Set a customer profile field
4
+ roark\-customer\-attribute\-update \- Set a field on a customer
5
5
  .SH "SYNOPSIS"
6
- .B roark customer\-profile attribute update
6
+ .B roark customer attribute update
7
7
  \fIcustomer\-profile\-id\fR \fIkey\fR [\fIoptions\fR]
8
8
  .SH "DESCRIPTION"
9
9
  Sets the value and locks the field, so newer conversations cannot change it.
10
10
  .SH "API"
11
- PUT /v1/customer\-profile/{customerProfileId}/attributes/{key}
11
+ PUT /v1/customer/{customerProfileId}/attributes/{key}
12
12
  .SH "ARGUMENTS"
13
13
  .TP
14
14
  \fIcustomer\-profile\-id\fR
@@ -61,7 +61,7 @@ Send the stored credential to a base URL set by a project .roark.json. Refused b
61
61
  .PP
62
62
  .RS 4
63
63
  .nf
64
- roark customer\-profile attribute update <customer\-profile\-id> <key> \-\-value <value>
64
+ roark customer attribute update <customer\-profile\-id> <key> \-\-value <value>
65
65
  .fi
66
66
  .RE
67
67
  .SH "ENVIRONMENT"
@@ -1,14 +1,14 @@
1
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"
2
+ .TH "ROARK\-CUSTOMER\-CONVERSATION\-LIST" "1" "" "roark-customer-conversation-list" "Roark Analytics API Manual"
3
3
  .SH "NAME"
4
- roark\-customer\-profile\-conversation\-list \- List a customer's conversations
4
+ roark\-customer\-conversation\-list \- List a customer's conversations
5
5
  .SH "SYNOPSIS"
6
- .B roark customer\-profile conversation list
6
+ .B roark customer conversation list
7
7
  \fIcustomer\-profile\-id\fR [\fIoptions\fR]
8
8
  .SH "DESCRIPTION"
9
9
  Calls and chats with this customer, newest first.
10
10
  .SH "API"
11
- GET /v1/customer\-profile/{customerProfileId}/conversations
11
+ GET /v1/customer/{customerProfileId}/conversations
12
12
  .SH "ARGUMENTS"
13
13
  .TP
14
14
  \fIcustomer\-profile\-id\fR
@@ -61,7 +61,7 @@ Send the stored credential to a base URL set by a project .roark.json. Refused b
61
61
  .PP
62
62
  .RS 4
63
63
  .nf
64
- roark customer\-profile conversation list <customer\-profile\-id>
64
+ roark customer conversation list <customer\-profile\-id>
65
65
  .fi
66
66
  .RE
67
67
  .SH "ENVIRONMENT"
@@ -1,14 +1,14 @@
1
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"
2
+ .TH "ROARK\-CUSTOMER\-DELETE" "1" "" "roark-customer-delete" "Roark Analytics API Manual"
3
3
  .SH "NAME"
4
- roark\-customer\-profile\-delete \- Erase a customer profile
4
+ roark\-customer\-delete \- Erase a customer
5
5
  .SH "SYNOPSIS"
6
- .B roark customer\-profile delete
6
+ .B roark customer delete
7
7
  \fIcustomer\-profile\-id\fR [\fIoptions\fR]
8
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.
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
10
  .SH "API"
11
- DELETE /v1/customer\-profile/{customerProfileId}
11
+ DELETE /v1/customer/{customerProfileId}
12
12
  .SH "ARGUMENTS"
13
13
  .TP
14
14
  \fIcustomer\-profile\-id\fR
@@ -54,7 +54,7 @@ Send the stored credential to a base URL set by a project .roark.json. Refused b
54
54
  .PP
55
55
  .RS 4
56
56
  .nf
57
- roark customer\-profile delete <customer\-profile\-id>
57
+ roark customer delete <customer\-profile\-id>
58
58
  .fi
59
59
  .RE
60
60
  .SH "ENVIRONMENT"
@@ -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)