@roarkanalytics/cli 0.68.0 → 0.70.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.
@@ -15,7 +15,7 @@ POST /v1/agent/endpoint
15
15
  Agent ID to associate this endpoint with Required.
16
16
  .TP
17
17
  \fB\-\-value\fR \fI<value>\fR
18
- Phone number in E.164 format (e.g., +12345678900) Required.
18
+ Phone number in E.164 format (e.g., +12345678900). Optional when direction is OUTGOING, for an agent that calls from numbers you do not know up front. Optional.
19
19
  .TP
20
20
  \fB\-\-environment\fR \fI<value>\fR
21
21
  Environment name (default: production) Optional.
@@ -69,7 +69,7 @@ Send the stored credential to a base URL set by a project .roark.json. Refused b
69
69
  .PP
70
70
  .RS 4
71
71
  .nf
72
- roark agent endpoint create \-\-agent\-id <value> \-\-value <value> \-\-direction <value>
72
+ roark agent endpoint create \-\-agent\-id <value> \-\-direction <value>
73
73
  .fi
74
74
  .RE
75
75
  .SH "ENVIRONMENT"
@@ -37,7 +37,7 @@ New label for the true case (BOOLEAN output only) Optional.
37
37
  New label for the false case (BOOLEAN output only) Optional.
38
38
  .TP
39
39
  \fB\-\-grades\-short\-calls\fR
40
- Score this metric on a simulated call with fewer than 4 transcript lines. Such calls skip every other metric. Default false. Optional.
40
+ Score this metric on a simulated call with fewer than 4 transcript lines or where your agent never spoke (custom metrics only, not ones that judge the audio). Such calls skip every other metric. Default false. Optional.
41
41
  .TP
42
42
  \fB\-\-classification\-options\fR \fI<value>\fR
43
43
  Replacement set of classification options (CLASSIFICATION output only) Optional.
@@ -37,7 +37,7 @@ What a `true` value means. Given to the judge as its polarity rule, so keep it a
37
37
  What a `false` value means. Given to the judge as its polarity rule, so keep it accurate. Optional.
38
38
  .TP
39
39
  \fB\-\-grades\-short\-calls\fR
40
- Score this metric on a simulated call with fewer than 4 transcript lines. Such calls skip every other metric. Default false. Optional.
40
+ Score this metric on a simulated call with fewer than 4 transcript lines or where your agent never spoke (custom metrics only, not ones that judge the audio). Such calls skip every other metric. Default false. Optional.
41
41
  .TP
42
42
  \fB\-\-max\-classifications\fR \fI<value>\fR
43
43
  Maximum classifications returned. CLASSIFICATION output only. Optional.
@@ -0,0 +1,89 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-SIMULATION\-AUDIO\-CLIP\-LIST" "1" "" "roark-simulation-audio-clip-list" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-simulation\-audio\-clip\-list \- List audio clips
5
+ .SH "SYNOPSIS"
6
+ .B roark simulation audio\-clip list
7
+ [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Returns the audio a CUSTOMER_AUDIO step can play: hold music, hold tones and ringback. Name one as the step's `audioClip`. A fixed catalogue, so it is not paginated.
10
+ .SH "API"
11
+ GET /v1/simulation/audio\-clip
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 simulation audio\-clip 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)
package/man/roark.1 CHANGED
@@ -435,6 +435,9 @@ Update a phone number See roark\-phone\-number\-update(1).
435
435
  \fBroark project list\fR
436
436
  List projects available to this credential See roark\-project\-list(1).
437
437
  .TP
438
+ \fBroark simulation audio\-clip list\fR
439
+ List audio clips See roark\-simulation\-audio\-clip\-list(1).
440
+ .TP
438
441
  \fBroark simulation environment create\fR
439
442
  Create an environment See roark\-simulation\-environment\-create(1).
440
443
  .TP
