@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.
- package/CHANGELOG.md +11 -0
- package/README.md +191 -148
- package/commands.js +2868 -944
- package/completions.js +4 -4
- package/man/roark-agent-build.1 +3 -3
- package/man/roark-agent-conversation-create.1 +106 -0
- package/man/roark-agent-create.1 +27 -3
- package/man/roark-agent-draft-update.1 +4 -1
- package/man/roark-agent-endpoint-create.1 +5 -5
- package/man/roark-agent-endpoint-get.1 +1 -1
- package/man/roark-agent-get.1 +1 -1
- package/man/roark-autoimprove-job-cancel.1 +1 -1
- package/man/roark-autoimprove-job-dismiss.1 +1 -1
- package/man/roark-autoimprove-job-guidance-send.1 +1 -1
- package/man/roark-autoimprove-job-promote.1 +1 -1
- package/man/roark-benchmark-target-history-list.1 +1 -1
- package/man/roark-call-get.1 +1 -1
- package/man/roark-connections-agent-backfill-cancel.1 +96 -0
- package/man/roark-connections-agent-backfill-create.1 +97 -0
- package/man/roark-connections-agent-backfill-list.1 +93 -0
- package/man/roark-connections-agent-create.1 +124 -0
- package/man/roark-connections-agent-delete.1 +93 -0
- package/man/roark-connections-agent-discover.1 +96 -0
- package/man/roark-connections-agent-get.1 +93 -0
- package/man/roark-connections-agent-list.1 +93 -0
- package/man/roark-connections-agent-provider-list.1 +89 -0
- package/man/roark-connections-agent-update.1 +128 -0
- package/man/roark-connections-calendar-calendar-list.1 +93 -0
- package/man/roark-connections-calendar-calendly-oauth-start.1 +99 -0
- package/man/{roark-calendar-connection-check.1 → roark-connections-calendar-check.1} +5 -5
- package/man/{roark-calendar-connection-create.1 → roark-connections-calendar-create.1} +7 -7
- package/man/{roark-calendar-connection-delete.1 → roark-connections-calendar-delete.1} +5 -5
- package/man/{roark-calendar-connection-get.1 → roark-connections-calendar-get.1} +5 -5
- package/man/roark-connections-calendar-google-oauth-start.1 +102 -0
- package/man/{roark-calendar-connection-list.1 → roark-connections-calendar-list.1} +6 -6
- package/man/roark-connections-calendar-target-create.1 +124 -0
- package/man/roark-connections-calendar-target-delete.1 +96 -0
- package/man/{roark-calendar-connection-target-get.1 → roark-connections-calendar-target-get.1} +5 -5
- package/man/{roark-calendar-connection-target-list.1 → roark-connections-calendar-target-list.1} +5 -5
- package/man/roark-connections-calendar-target-update.1 +124 -0
- package/man/{roark-calendar-connection-update.1 → roark-connections-calendar-update.1} +5 -5
- package/man/roark-connections-mcp-server-create.1 +105 -0
- package/man/roark-connections-mcp-server-delete.1 +93 -0
- package/man/roark-connections-mcp-server-discover.1 +99 -0
- package/man/roark-connections-mcp-server-get.1 +93 -0
- package/man/roark-connections-mcp-server-list.1 +89 -0
- package/man/roark-connections-mcp-server-refresh.1 +93 -0
- package/man/roark-connections-mcp-server-update.1 +100 -0
- package/man/roark-conversation-get.1 +93 -0
- package/man/roark-credential-create.1 +2 -2
- package/man/roark-credential-list.1 +2 -2
- package/man/roark-credential-revoke.1 +2 -2
- package/man/{roark-customer-profile-attribute-delete.1 → roark-customer-attribute-delete.1} +5 -5
- package/man/{roark-customer-profile-attribute-unlock.1 → roark-customer-attribute-unlock.1} +5 -5
- package/man/{roark-customer-profile-attribute-update.1 → roark-customer-attribute-update.1} +5 -5
- package/man/{roark-customer-profile-conversation-list.1 → roark-customer-conversation-list.1} +5 -5
- package/man/{roark-customer-profile-delete.1 → roark-customer-delete.1} +6 -6
- package/man/roark-customer-field-create.1 +105 -0
- package/man/roark-customer-field-delete.1 +93 -0
- package/man/roark-customer-field-list.1 +89 -0
- package/man/roark-customer-field-update.1 +106 -0
- package/man/roark-customer-flow-edge-case-create.1 +1 -1
- package/man/roark-customer-flow-edge-case-update.1 +1 -1
- package/man/roark-customer-flow-folder-create.1 +99 -0
- package/man/roark-customer-flow-folder-delete.1 +93 -0
- package/man/roark-customer-flow-folder-list.1 +89 -0
- package/man/roark-customer-flow-get.1 +1 -1
- package/man/roark-customer-flow-happy-path-update.1 +1 -1
- package/man/roark-customer-flow-list.1 +3 -0
- package/man/roark-customer-flow-update.1 +4 -1
- package/man/{roark-customer-profile-get.1 → roark-customer-get.1} +6 -6
- package/man/{roark-customer-profile-list.1 → roark-customer-list.1} +8 -8
- package/man/{roark-customer-profile-notes-update.1 → roark-customer-notes-update.1} +5 -5
- package/man/roark-dashboard-list.1 +1 -1
- package/man/roark-dashboard-update.1 +1 -1
- package/man/roark-http-request-definition-create.1 +1 -1
- package/man/roark-http-request-definition-get.1 +1 -1
- package/man/roark-http-request-definition-update.1 +1 -1
- package/man/roark-metric-collection-job-get.1 +1 -1
- package/man/roark-metric-definition-create.1 +1 -1
- package/man/roark-metric-definition-update.1 +1 -1
- package/man/roark-metric-policy-create.1 +1 -1
- package/man/roark-metric-policy-get.1 +1 -1
- package/man/roark-metric-variant-list.1 +1 -1
- package/man/roark-metric-variant-update.1 +1 -1
- package/man/roark-project-list.1 +1 -1
- package/man/roark-simulation-environment-create.1 +12 -0
- package/man/roark-simulation-environment-get.1 +1 -1
- package/man/roark-simulation-environment-update.1 +12 -0
- package/man/roark-simulation-group-create.1 +2 -2
- package/man/roark-simulation-group-delete.1 +1 -1
- package/man/roark-simulation-group-get.1 +1 -1
- package/man/roark-simulation-group-list.1 +1 -1
- package/man/roark-simulation-group-run.1 +2 -2
- package/man/roark-simulation-group-update.1 +1 -1
- package/man/roark-simulation-job-get.1 +1 -1
- package/man/roark-simulation-job-lookup.1 +1 -1
- package/man/roark-simulation-persona-create.1 +1 -1
- package/man/roark-simulation-persona-get.1 +1 -1
- package/man/roark-simulation-persona-update.1 +1 -1
- package/man/roark-simulation-plan-get.1 +1 -1
- package/man/roark-simulation-plan-job-cancel.1 +1 -1
- package/man/roark-simulation-plan-job-cost-get.1 +1 -1
- package/man/roark-simulation-plan-job-debrief-create.1 +1 -1
- package/man/roark-simulation-plan-job-delete.1 +1 -1
- package/man/roark-simulation-plan-job-get.1 +1 -1
- package/man/roark-simulation-plan-job-list.1 +1 -1
- package/man/roark-simulation-plan-job-result-get.1 +1 -1
- package/man/roark-simulation-plan-update.1 +7 -1
- package/man/roark-simulation-resource-generate.1 +120 -0
- package/man/roark-simulation-resource-generation-answer.1 +97 -0
- package/man/roark-simulation-resource-generation-cancel.1 +93 -0
- package/man/roark-simulation-resource-generation-get.1 +93 -0
- package/man/roark-simulation-resource-generation-guidance-send.1 +97 -0
- package/man/roark-simulation-resource-generation-list.1 +96 -0
- package/man/roark-simulation-run-group-list.1 +1 -1
- package/man/roark-tool-create.1 +32 -2
- package/man/roark-tool-update.1 +32 -2
- package/man/roark-usage-get.1 +1 -1
- package/man/roark-webhook-create.1 +2 -2
- package/man/roark-webhook-delete.1 +1 -1
- package/man/roark-webhook-get.1 +1 -1
- package/man/roark-whoami.1 +1 -1
- package/man/roark.1 +208 -94
- package/npm-shrinkwrap.json +6 -6
- package/package.json +56 -18
- package/version.d.ts +1 -1
- 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\-CALENDAR\-CALENDAR\-LIST" "1" "" "roark-connections-calendar-calendar-list" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-connections\-calendar\-calendar\-list \- List calendars for bookable targets
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark connections calendar calendar list
|
|
7
|
+
\fIconnection\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Only for a connection whose `capabilities.roarkOwnsBookingPolicy` is true: on a scheduling system the bookable things already exist and `GET /targets` returns them. Calendars the account can only read are left out rather than listed and refused: one would answer availability perfectly well and then fail the booking, mid\-call, with a caller on the line.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/connections/calendar/{connectionId}/calendars
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIconnection\-id\fR
|
|
15
|
+
Calendar connection 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 calendar calendar list <connection\-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,99 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CONNECTIONS\-CALENDAR\-CALENDLY\-OAUTH\-START" "1" "" "roark-connections-calendar-calendly-oauth-start" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-connections\-calendar\-calendly\-oauth\-start \- Start connecting a Calendly account
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark connections calendar calendly\-oauth start
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Returns a URL to open in a browser. Calendly has no credential a request body can carry, so connecting one is two steps: ask for this URL, let the customer consent, and Roark finishes the rest server\-side (it exchanges the code, verifies the credential, reads the account’s own timezone when none was given, and stores the connection). Nothing is created until the customer consents, and a link that is not used expires. Read the result with `GET /v1/connections/calendar?provider=CALENDLY`.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/connections/calendar/calendly/authorize\-url
|
|
12
|
+
.SH "OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-calendar\-connection\-id\fR \fI<value>\fR
|
|
15
|
+
Reconnect an existing connection instead of creating one: the consent screen replaces that connection’s credential in place, so every tool bound to it keeps working. Use this when a connection reports `INVALID_CREDENTIALS`. The connection’s existing name and timezone are kept, so `label` is ignored when this is set. Optional.
|
|
16
|
+
.TP
|
|
17
|
+
\fB\-\-label\fR \fI<value>\fR
|
|
18
|
+
Customer\-facing name for the connection, unique within the project. Required unless `calendarConnectionId` is set, and decided now because the consent screen has nowhere to carry it. Optional.
|
|
19
|
+
.TP
|
|
20
|
+
\fB\-\-timezone\fR \fI<value>\fR
|
|
21
|
+
The named IANA timezone to offer slots in, for example `America/Los_Angeles`. Omit to adopt the Calendly account’s own. A fixed offset such as `\-08:00` is rejected: it does not observe DST. 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 connections calendar calendly\-oauth start
|
|
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)
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
-
.TH "ROARK\-CALENDAR\-
|
|
2
|
+
.TH "ROARK\-CONNECTIONS\-CALENDAR\-CHECK" "1" "" "roark-connections-calendar-check" "Roark Analytics API Manual"
|
|
3
3
|
.SH "NAME"
|
|
4
|
-
roark\-calendar\-
|
|
4
|
+
roark\-connections\-calendar\-check \- Check a calendar connection
|
|
5
5
|
.SH "SYNOPSIS"
|
|
6
|
-
.B roark calendar
|
|
6
|
+
.B roark connections calendar check
|
|
7
7
|
\fIconnection\-id\fR [\fIoptions\fR]
|
|
8
8
|
.SH "DESCRIPTION"
|
|
9
9
|
Re\-verifies the stored credential against the provider and records the result on the connection. A credential the provider rejects sets `status` to INVALID_CREDENTIALS. A provider outage is a 500 and leaves the status untouched: being unable to reach the provider is not evidence that the customer’s credential is bad.
|
|
10
10
|
.SH "API"
|
|
11
|
-
POST /v1/calendar
|
|
11
|
+
POST /v1/connections/calendar/{connectionId}/check
|
|
12
12
|
.SH "ARGUMENTS"
|
|
13
13
|
.TP
|
|
14
14
|
\fIconnection\-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 calendar
|
|
57
|
+
roark connections calendar check <connection\-id>
|
|
58
58
|
.fi
|
|
59
59
|
.RE
|
|
60
60
|
.SH "ENVIRONMENT"
|
|
@@ -1,24 +1,24 @@
|
|
|
1
1
|
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
-
.TH "ROARK\-CALENDAR\-
|
|
2
|
+
.TH "ROARK\-CONNECTIONS\-CALENDAR\-CREATE" "1" "" "roark-connections-calendar-create" "Roark Analytics API Manual"
|
|
3
3
|
.SH "NAME"
|
|
4
|
-
roark\-calendar\-
|
|
4
|
+
roark\-connections\-calendar\-create \- Connect a calendar account
|
|
5
5
|
.SH "SYNOPSIS"
|
|
6
|
-
.B roark calendar
|
|
6
|
+
.B roark connections calendar create
|
|
7
7
|
[\fIoptions\fR]
|
|
8
8
|
.SH "DESCRIPTION"
|
|
9
9
|
Verifies the credential against the provider and, only if it works, stores it encrypted. A credential the provider rejects is a 400 and no connection is created: a connection that has never worked would next be exercised by an inbound call at 2am, with nobody there to fix it.
|
|
10
10
|
.SH "API"
|
|
11
|
-
POST /v1/calendar
|
|
11
|
+
POST /v1/connections/calendar
|
|
12
12
|
.SH "OPTIONS"
|
|
13
13
|
.TP
|
|
14
14
|
\fB\-\-provider\fR \fI<value>\fR
|
|
15
|
-
Who holds the calendar. CAL_COM is
|
|
15
|
+
Who holds the calendar. CAL_COM is connected with an API key; GOOGLE and CALENDLY are connected by consent, through `POST /v1/connections/calendar/google/authorize\-url` and `POST /v1/connections/calendar/calendly/authorize\-url`. One of: CAL_COM, GOOGLE, CALENDLY. Required.
|
|
16
16
|
.TP
|
|
17
17
|
\fB\-\-label\fR \fI<value>\fR
|
|
18
18
|
Customer\-facing name for this account, unique within the project. Required. Required.
|
|
19
19
|
.TP
|
|
20
20
|
\fB\-\-api\-key\fR \fI<value>\fR
|
|
21
|
-
For CAL_COM
|
|
21
|
+
The provider account’s API key. For CAL_COM, a Cal.com API key (starts with `cal_`). It is verified against the provider before anything is stored, so an invalid key is a 400 and no connection is created. Stored encrypted and never returned. Required.
|
|
22
22
|
.TP
|
|
23
23
|
\fB\-\-timezone\fR \fI<value>\fR
|
|
24
24
|
The named IANA timezone to offer slots in, for example `America/Los_Angeles`. Omit to adopt the provider account’s own timezone. A fixed offset such as `\-08:00` is rejected: it does not observe DST. Optional.
|
|
@@ -63,7 +63,7 @@ Send the stored credential to a base URL set by a project .roark.json. Refused b
|
|
|
63
63
|
.PP
|
|
64
64
|
.RS 4
|
|
65
65
|
.nf
|
|
66
|
-
roark calendar
|
|
66
|
+
roark connections calendar create \-\-provider <value> \-\-label <value> \-\-api\-key <value>
|
|
67
67
|
.fi
|
|
68
68
|
.RE
|
|
69
69
|
.SH "ENVIRONMENT"
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
-
.TH "ROARK\-CALENDAR\-
|
|
2
|
+
.TH "ROARK\-CONNECTIONS\-CALENDAR\-DELETE" "1" "" "roark-connections-calendar-delete" "Roark Analytics API Manual"
|
|
3
3
|
.SH "NAME"
|
|
4
|
-
roark\-calendar\-
|
|
4
|
+
roark\-connections\-calendar\-delete \- Delete a calendar connection
|
|
5
5
|
.SH "SYNOPSIS"
|
|
6
|
-
.B roark calendar
|
|
6
|
+
.B roark connections calendar delete
|
|
7
7
|
\fIconnection\-id\fR [\fIoptions\fR]
|
|
8
8
|
.SH "DESCRIPTION"
|
|
9
9
|
Disconnects the calendar and destroys the stored credential. A credential the customer deleted should stop existing, so this is not an archive. Appointments already recorded against the connection are kept, so a booking stays explainable after the calendar is disconnected. Refused with a 409 while a calendar tool is still bound to the connection, naming the tools: point them at another calendar, or delete them, first. A dangling binding would otherwise be found by whoever next tried to ship the agent, who is not the person who disconnected the calendar.
|
|
10
10
|
.SH "API"
|
|
11
|
-
DELETE /v1/calendar
|
|
11
|
+
DELETE /v1/connections/calendar/{connectionId}
|
|
12
12
|
.SH "ARGUMENTS"
|
|
13
13
|
.TP
|
|
14
14
|
\fIconnection\-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 calendar
|
|
57
|
+
roark connections calendar delete <connection\-id>
|
|
58
58
|
.fi
|
|
59
59
|
.RE
|
|
60
60
|
.SH "ENVIRONMENT"
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
-
.TH "ROARK\-CALENDAR\-
|
|
2
|
+
.TH "ROARK\-CONNECTIONS\-CALENDAR\-GET" "1" "" "roark-connections-calendar-get" "Roark Analytics API Manual"
|
|
3
3
|
.SH "NAME"
|
|
4
|
-
roark\-calendar\-
|
|
4
|
+
roark\-connections\-calendar\-get \- Get a calendar connection
|
|
5
5
|
.SH "SYNOPSIS"
|
|
6
|
-
.B roark calendar
|
|
6
|
+
.B roark connections calendar get
|
|
7
7
|
\fIconnection\-id\fR [\fIoptions\fR]
|
|
8
8
|
.SH "DESCRIPTION"
|
|
9
9
|
Returns one calendar connection. The stored credential is never included.
|
|
10
10
|
.SH "API"
|
|
11
|
-
GET /v1/calendar
|
|
11
|
+
GET /v1/connections/calendar/{connectionId}
|
|
12
12
|
.SH "ARGUMENTS"
|
|
13
13
|
.TP
|
|
14
14
|
\fIconnection\-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 calendar
|
|
57
|
+
roark connections calendar get <connection\-id>
|
|
58
58
|
.fi
|
|
59
59
|
.RE
|
|
60
60
|
.SH "ENVIRONMENT"
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CONNECTIONS\-CALENDAR\-GOOGLE\-OAUTH\-START" "1" "" "roark-connections-calendar-google-oauth-start" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-connections\-calendar\-google\-oauth\-start \- Start connecting a Google Calendar
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark connections calendar google\-oauth start
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Returns a URL to open in a browser. Google has no credential a request body can carry, so connecting one is two steps: ask for this URL, let the customer consent, and Roark finishes the rest server\-side (it exchanges the code, verifies that both calendar permissions were granted, reads the account’s own timezone when none was given, and stores the connection). Nothing is created until the customer consents, and a link that is not used expires. Read the result with `GET /v1/connections/calendar?provider=GOOGLE`.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/connections/calendar/google/authorize\-url
|
|
12
|
+
.SH "OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-calendar\-connection\-id\fR \fI<value>\fR
|
|
15
|
+
Reconnect an existing connection instead of creating one: the consent screen replaces that connection’s credential in place, so every tool bound to it keeps working. Use this when a connection reports `INVALID_CREDENTIALS`. The connection’s existing name and timezone are kept, so `label` is ignored when this is set. Optional.
|
|
16
|
+
.TP
|
|
17
|
+
\fB\-\-label\fR \fI<value>\fR
|
|
18
|
+
Customer\-facing name for the connection, unique within the project. Required unless `calendarConnectionId` is set, and decided now because the consent screen has nowhere to carry it. Optional.
|
|
19
|
+
.TP
|
|
20
|
+
\fB\-\-timezone\fR \fI<value>\fR
|
|
21
|
+
The named IANA timezone to offer slots in, for example `America/Los_Angeles`. Omit to adopt the Google account’s own. A fixed offset such as `\-08:00` is rejected: it does not observe DST. Optional.
|
|
22
|
+
.TP
|
|
23
|
+
\fB\-\-login\-hint\fR \fI<value>\fR
|
|
24
|
+
The Google account to preselect on the consent screen. A hint only: it is ignored if the user is signed into another account, and nothing is authorized by it. Optional.
|
|
25
|
+
.SH "GLOBAL OPTIONS"
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
28
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
31
|
+
Skip confirmation prompts.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-no\-input\fR
|
|
34
|
+
Never prompt; fail instead.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
37
|
+
API base URL.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
40
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
43
|
+
Request timeout in milliseconds.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
46
|
+
Retries for retryable failures.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
49
|
+
Output format: auto, json, jsonl, plain.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-\-json\fR
|
|
52
|
+
Shorthand for \-\-format json.
|
|
53
|
+
.TP
|
|
54
|
+
\fB\-\-no\-color\fR
|
|
55
|
+
Disable colour.
|
|
56
|
+
.TP
|
|
57
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
58
|
+
Suppress non\-essential output.
|
|
59
|
+
.TP
|
|
60
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
61
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
62
|
+
.SH "EXAMPLES"
|
|
63
|
+
.PP
|
|
64
|
+
.RS 4
|
|
65
|
+
.nf
|
|
66
|
+
roark connections calendar google\-oauth start
|
|
67
|
+
.fi
|
|
68
|
+
.RE
|
|
69
|
+
.SH "ENVIRONMENT"
|
|
70
|
+
.TP
|
|
71
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
72
|
+
Bearer token used when \-\-token is not given.
|
|
73
|
+
.TP
|
|
74
|
+
\fBROARK_BASE_URL\fR
|
|
75
|
+
API base URL.
|
|
76
|
+
.TP
|
|
77
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
78
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
79
|
+
.TP
|
|
80
|
+
\fBNO_COLOR\fR
|
|
81
|
+
Disables colour when set to any value.
|
|
82
|
+
.SH "EXIT STATUS"
|
|
83
|
+
.TP
|
|
84
|
+
\fB0\fR
|
|
85
|
+
The command succeeded.
|
|
86
|
+
.TP
|
|
87
|
+
\fB1\fR
|
|
88
|
+
The API rejected the request.
|
|
89
|
+
.TP
|
|
90
|
+
\fB2\fR
|
|
91
|
+
The command line was wrong.
|
|
92
|
+
.TP
|
|
93
|
+
\fB3\fR
|
|
94
|
+
No credential, or the credential was refused.
|
|
95
|
+
.TP
|
|
96
|
+
\fB4\fR
|
|
97
|
+
The addressed resource does not exist.
|
|
98
|
+
.TP
|
|
99
|
+
\fB5\fR
|
|
100
|
+
The request never completed: connection, timeout, or abort.
|
|
101
|
+
.SH "SEE ALSO"
|
|
102
|
+
.BR roark (1)
|
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
-
.TH "ROARK\-CALENDAR\-
|
|
2
|
+
.TH "ROARK\-CONNECTIONS\-CALENDAR\-LIST" "1" "" "roark-connections-calendar-list" "Roark Analytics API Manual"
|
|
3
3
|
.SH "NAME"
|
|
4
|
-
roark\-calendar\-
|
|
4
|
+
roark\-connections\-calendar\-list \- List calendar connections
|
|
5
5
|
.SH "SYNOPSIS"
|
|
6
|
-
.B roark calendar
|
|
6
|
+
.B roark connections calendar list
|
|
7
7
|
[\fIoptions\fR]
|
|
8
8
|
.SH "DESCRIPTION"
|
|
9
9
|
Returns every calendar connection in the authenticated project, by label. A project has a handful of these, so the list is not paginated: `pagination.hasMore` is always false.
|
|
10
10
|
.SH "API"
|
|
11
|
-
GET /v1/calendar
|
|
11
|
+
GET /v1/connections/calendar
|
|
12
12
|
.SH "OPTIONS"
|
|
13
13
|
.TP
|
|
14
14
|
\fB\-\-provider\fR \fI<value>\fR
|
|
15
|
-
Who holds the calendar. CAL_COM is
|
|
15
|
+
Who holds the calendar. CAL_COM is connected with an API key; GOOGLE and CALENDLY are connected by consent, through `POST /v1/connections/calendar/google/authorize\-url` and `POST /v1/connections/calendar/calendly/authorize\-url`. One of: CAL_COM, GOOGLE, CALENDLY. Optional.
|
|
16
16
|
.SH "GLOBAL OPTIONS"
|
|
17
17
|
.TP
|
|
18
18
|
\fB\-\-data\fR \fI<json>\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 calendar
|
|
57
|
+
roark connections calendar list
|
|
58
58
|
.fi
|
|
59
59
|
.RE
|
|
60
60
|
.SH "ENVIRONMENT"
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CONNECTIONS\-CALENDAR\-TARGET\-CREATE" "1" "" "roark-connections-calendar-target-create" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-connections\-calendar\-target\-create \- Create a bookable target
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark connections calendar target create
|
|
7
|
+
\fIconnection\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Only for a connection whose `capabilities.roarkOwnsBookingPolicy` is true. A calendar with no scheduling of its own has nothing an agent can be pointed at, so the thing a calendar tool books into is created here: the calendar, how long an appointment runs, and the hours it is offered in. The policy and the hours are written together, because a target with no hours offers nothing. Refused if the calendar is one the account can only read.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/connections/calendar/{connectionId}/targets
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIconnection\-id\fR
|
|
15
|
+
Calendar connection ID
|
|
16
|
+
.SH "OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-name\fR \fI<value>\fR
|
|
19
|
+
Unique within the connection, and how a config file refers to this target. Letters, digits, spaces, _ or \-. Required.
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-calendar\-id\fR \fI<value>\fR
|
|
22
|
+
The calendar to write appointments to, from `GET /v1/connections/calendar/{connectionId}/calendars`. `primary` is accepted and stored as the account’s own id. Required.
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-duration\-minutes\fR \fI<value>\fR
|
|
25
|
+
Required.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-buffer\-before\-minutes\fR \fI<value>\fR
|
|
28
|
+
Dead time before an appointment, counted as busy when a slot is offered. Defaults to 0. Optional.
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-buffer\-after\-minutes\fR \fI<value>\fR
|
|
31
|
+
Optional.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-min\-notice\-minutes\fR \fI<value>\fR
|
|
34
|
+
How soon from now an appointment may be made. Defaults to 120. Optional.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-horizon\-days\fR \fI<value>\fR
|
|
37
|
+
How far ahead appointments may be made. Defaults to 30. Optional.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-slot\-interval\-minutes\fR \fI<value>\fR
|
|
40
|
+
The grid slots are offered on. Defaults to the duration, which gives back\-to\-back appointments. Optional.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-all\-day\-events\-block\fR
|
|
43
|
+
Whether an all\-day event closes the day. Defaults to true, because a calendar marks all\-day events free unless their creator says otherwise and a public holiday entered as one would otherwise be bookable. Optional.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-hours\fR \fI<value>\fR
|
|
46
|
+
The windows of the week appointments are offered in. Omit to adopt Monday to Friday, 09:00 to 17:00. A target with no windows offers nothing at all, which reads to a caller as a permanently full diary. Optional.
|
|
47
|
+
.SH "GLOBAL OPTIONS"
|
|
48
|
+
.TP
|
|
49
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
50
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
51
|
+
.TP
|
|
52
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
53
|
+
Skip confirmation prompts.
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-\-no\-input\fR
|
|
56
|
+
Never prompt; fail instead.
|
|
57
|
+
.TP
|
|
58
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
59
|
+
API base URL.
|
|
60
|
+
.TP
|
|
61
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
62
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
63
|
+
.TP
|
|
64
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
65
|
+
Request timeout in milliseconds.
|
|
66
|
+
.TP
|
|
67
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
68
|
+
Retries for retryable failures.
|
|
69
|
+
.TP
|
|
70
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
71
|
+
Output format: auto, json, jsonl, plain.
|
|
72
|
+
.TP
|
|
73
|
+
\fB\-\-json\fR
|
|
74
|
+
Shorthand for \-\-format json.
|
|
75
|
+
.TP
|
|
76
|
+
\fB\-\-no\-color\fR
|
|
77
|
+
Disable colour.
|
|
78
|
+
.TP
|
|
79
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
80
|
+
Suppress non\-essential output.
|
|
81
|
+
.TP
|
|
82
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
83
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
84
|
+
.SH "EXAMPLES"
|
|
85
|
+
.PP
|
|
86
|
+
.RS 4
|
|
87
|
+
.nf
|
|
88
|
+
roark connections calendar target create <connection\-id> \-\-name <value> \-\-calendar\-id <value> \-\-duration\-minutes <value>
|
|
89
|
+
.fi
|
|
90
|
+
.RE
|
|
91
|
+
.SH "ENVIRONMENT"
|
|
92
|
+
.TP
|
|
93
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
94
|
+
Bearer token used when \-\-token is not given.
|
|
95
|
+
.TP
|
|
96
|
+
\fBROARK_BASE_URL\fR
|
|
97
|
+
API base URL.
|
|
98
|
+
.TP
|
|
99
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
100
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
101
|
+
.TP
|
|
102
|
+
\fBNO_COLOR\fR
|
|
103
|
+
Disables colour when set to any value.
|
|
104
|
+
.SH "EXIT STATUS"
|
|
105
|
+
.TP
|
|
106
|
+
\fB0\fR
|
|
107
|
+
The command succeeded.
|
|
108
|
+
.TP
|
|
109
|
+
\fB1\fR
|
|
110
|
+
The API rejected the request.
|
|
111
|
+
.TP
|
|
112
|
+
\fB2\fR
|
|
113
|
+
The command line was wrong.
|
|
114
|
+
.TP
|
|
115
|
+
\fB3\fR
|
|
116
|
+
No credential, or the credential was refused.
|
|
117
|
+
.TP
|
|
118
|
+
\fB4\fR
|
|
119
|
+
The addressed resource does not exist.
|
|
120
|
+
.TP
|
|
121
|
+
\fB5\fR
|
|
122
|
+
The request never completed: connection, timeout, or abort.
|
|
123
|
+
.SH "SEE ALSO"
|
|
124
|
+
.BR roark (1)
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CONNECTIONS\-CALENDAR\-TARGET\-DELETE" "1" "" "roark-connections-calendar-target-delete" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-connections\-calendar\-target\-delete \- Delete a bookable target
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark connections calendar target delete
|
|
7
|
+
\fIconnection\-id\fR \fItarget\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Refused while a calendar tool still books into it, naming the tools. A dangling binding would otherwise be found by whoever next tried to ship the agent, who is not the person who deleted the target. Appointments already recorded against it are kept.
|
|
10
|
+
.SH "API"
|
|
11
|
+
DELETE /v1/connections/calendar/{connectionId}/targets/{targetId}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIconnection\-id\fR
|
|
15
|
+
Calendar connection ID
|
|
16
|
+
.TP
|
|
17
|
+
\fItarget\-id\fR
|
|
18
|
+
Bookable target ID
|
|
19
|
+
.SH "GLOBAL OPTIONS"
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
22
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
25
|
+
Skip confirmation prompts.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-no\-input\fR
|
|
28
|
+
Never prompt; fail instead.
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
31
|
+
API base URL.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
34
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
37
|
+
Request timeout in milliseconds.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
40
|
+
Retries for retryable failures.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
43
|
+
Output format: auto, json, jsonl, plain.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-json\fR
|
|
46
|
+
Shorthand for \-\-format json.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-\-no\-color\fR
|
|
49
|
+
Disable colour.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
52
|
+
Suppress non\-essential output.
|
|
53
|
+
.TP
|
|
54
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
55
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
56
|
+
.SH "EXAMPLES"
|
|
57
|
+
.PP
|
|
58
|
+
.RS 4
|
|
59
|
+
.nf
|
|
60
|
+
roark connections calendar target delete <connection\-id> <target\-id>
|
|
61
|
+
.fi
|
|
62
|
+
.RE
|
|
63
|
+
.SH "ENVIRONMENT"
|
|
64
|
+
.TP
|
|
65
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
66
|
+
Bearer token used when \-\-token is not given.
|
|
67
|
+
.TP
|
|
68
|
+
\fBROARK_BASE_URL\fR
|
|
69
|
+
API base URL.
|
|
70
|
+
.TP
|
|
71
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
72
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
73
|
+
.TP
|
|
74
|
+
\fBNO_COLOR\fR
|
|
75
|
+
Disables colour when set to any value.
|
|
76
|
+
.SH "EXIT STATUS"
|
|
77
|
+
.TP
|
|
78
|
+
\fB0\fR
|
|
79
|
+
The command succeeded.
|
|
80
|
+
.TP
|
|
81
|
+
\fB1\fR
|
|
82
|
+
The API rejected the request.
|
|
83
|
+
.TP
|
|
84
|
+
\fB2\fR
|
|
85
|
+
The command line was wrong.
|
|
86
|
+
.TP
|
|
87
|
+
\fB3\fR
|
|
88
|
+
No credential, or the credential was refused.
|
|
89
|
+
.TP
|
|
90
|
+
\fB4\fR
|
|
91
|
+
The addressed resource does not exist.
|
|
92
|
+
.TP
|
|
93
|
+
\fB5\fR
|
|
94
|
+
The request never completed: connection, timeout, or abort.
|
|
95
|
+
.SH "SEE ALSO"
|
|
96
|
+
.BR roark (1)
|