@roarkanalytics/cli 0.55.0 → 0.56.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.
@@ -20,6 +20,9 @@ Requires calculationType, name, outputType, formula, sources.
20
20
  .TP
21
21
  \fBPatternMetricInput\fR
22
22
  Requires calculationType, name, operation, outcome.
23
+ .TP
24
+ \fBHttpRequestMetricInput\fR
25
+ Requires calculationType, name, httpRequest.
23
26
  .SH "GLOBAL OPTIONS"
24
27
  .TP
25
28
  \fB\-\-data\fR \fI<json>\fR
@@ -54,6 +54,21 @@ New formula expression (FORMULA only). Pass `sources` alongside if the reference
54
54
  \fB\-\-sources\fR \fI<value>\fR
55
55
  Replacement formula sources, required when `formula` changes the referenced metrics (FORMULA only). Optional.
56
56
  .TP
57
+ \fB\-\-http\-request\fR \fI<value>\fR
58
+ Replacement request (HTTP_REQUEST only). Send the whole request; omitted headers are removed. Optional.
59
+ .TP
60
+ \fB\-\-http\-request.url\fR \fI<value>\fR
61
+ Public http(s) URL. May contain {{path}} placeholders into the request payload, which are URL\-encoded. Required.
62
+ .TP
63
+ \fB\-\-http\-request.method\fR \fI<value>\fR
64
+ GET or POST (default POST). A GET request has no body. One of: GET, POST. Optional.
65
+ .TP
66
+ \fB\-\-http\-request.headers\fR \fI<value>\fR
67
+ Request headers, for example your own Authorization header. Values may contain placeholders. Optional.
68
+ .TP
69
+ \fB\-\-http\-request.body\fR \fI<value>\fR
70
+ A JSON template with {{path}} placeholders into the request payload, such as {"cardId": "{{call.properties.cardId}}"}. Omit or pass null to send the default payload. Optional.
71
+ .TP
57
72
  \fB\-\-change\-reason\fR \fI<value>\fR
58
73
  Optional free\-text audit note recorded on the new version. Optional.
59
74
  .TP
@@ -130,7 +145,7 @@ Send the stored credential to a base URL set by a project .roark.json. Refused b
130
145
  .PP
131
146
  .RS 4
132
147
  .nf
133
- roark metric definition update <id\-or\-slug>
148
+ roark metric definition update <id\-or\-slug> \-\-http\-request.url <value>
134
149
  .fi
135
150
  .RE
136
151
  .SH "ENVIRONMENT"