@@ -1,15 +1,15 @@
1
1
  {
2
2
  "name": "@roarkanalytics/cli",
3
- "version": "0.68.0",
3
+ "version": "0.70.1",
4
4
  "lockfileVersion": 3,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "@roarkanalytics/cli",
9
- "version": "0.68.0",
9
+ "version": "0.70.1",
10
10
  "license": "Apache-2.0",
11
11
  "dependencies": {
12
- "@roarkanalytics/sdk": "^7.0.0",
12
+ "@roarkanalytics/sdk": "^7.3.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.0.0",
26
- "resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-7.0.0.tgz",
27
- "integrity": "sha512-/sTFJcJPj426aSvJZQd5+fk04d4V0ugjOyEVO95PvWaoTrIJffor9Y+yYyNTXlWvogi/iVaXv/w2oDUa4jtVeA==",
25
+ "version": "7.3.0",
26
+ "resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-7.3.0.tgz",
27
+ "integrity": "sha512-Ie/6qkOpxQ7Paie0G2tDv3MOm6+1zgpXV7FR5k7CY+dq9a7/ZyJholQfe/yhNcUlstPlGZmlksb8aON8hCvIPg==",
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.68.0",
3
+ "version": "0.70.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.0.0",
32
+ "@roarkanalytics/sdk": "^7.3.0",
33
33
  "commander": "^14.0.3",
34
34
  "jiti": "^2.4.2",
35
35
  "yaml": "^2.9.0"
@@ -161,6 +161,7 @@
161
161
  "./man/roark-phone-number-list.1",
162
162
  "./man/roark-phone-number-update.1",
163
163
  "./man/roark-project-list.1",
164
+ "./man/roark-simulation-audio-clip-list.1",
164
165
  "./man/roark-simulation-environment-create.1",
165
166
  "./man/roark-simulation-environment-delete.1",
166
167
  "./man/roark-simulation-environment-get.1",
@@ -30,11 +30,19 @@ const listAgents = async (client) => {
30
30
  return undefined;
31
31
  }
32
32
  };
33
- /** The agent's lines, or undefined when they could not be read: that is not the same as none. */
33
+ /**
34
+ * The agent's dialable lines, or undefined when they could not be read: that is not the same as
35
+ * none.
36
+ *
37
+ * An endpoint whose value is null is left out. That is an outbound phone endpoint with no fixed
38
+ * calling number - a real endpoint, but not a line a run can dial - and both things this step
39
+ * does with the list need the number: the plan names it, and the picker labels the choice with
40
+ * it. Offering a blank row would put an endpoint in front of you that nothing can call.
41
+ */
34
42
  const listEndpoints = async (client, agentId) => {
35
43
  try {
36
44
  const response = await client.agentEndpoint.list({ agentId, limit: ENDPOINT_PAGE });
37
- return response.data.map((endpoint) => ({ value: endpoint.value, direction: endpoint.direction }));
45
+ return response.data.flatMap((endpoint) => endpoint.value === null ? [] : [{ value: endpoint.value, direction: endpoint.direction }]);
38
46
  }
39
47
  catch {
40
48
  return undefined;
@@ -81,7 +89,11 @@ const chooseAgent = async (client, prompter, say, binaryName, color) => {
81
89
  return base;
82
90
  }
83
91
  if (endpoints.length === 0) {
84
- say((0, ladder_1.note)(`That agent has no endpoint yet, so there is no line to call. Add one, then run \`${binaryName} get-started\` again to finish.`, color, 'yellow'));
92
+ say((0, ladder_1.note)(
93
+ // Not "it has no endpoint": it may have one whose value is null, which is an endpoint
94
+ // without a number to call. Either way the way on is the same, and naming the number
95
+ // rather than the endpoint is true in both.
96
+ `That agent has no number to call yet, so there is no line to dial. Add an endpoint with one, then run \`${binaryName} get-started\` again to finish.`, color, 'yellow'));
85
97
  return base;
86
98
  }
87
99
  if (endpoints.length === 1)
package/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const version = "0.68.0";
1
+ export declare const version = "0.70.1";
package/version.js CHANGED
@@ -10,4 +10,4 @@ exports.version = void 0;
10
10
  //
11
11
  // Do not edit: an edit here is overwritten, and the published number is whatever
12
12
  // package.json says.
13
- exports.version = '0.68.0'; // x-release-please-version
13
+ exports.version = '0.70.1'; // x-release-please-version