@roarkanalytics/cli 0.57.0 → 0.59.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\-AGENT\-VERSION\-LIST" "1" "" "roark-agent-version-list" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-agent\-version\-list \- List an agent's versions
5
+ .SH "SYNOPSIS"
6
+ .B roark agent version list
7
+ \fIagent\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ The open draft first, if there is one, then published versions newest first. Paginated: pass `pagination.nextCursor` as `after` for the next page.
10
+ .SH "API"
11
+ GET /v1/agent/{agentId}/versions
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIagent\-id\fR
15
+ The agent\-id.
16
+ .SH "OPTIONS"
17
+ .TP
18
+ \fB\-\-limit\fR \fI<value>\fR
19
+ Optional.
20
+ .TP
21
+ \fB\-\-after\fR \fI<value>\fR
22
+ 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 agent version list <agent\-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,103 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-AGENT\-VERSION\-RESTORE" "1" "" "roark-agent-version-restore" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-agent\-version\-restore \- Restore an agent version
5
+ .SH "SYNOPSIS"
6
+ .B roark agent version restore
7
+ \fIagent\-id\fR \fIversion\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Roll back: publishes a new version, numbered after the latest, with this version's settings and makes it live. History stays append\-only. An open draft started before this is kept but can no longer be published (409 `agent_draft_base_changed`); discard it or start a new one. Pass `expectedLiveVersionId` to be refused (409 `agent_live_version_changed`) if another version went live since you read it.
10
+ .SH "API"
11
+ POST /v1/agent/{agentId}/versions/{versionId}/restore
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIagent\-id\fR
15
+ The agent\-id.
16
+ .TP
17
+ \fIversion\-id\fR
18
+ The version\-id.
19
+ .SH "OPTIONS"
20
+ .TP
21
+ \fB\-\-summary\fR \fI<value>\fR
22
+ Optional.
23
+ .TP
24
+ \fB\-\-expected\-live\-version\-id\fR \fI<value>\fR
25
+ The live version when you decided to restore. When sent, the restore is refused with 409 if another version went live since. Optional.
26
+ .SH "GLOBAL OPTIONS"
27
+ .TP
28
+ \fB\-\-data\fR \fI<json>\fR
29
+ Request body as JSON, or @file to read one (@\- for stdin).
30
+ .TP
31
+ \fB\-y\fR, \fB\-\-yes\fR
32
+ Skip confirmation prompts.
33
+ .TP
34
+ \fB\-\-no\-input\fR
35
+ Never prompt; fail instead.
36
+ .TP
37
+ \fB\-\-base\-url\fR \fI<url>\fR
38
+ API base URL.
39
+ .TP
40
+ \fB\-\-token\fR \fI<token>\fR
41
+ Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
42
+ .TP
43
+ \fB\-\-timeout\fR \fI<ms>\fR
44
+ Request timeout in milliseconds.
45
+ .TP
46
+ \fB\-\-max\-retries\fR \fI<count>\fR
47
+ Retries for retryable failures.
48
+ .TP
49
+ \fB\-\-format\fR \fI<format>\fR
50
+ Output format: auto, json, jsonl, plain.
51
+ .TP
52
+ \fB\-\-json\fR
53
+ Shorthand for \-\-format json.
54
+ .TP
55
+ \fB\-\-no\-color\fR
56
+ Disable colour.
57
+ .TP
58
+ \fB\-q\fR, \fB\-\-quiet\fR
59
+ Suppress non\-essential output.
60
+ .TP
61
+ \fB\-\-allow\-project\-base\-url\fR
62
+ Send the stored credential to a base URL set by a project .roark.json. Refused by default.
63
+ .SH "EXAMPLES"
64
+ .PP
65
+ .RS 4
66
+ .nf
67
+ roark agent version restore <agent\-id> <version\-id>
68
+ .fi
69
+ .RE
70
+ .SH "ENVIRONMENT"
71
+ .TP
72
+ \fBROARK_API_BEARER_TOKEN\fR
73
+ Bearer token used when \-\-token is not given.
74
+ .TP
75
+ \fBROARK_BASE_URL\fR
76
+ API base URL.
77
+ .TP
78
+ \fBROARK_ALLOW_PROJECT_BASE_URL\fR
79
+ Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
80
+ .TP
81
+ \fBNO_COLOR\fR
82
+ Disables colour when set to any value.
83
+ .SH "EXIT STATUS"
84
+ .TP
85
+ \fB0\fR
86
+ The command succeeded.
87
+ .TP
88
+ \fB1\fR
89
+ The API rejected the request.
90
+ .TP
91
+ \fB2\fR
92
+ The command line was wrong.
93
+ .TP
94
+ \fB3\fR
95
+ No credential, or the credential was refused.
96
+ .TP
97
+ \fB4\fR
98
+ The addressed resource does not exist.
99
+ .TP
100
+ \fB5\fR
101
+ The request never completed: connection, timeout, or abort.
102
+ .SH "SEE ALSO"
103
+ .BR roark (1)
@@ -6,19 +6,25 @@ roark\-phone\-number\-available\-list \- Search available phone numbers
6
6
  .B roark phone\-number available list