@@ -0,0 +1,89 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-PHONE\-NUMBER\-ALLOWANCE\-GET" "1" "" "roark-phone-number-allowance-get" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-phone\-number\-allowance\-get \- Get the phone number allowance
5
+ .SH "SYNOPSIS"
6
+ .B roark phone\-number allowance get
7
+ [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Returns how many numbers the organization gets for free, how many it holds, what a paid number costs a month, and whether a purchase would be admitted right now.
10
+ .SH "API"
11
+ GET /v1/phone\-number/allowance
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 phone\-number allowance get
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)
@@ -0,0 +1,99 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-PHONE\-NUMBER\-AVAILABLE\-LIST" "1" "" "roark-phone-number-available-list" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-phone\-number\-available\-list \- Search available phone numbers
5
+ .SH "SYNOPSIS"
6
+ .B roark phone\-number available list
7
+ [\fIoptions\fR]
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.
10
+ .SH "API"
11
+ GET /v1/phone\-number/available
12
+ .SH "OPTIONS"
13
+ .TP
14
+ \fB\-\-area\-code\fR \fI<value>\fR
15
+ Three\-digit US area code Optional.
16
+ .TP
17
+ \fB\-\-contains\fR \fI<value>\fR
18
+ Digits or letters the number must contain (1 to 7, * matches any digit) Optional.
19
+ .TP
20
+ \fB\-\-limit\fR \fI<value>\fR
21
+ Maximum number of results (default: 20, max: 50) Optional.
22
+ .SH "GLOBAL OPTIONS"
23
+ .TP
24
+ \fB\-\-data\fR \fI<json>\fR
25
+ Request body as JSON, or @file to read one (@\- for stdin).
26
+ .TP
27
+ \fB\-y\fR, \fB\-\-yes\fR
28
+ Skip confirmation prompts.
29
+ .TP
30
+ \fB\-\-no\-input\fR
31
+ Never prompt; fail instead.
32
+ .TP
33
+ \fB\-\-base\-url\fR \fI<url>\fR
34
+ API base URL.
35
+ .TP
36
+ \fB\-\-token\fR \fI<token>\fR
37
+ Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
38
+ .TP
39
+ \fB\-\-timeout\fR \fI<ms>\fR
40
+ Request timeout in milliseconds.
41
+ .TP
42
+ \fB\-\-max\-retries\fR \fI<count>\fR
43
+ Retries for retryable failures.
44
+ .TP
45
+ \fB\-\-format\fR \fI<format>\fR
46
+ Output format: auto, json, jsonl, plain.
47
+ .TP
48
+ \fB\-\-json\fR
49
+ Shorthand for \-\-format json.
50
+ .TP
51
+ \fB\-\-no\-color\fR
52
+ Disable colour.
53
+ .TP
54
+ \fB\-q\fR, \fB\-\-quiet\fR
55
+ Suppress non\-essential output.
56
+ .TP
57
+ \fB\-\-allow\-project\-base\-url\fR
58
+ Send the stored credential to a base URL set by a project .roark.json. Refused by default.
59
+ .SH "EXAMPLES"
60
+ .PP
61
+ .RS 4
62
+ .nf
63
+ roark phone\-number available list
64
+ .fi
65
+ .RE
66
+ .SH "ENVIRONMENT"
67
+ .TP
68
+ \fBROARK_API_BEARER_TOKEN\fR
69
+ Bearer token used when \-\-token is not given.
70
+ .TP
71
+ \fBROARK_BASE_URL\fR
72
+ API base URL.
73
+ .TP
74
+ \fBROARK_ALLOW_PROJECT_BASE_URL\fR
75
+ Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
76
+ .TP
77
+ \fBNO_COLOR\fR
78
+ Disables colour when set to any value.
79
+ .SH "EXIT STATUS"
80
+ .TP
81
+ \fB0\fR
82
+ The command succeeded.
83
+ .TP
84
+ \fB1\fR
85
+ The API rejected the request.
86
+ .TP
87
+ \fB2\fR
88
+ The command line was wrong.
89
+ .TP
90
+ \fB3\fR
91
+ No credential, or the credential was refused.
92
+ .TP
93
+ \fB4\fR
94
+ The addressed resource does not exist.
95
+ .TP
96
+ \fB5\fR
97
+ The request never completed: connection, timeout, or abort.
98
+ .SH "SEE ALSO"
99
+ .BR roark (1)
@@ -0,0 +1,105 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-PHONE\-NUMBER\-CREATE" "1" "" "roark-phone-number-create" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-phone\-number\-create \- Buy a phone number
5
+ .SH "SYNOPSIS"
6
+ .B roark phone\-number create
7
+ [\fIoptions\fR]
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.
10
+ .SH "API"
11
+ POST /v1/phone\-number
12
+ .SH "OPTIONS"
13
+ .TP
14
+ \fB\-\-e164\fR \fI<value>\fR
15
+ The number to buy, in E.164 format, from a search result Required.
16
+ .TP
17
+ \fB\-\-name\fR \fI<value>\fR
18
+ A label for the number Optional.
19
+ .TP
20
+ \fB\-\-agent\-id\fR \fI<value>\fR
21
+ The agent to assign the number to Optional.
22
+ .TP
23
+ \fB\-\-expect\-free\fR
24
+ Whether you expect this number to be free (from the allowance). The purchase is refused with 409 if that has changed since you checked. Optional.
25
+ .TP
26
+ \fB\-\-expect\-monthly\-rent\-micros\fR \fI<value>\fR
27
+ The monthly rent you expect for a paid number, in micros (from the allowance). The purchase is refused with 409 if that has changed since you checked. Optional.
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 phone\-number create \-\-e164 <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\-PHONE\-NUMBER\-DELETE" "1" "" "roark-phone-number-delete" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-phone\-number\-delete \- Release a phone number
5
+ .SH "SYNOPSIS"
6
+ .B roark phone\-number delete
7
+ \fIphone\-number\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Gives the number back to the carrier. This cannot be undone: rent stops today and nothing is refunded.
10
+ .SH "API"
11
+ DELETE /v1/phone\-number/{phoneNumberId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIphone\-number\-id\fR
15
+ The phone\-number\-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 phone\-number delete <phone\-number\-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,93 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-PHONE\-NUMBER\-LIST" "1" "" "roark-phone-number-list" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-phone\-number\-list \- List phone numbers
5
+ .SH "SYNOPSIS"
6
+ .B roark phone\-number list
7
+ [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Returns the phone numbers the project owns, oldest first, with the agent each is assigned to.
10
+ .SH "API"
11
+ GET /v1/phone\-number
12
+ .SH "OPTIONS"
13
+ .TP
14
+ \fB\-\-agent\-id\fR \fI<value>\fR
15
+ Only the numbers assigned to this agent Optional.
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 phone\-number list
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\-PHONE\-NUMBER\-UPDATE" "1" "" "roark-phone-number-update" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-phone\-number\-update \- Update a phone number
5
+ .SH "SYNOPSIS"
6
+ .B roark phone\-number update
7
+ \fIphone\-number\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Relabels a number or changes which agent it is assigned to. A field left out is untouched; null clears it.
10
+ .SH "API"
11
+ PUT /v1/phone\-number/{phoneNumberId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIphone\-number\-id\fR
15
+ The phone\-number\-id.
16
+ .SH "OPTIONS"
17
+ .TP
18
+ \fB\-\-name\fR \fI<value>\fR
19
+ New label; null clears it, omit to leave it alone Optional.
20
+ .TP
21
+ \fB\-\-agent\-id\fR \fI<value>\fR
22
+ Agent to assign the number to; null unassigns, omit to leave it alone 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 phone\-number update <phone\-number\-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)
package/man/roark.1 CHANGED
@@ -342,6 +342,24 @@ List a metric’s variants See roark\-metric\-variant\-list(1).
342
342
  \fBroark metric variant update\fR
343
343
  Update a metric variant See roark\-metric\-variant\-update(1).
344
344
  .TP
345
+ \fBroark phone\-number allowance get\fR
346
+ Get the phone number allowance See roark\-phone\-number\-allowance\-get(1).
347
+ .TP
348
+ \fBroark phone\-number available list\fR
349
+ Search available phone numbers See roark\-phone\-number\-available\-list(1).
350
+ .TP
351
+ \fBroark phone\-number create\fR
352
+ Buy a phone number See roark\-phone\-number\-create(1).
353
+ .TP
354
+ \fBroark phone\-number delete\fR
355
+ Release a phone number See roark\-phone\-number\-delete(1).
356
+ .TP
357
+ \fBroark phone\-number list\fR
358
+ List phone numbers See roark\-phone\-number\-list(1).
359
+ .TP
360
+ \fBroark phone\-number update\fR
361
+ Update a phone number See roark\-phone\-number\-update(1).
362
+ .TP
345
363
  \fBroark project list\fR
346
364
  List projects available to this credential See roark\-project\-list(1).
347
365
  .TP
@@ -1,15 +1,15 @@
1
1
  {
2
2
  "name": "@roarkanalytics/cli",
3
- "version": "0.55.0",
3
+ "version": "0.56.1",
4
4
  "lockfileVersion": 3,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "@roarkanalytics/cli",
9
- "version": "0.55.0",
9
+ "version": "0.56.1",
10
10
  "license": "Apache-2.0",
11
11
  "dependencies": {
12
- "@roarkanalytics/sdk": "^5.12.0",
12
+ "@roarkanalytics/sdk": "^5.17.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": "5.15.0",
26
- "resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-5.15.0.tgz",
27
- "integrity": "sha512-RcnicH7VpjGYH7dlHHuMerPeQGydAY0rcDVLkPUhKklpzs4X3tATbBTAlvLSvZIUA3jlUEZ+qegFlRtRFzepPw==",
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==",
28
28
  "license": "Apache-2.0"
29
29
  },
30
30
  "node_modules/commander": {