@roarkanalytics/cli 0.43.0 → 0.45.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.
@@ -0,0 +1,100 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-CALL\-PROPERTY\-UPDATE" "1" "" "roark-call-property-update" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-call\-property\-update \- Update the properties of a call
5
+ .SH "SYNOPSIS"
6
+ .B roark call property update
7
+ \fIcall\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Add, overwrite or remove custom properties on an already\-existing call. Use this for data that becomes available after the call was created, e.g. an outcome your system validates a few minutes later. Merge semantics: a value adds or overwrites the property, null removes it, and properties left out are untouched. The patch is applied whole or not at all: a property Roark sets itself, or a value whose type differs from the type the project already stores that property as, rejects the request with a 400 and nothing is written. A 409 means another request created one of the properties with a different value type at the same moment; nothing was written. Optionally pass `metrics` to (re)score metrics over the updated properties, which triggers a billed metric collection job and requires the `metric:create` permission.
10
+ .SH "API"
11
+ PATCH /v1/call/{callId}/properties
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIcall\-id\fR
15
+ The call\-id.
16
+ .SH "OPTIONS"
17
+ .TP
18
+ \fB\-\-properties\fR \fI<value>\fR
19
+ Properties to change on the call. A string, number or boolean value adds the property or overwrites it; null removes it. Properties left out are untouched. Keys are stored in snake_case, as on POST /v1/call. A property keeps the value type it was first stored with in the project, so a value of another type is rejected. Properties Roark sets itself (direction, duration_seconds, agent_id, ...) can't be changed. Max 100 per request. Required.
20
+ .TP
21
+ \fB\-\-metrics\fR \fI<value>\fR
22
+ Optional. Metric definitions to (re)score on this call once the properties are written, e.g. metrics that read the call's properties. Triggers a metric collection job (billed, credit\-gated) and requires the 'metric:create' permission. Omit to update properties without scoring. Max 20. 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 call property update <call\-id> \-\-properties <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)
@@ -6,7 +6,7 @@ roark\-metric\-collection\-job\-create \- Create and run a metric collection job
6
6
  .B roark metric collection\-job create
7
7
  [\fIoptions\fR]
8
8
  .SH "DESCRIPTION"
9
- Creates a metric collection job for the specified calls or chats and metrics, then triggers processing. Provide exactly one of callIds or chatIds.
9
+ Creates a metric collection job for the specified calls or chats and metrics, then triggers processing. Provide exactly one of callIds or chatIds. Pass policyId to score with a metric policy’s settings (for example to re\-score past calls after changing which properties Property Verification checks); metrics then defaults to every metric that policy collects.
10
10
  .SH "API"
11
11
  POST /v1/metric/collection\-jobs
12
12
  .SH "OPTIONS"
@@ -18,7 +18,10 @@ Call IDs to collect metrics for. Mutually exclusive with chatIds. Max 500 per re
18
18
  Chat IDs to collect metrics for. Mutually exclusive with callIds. Max 500 per request. Repeatable. Optional.
19
19
  .TP
20
20
  \fB\-\-metrics\fR \fI<value>\fR
21
- Metric definitions to collect. Max 20 per request. Required.
21
+ Metric definitions to collect. Max 20 per request. Required unless policyId is given; with policyId, defaults to every metric that policy collects, and each one listed must be in it. Optional.
22
+ .TP
23
+ \fB\-\-policy\-id\fR \fI<value>\fR
24
+ Optional. A metric policy (collector) whose settings to score with: each metric runs at the version that policy runs it at, with its per\-collector setting (such as the properties Property Verification checks), instead of the metric's default. A metric the policy runs at its default runs at its default here too. The policy's conditions are not applied: the listed conversations are scored as given. Use it to re\-score past conversations after changing a policy's settings. Optional.
22
25
  .SH "GLOBAL OPTIONS"
23
26
  .TP
24
27
  \fB\-\-data\fR \fI<json>\fR
@@ -60,7 +63,7 @@ Send the stored credential to a base URL set by a project .roark.json. Refused b
60
63
  .PP
61
64
  .RS 4
62
65
  .nf
63
- roark metric collection\-job create \-\-metrics <value>
66
+ roark metric collection\-job create
64
67
  .fi
65
68
  .RE
66
69
  .SH "ENVIRONMENT"
package/man/roark.1 CHANGED
@@ -168,6 +168,9 @@ List calls See roark\-call\-list(1).
168
168
  \fBroark call metric list\fR
169
169
  List call metrics See roark\-call\-metric\-list(1).
170
170
  .TP
171
+ \fBroark call property update\fR
172
+ Update the properties of a call See roark\-call\-property\-update(1).
173
+ .TP
171
174
  \fBroark call sentiment\-run list\fR
172
175
  List call sentiment runs See roark\-call\-sentiment\-run\-list(1).
173
176
  .TP
@@ -1,15 +1,15 @@
1
1
  {
2
2
  "name": "@roarkanalytics/cli",
3
- "version": "0.43.0",
3
+ "version": "0.45.0",
4
4
  "lockfileVersion": 3,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "@roarkanalytics/cli",
9
- "version": "0.43.0",
9
+ "version": "0.45.0",
10
10
  "license": "Apache-2.0",
11
11
  "dependencies": {
12
- "@roarkanalytics/sdk": "^5.4.0",
12
+ "@roarkanalytics/sdk": "^5.6.0",
13
13
  "commander": "^14.0.3",
14
14
  "yaml": "^2.9.0"
15
15
  },
@@ -21,9 +21,9 @@
21
21
  }
22
22
  },
23
23
  "node_modules/@roarkanalytics/sdk": {
24
- "version": "5.4.0",
25
- "resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-5.4.0.tgz",
26
- "integrity": "sha512-RUjr6qV7HMsIdO11cp/+qcXRGCdzuTIs4bE4Vz0EDm2aqM/pAtUl5ussad64c6yp+bDGLb2ecJQZDeVRuUEZbQ==",
24
+ "version": "5.6.0",
25
+ "resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-5.6.0.tgz",
26
+ "integrity": "sha512-+RwPaOCmFKNzhVgUbu90kzZJMFSNLPqwnXmfYeP5KkZd12pWNMM549WIEaeZ5vIZeyfhw+Y2lZpX4obib+UWBQ==",
27
27
  "license": "Apache-2.0"
28
28
  },
29
29
  "node_modules/commander": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@roarkanalytics/cli",
3
- "version": "0.43.0",
3
+ "version": "0.45.0",
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": "^5.4.0",
32
+ "@roarkanalytics/sdk": "^5.6.0",
33
33
  "commander": "^14.0.3",
34
34
  "yaml": "^2.9.0"
35
35
  },
@@ -71,6 +71,7 @@
71
71
  "./man/roark-call-get.1",
72
72
  "./man/roark-call-list.1",
73
73
  "./man/roark-call-metric-list.1",
74
+ "./man/roark-call-property-update.1",
74
75
  "./man/roark-call-sentiment-run-list.1",
75
76
  "./man/roark-call-tool-invocation-append.1",
76
77
  "./man/roark-call-transcript-get.1",
package/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const version = "0.43.0";
1
+ export declare const version = "0.45.0";
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.43.0'; // x-release-please-version
13
+ exports.version = '0.45.0'; // x-release-please-version