7
7
  [\fIoptions\fR]
8
8
  .SH "DESCRIPTION"
9
- Returns US numbers the carrier has for sale, narrowed by area code or by digits the number must contain. Buy one with POST /v1/phone\-number.
9
+ Returns US or Canadian numbers the carrier has for sale, local or toll\-free, narrowed by area code or by digits the number must contain. When an area code has no numbers, nearby ones are returned flagged bestEffort; an empty list means nothing matched. Buy one with POST /v1/phone\-number, or let Roark pick with autoPick.
10
10
  .SH "API"
11
11
  GET /v1/phone\-number/available
12
12
  .SH "OPTIONS"
13
13
  .TP
14
+ \fB\-\-country\fR \fI<value>\fR
15
+ ISO 3166\-1 alpha\-2 country of the number: US or CA One of: US, CA. Optional.
16
+ .TP
17
+ \fB\-\-number\-type\fR \fI<value>\fR
18
+ LOCAL for a number in an area code, TOLL_FREE for one from the shared US and Canada toll\-free pool One of: LOCAL, TOLL_FREE. Optional.
19
+ .TP
14
20
  \fB\-\-area\-code\fR \fI<value>\fR
15
- Three\-digit US area code Optional.
21
+ Three\-digit area code, or a toll\-free prefix such as 800. When it has no numbers, nearby ones are returned instead, flagged bestEffort. Optional.
16
22
  .TP
17
23
  \fB\-\-contains\fR \fI<value>\fR
18
24
  Digits or letters the number must contain (1 to 7, * matches any digit) Optional.
19
25
  .TP
20
26
  \fB\-\-limit\fR \fI<value>\fR
21
- Maximum number of results (default: 20, max: 50) Optional.
27
+ Maximum number of results (default: 20, max: 100) Optional.
22
28
  .SH "GLOBAL OPTIONS"
23
29
  .TP
24
30
  \fB\-\-data\fR \fI<json>\fR
@@ -6,13 +6,31 @@ roark\-phone\-number\-create \- Buy a phone number
6
6
  .B roark phone\-number create
7
7
  [\fIoptions\fR]
8
8
  .SH "DESCRIPTION"
9
- Buys a number from the carrier for this project. Free inside the plan allowance; past it, the first month of rent is charged now and monthly after that.
9
+ Buys a number from the carrier for this project: the one named by e164, or one Roark picks to match autoPick (trying the next match if the carrier has just sold one). Free inside the plan allowance; past it, the first month of rent is charged now and monthly after that.
10
10
  .SH "API"
11
11
  POST /v1/phone\-number
12
12
  .SH "OPTIONS"
13
13
  .TP
14
14
  \fB\-\-e164\fR \fI<value>\fR
15
- The number to buy, in E.164 format, from a search result Required.
15
+ The number to buy, in E.164 format, from a search result. Give this or autoPick. Optional.
16
+ .TP
17
+ \fB\-\-auto\-pick\fR \fI<value>\fR
18
+ What the number Roark picks should look like. Roark buys the first matching number the carrier will sell, preferring the area code and falling back to a nearby one. Optional.
19
+ .TP
20
+ \fB\-\-auto\-pick.country\fR \fI<value>\fR
21
+ ISO 3166\-1 alpha\-2 country of the number: US or CA One of: US, CA. Optional.
22
+ .TP
23
+ \fB\-\-auto\-pick.number\-type\fR \fI<value>\fR
24
+ LOCAL for a number in an area code, TOLL_FREE for one from the shared US and Canada toll\-free pool One of: LOCAL, TOLL_FREE. Optional.
25
+ .TP
26
+ \fB\-\-auto\-pick.area\-code\fR \fI<value>\fR
27
+ Three\-digit area code, or a toll\-free prefix such as 800. When it has no numbers, nearby ones are returned instead, flagged bestEffort. Optional.
28
+ .TP
29
+ \fB\-\-auto\-pick.contains\fR \fI<value>\fR
30
+ Digits or letters the number must contain (1 to 7, * matches any digit) Optional.
31
+ .TP
32
+ \fB\-\-country\fR \fI<value>\fR
33
+ The country of the number given by e164 (default: US). An auto\-picked number uses autoPick.country. One of: US, CA. Optional.
16
34
  .TP
17
35
  \fB\-\-name\fR \fI<value>\fR
18
36
  A label for the number Optional.
@@ -66,7 +84,7 @@ Send the stored credential to a base URL set by a project .roark.json. Refused b
66
84
  .PP
67
85
  .RS 4
68
86
  .nf
69
- roark phone\-number create \-\-e164 <value>
87
+ roark phone\-number create
70
88
  .fi
71
89
  .RE
72
90
  .SH "ENVIRONMENT"
package/man/roark.1 CHANGED
@@ -66,6 +66,21 @@ Build a Roark\-hosted agent See roark\-agent\-build(1).
66
66
  \fBroark agent create\fR
67
67
  Create a new agent See roark\-agent\-create(1).
68
68
  .TP
69
+ \fBroark agent draft create\fR
70
+ Start a draft See roark\-agent\-draft\-create(1).
71
+ .TP
72
+ \fBroark agent draft delete\fR
73
+ Discard the draft See roark\-agent\-draft\-delete(1).
74
+ .TP
75
+ \fBroark agent draft get\fR
76
+ Get an agent's draft See roark\-agent\-draft\-get(1).
77
+ .TP
78
+ \fBroark agent draft publish\fR
79
+ Publish the draft See roark\-agent\-draft\-publish(1).
80
+ .TP
81
+ \fBroark agent draft update\fR
82
+ Edit the draft See roark\-agent\-draft\-update(1).
83
+ .TP
69
84
  \fBroark agent endpoint create\fR
70
85
  Create a new agent endpoint See roark\-agent\-endpoint\-create(1).
71
86
  .TP
@@ -96,6 +111,15 @@ List a prompt's versions See roark\-agent\-prompt\-version\-list(1).
96
111
  \fBroark agent update\fR
97
112
  Update an agent See roark\-agent\-update(1).
98
113
  .TP
114
+ \fBroark agent version get\fR
115
+ Get an agent version See roark\-agent\-version\-get(1).
116
+ .TP
117
+ \fBroark agent version list\fR
118
+ List an agent's versions See roark\-agent\-version\-list(1).
119
+ .TP
120
+ \fBroark agent version restore\fR
121
+ Restore an agent version See roark\-agent\-version\-restore(1).
122
+ .TP
99
123
  \fBroark agent\-config get\fR
100
124
  Get a managed config See roark\-agent\-config\-get(1).
101
125
  .TP
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@roarkanalytics/cli",
3
- "version": "0.57.0",
3
+ "version": "0.59.0",
4
4
  "lockfileVersion": 3,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "@roarkanalytics/cli",
9
- "version": "0.57.0",
9
+ "version": "0.59.0",
10
10
  "license": "Apache-2.0",
11
11
  "dependencies": {
12
12
  "@roarkanalytics/sdk": "^5.17.0",
@@ -22,9 +22,9 @@
22
22
  }
23
23
  },
24
24
  "node_modules/@roarkanalytics/sdk": {
25
- "version": "5.17.0",
26
- "resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-5.17.0.tgz",
27
- "integrity": "sha512-9M6Gq11b/ZArWV5KDIm7NNN2GhXLsctPdn/dFfm5UMhzf8Bup6OsBZKOeXfSlAm+nVnxX+HiToulANP4UhR36w==",
25
+ "version": "5.22.0",
26
+ "resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-5.22.0.tgz",
27
+ "integrity": "sha512-KzujXZZZD4Wsjek8EweWYTXRWdKb2UMK84y37OZCOfU8bbCvgzIqpXMxow6GHFNFlbNpC+aKtOfeVLOhdGEA7g==",
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.57.0",
3
+ "version": "0.59.0",
4
4
  "description": "The official command line interface for the Roark API",
5
5
  "author": "Roark <james@roark.ai>",
6
6
  "type": "commonjs",
@@ -38,6 +38,11 @@
38
38
  "./man/roark.1",
39
39
  "./man/roark-agent-build.1",
40
40
  "./man/roark-agent-create.1",
41
+ "./man/roark-agent-draft-create.1",
42
+ "./man/roark-agent-draft-delete.1",
43
+ "./man/roark-agent-draft-get.1",
44
+ "./man/roark-agent-draft-publish.1",
45
+ "./man/roark-agent-draft-update.1",
41
46
  "./man/roark-agent-endpoint-create.1",
42
47
  "./man/roark-agent-endpoint-get.1",
43
48
  "./man/roark-agent-endpoint-list.1",
@@ -48,6 +53,9 @@
48
53
  "./man/roark-agent-prompt-update.1",
49
54
  "./man/roark-agent-prompt-version-list.1",
50
55
  "./man/roark-agent-update.1",
56
+ "./man/roark-agent-version-get.1",
57
+ "./man/roark-agent-version-list.1",
58
+ "./man/roark-agent-version-restore.1",
51
59
  "./man/roark-agent-config-get.1",
52
60
  "./man/roark-agent-config-list.1",
53
61
  "./man/roark-agent-config-promote.1",
package/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const version = "0.57.0";
1
+ export declare const version = "0.59.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.57.0'; // x-release-please-version
13
+ exports.version = '0.59.0'; // x-release-please-version