@roarkanalytics/cli 0.1.0

package/man/roark-agent-endpoint-list.1

@@ -0,0 +1,102 @@
+.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
+.TH "ROARK\-AGENT\-ENDPOINT\-LIST" "1" "" "roark-agent-endpoint-list" "Roark Analytics API Manual"
+.SH "NAME"
+roark\-agent\-endpoint\-list \- List agent endpoints
+.SH "SYNOPSIS"
+.B roark agent endpoint list
+[\fIoptions\fR]
+.SH "DESCRIPTION"
+Returns a paginated list of agent endpoints for the authenticated project.
+.SH "API"
+GET /v1/agent/endpoint
+.SH "OPTIONS"
+.TP
+\fB\-\-limit\fR \fI<value>\fR
+Maximum number of endpoints to return (default: 20, max: 50) Optional.
+.TP
+\fB\-\-after\fR \fI<value>\fR
+Cursor for pagination \- endpoint ID to start after Optional.
+.TP
+\fB\-\-agent\-id\fR \fI<value>\fR
+Filter by agent ID Optional.
+.TP
+\fB\-\-search\-text\fR \fI<value>\fR
+Search text to filter endpoints Optional.
+.SH "GLOBAL OPTIONS"
+.TP
+\fB\-\-data\fR \fI<json>\fR
+Request body as JSON, or @file to read one (@\- for stdin).
+.TP
+\fB\-y\fR, \fB\-\-yes\fR
+Skip confirmation prompts.
+.TP
+\fB\-\-no\-input\fR
+Never prompt; fail instead.
+.TP
+\fB\-\-base\-url\fR \fI<url>\fR
+API base URL.
+.TP
+\fB\-\-token\fR \fI<token>\fR
+Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
+.TP
+\fB\-\-timeout\fR \fI<ms>\fR
+Request timeout in milliseconds.
+.TP
+\fB\-\-max\-retries\fR \fI<count>\fR
+Retries for retryable failures.
+.TP
+\fB\-\-format\fR \fI<format>\fR
+Output format: auto, json, jsonl, plain.
+.TP
+\fB\-\-json\fR
+Shorthand for \-\-format json.
+.TP
+\fB\-\-no\-color\fR
+Disable colour.
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+Suppress non\-essential output.
+.TP
+\fB\-\-allow\-project\-base\-url\fR
+Send the stored credential to a base URL set by a project .roark.json. Refused by default.
+.SH "EXAMPLES"
+.PP
+.RS 4
+.nf
+roark agent endpoint list
+.fi
+.RE
+.SH "ENVIRONMENT"
+.TP
+\fBROARK_API_BEARER_TOKEN\fR
+Bearer token used when \-\-token is not given.
+.TP
+\fBROARK_BASE_URL\fR
+API base URL.
+.TP
+\fBROARK_ALLOW_PROJECT_BASE_URL\fR
+Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
+.TP
+\fBNO_COLOR\fR
+Disables colour when set to any value.
+.SH "EXIT STATUS"
+.TP
+\fB0\fR
+The command succeeded.
+.TP
+\fB1\fR
+The API rejected the request.
+.TP
+\fB2\fR
+The command line was wrong.
+.TP
+\fB3\fR
+No credential, or the credential was refused.
+.TP
+\fB4\fR
+The addressed resource does not exist.
+.TP
+\fB5\fR
+The request never completed: connection, timeout, or abort.
+.SH "SEE ALSO"
+.BR roark (1)

package/man/roark-agent-endpoint-update.1

@@ -0,0 +1,103 @@
+.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
+.TH "ROARK\-AGENT\-ENDPOINT\-UPDATE" "1" "" "roark-agent-endpoint-update" "Roark Analytics API Manual"
+.SH "NAME"
+roark\-agent\-endpoint\-update \- Update an agent endpoint
+.SH "SYNOPSIS"
+.B roark agent endpoint update
+\fIendpoint\-id\fR [\fIoptions\fR]
+.SH "DESCRIPTION"
+Updates an existing agent endpoint by its ID. Only environment and outboundDialType can be modified.
+.SH "API"
+PUT /v1/agent/endpoint/{endpointId}
+.SH "ARGUMENTS"
+.TP
+\fIendpoint\-id\fR
+The ID of the agent endpoint to update
+.SH "OPTIONS"
+.TP
+\fB\-\-environment\fR \fI<value>\fR
+Environment name Optional.
+.TP
+\fB\-\-outbound\-dial\-type\fR \fI<value>\fR
+Outbound dial type: NONE or HTTP_REQUEST One of: NONE, HTTP_REQUEST. Optional.
+.TP
+\fB\-\-outbound\-dial\-http\-request\-definition\-id\fR \fI<value>\fR
+ID of the HTTP request definition for outbound dialing Optional.
+.SH "GLOBAL OPTIONS"
+.TP
+\fB\-\-data\fR \fI<json>\fR
+Request body as JSON, or @file to read one (@\- for stdin).
+.TP
+\fB\-y\fR, \fB\-\-yes\fR
+Skip confirmation prompts.
+.TP
+\fB\-\-no\-input\fR
+Never prompt; fail instead.
+.TP
+\fB\-\-base\-url\fR \fI<url>\fR
+API base URL.
+.TP
+\fB\-\-token\fR \fI<token>\fR
+Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
+.TP
+\fB\-\-timeout\fR \fI<ms>\fR
+Request timeout in milliseconds.
+.TP
+\fB\-\-max\-retries\fR \fI<count>\fR
+Retries for retryable failures.
+.TP
+\fB\-\-format\fR \fI<format>\fR
+Output format: auto, json, jsonl, plain.
+.TP
+\fB\-\-json\fR
+Shorthand for \-\-format json.
+.TP
+\fB\-\-no\-color\fR
+Disable colour.
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+Suppress non\-essential output.
+.TP
+\fB\-\-allow\-project\-base\-url\fR
+Send the stored credential to a base URL set by a project .roark.json. Refused by default.
+.SH "EXAMPLES"
+.PP
+.RS 4
+.nf
+roark agent endpoint update <endpoint\-id>
+.fi
+.RE
+.SH "ENVIRONMENT"
+.TP
+\fBROARK_API_BEARER_TOKEN\fR
+Bearer token used when \-\-token is not given.
+.TP
+\fBROARK_BASE_URL\fR
+API base URL.
+.TP
+\fBROARK_ALLOW_PROJECT_BASE_URL\fR
+Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
+.TP
+\fBNO_COLOR\fR
+Disables colour when set to any value.
+.SH "EXIT STATUS"
+.TP
+\fB0\fR
+The command succeeded.
+.TP
+\fB1\fR
+The API rejected the request.
+.TP
+\fB2\fR
+The command line was wrong.
+.TP
+\fB3\fR
+No credential, or the credential was refused.
+.TP
+\fB4\fR
+The addressed resource does not exist.
+.TP
+\fB5\fR
+The request never completed: connection, timeout, or abort.
+.SH "SEE ALSO"
+.BR roark (1)

package/man/roark-agent-get.1

@@ -0,0 +1,93 @@
+.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
+.TH "ROARK\-AGENT\-GET" "1" "" "roark-agent-get" "Roark Analytics API Manual"
+.SH "NAME"
+roark\-agent\-get \- Get agent by ID
+.SH "SYNOPSIS"
+.B roark agent get
+\fIagent\-id\fR [\fIoptions\fR]
+.SH "DESCRIPTION"
+Returns a specific agent by its ID.
+.SH "API"
+GET /v1/agent/{agentId}
+.SH "ARGUMENTS"
+.TP
+\fIagent\-id\fR
+The ID of the agent to retrieve
+.SH "GLOBAL OPTIONS"
+.TP
+\fB\-\-data\fR \fI<json>\fR
+Request body as JSON, or @file to read one (@\- for stdin).
+.TP
+\fB\-y\fR, \fB\-\-yes\fR
+Skip confirmation prompts.
+.TP
+\fB\-\-no\-input\fR
+Never prompt; fail instead.
+.TP
+\fB\-\-base\-url\fR \fI<url>\fR
+API base URL.
+.TP
+\fB\-\-token\fR \fI<token>\fR
+Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
+.TP
+\fB\-\-timeout\fR \fI<ms>\fR
+Request timeout in milliseconds.
+.TP
+\fB\-\-max\-retries\fR \fI<count>\fR
+Retries for retryable failures.
+.TP
+\fB\-\-format\fR \fI<format>\fR
+Output format: auto, json, jsonl, plain.
+.TP
+\fB\-\-json\fR
+Shorthand for \-\-format json.
+.TP
+\fB\-\-no\-color\fR
+Disable colour.
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+Suppress non\-essential output.
+.TP
+\fB\-\-allow\-project\-base\-url\fR
+Send the stored credential to a base URL set by a project .roark.json. Refused by default.
+.SH "EXAMPLES"
+.PP
+.RS 4
+.nf
+roark agent get <agent\-id>
+.fi
+.RE
+.SH "ENVIRONMENT"
+.TP
+\fBROARK_API_BEARER_TOKEN\fR
+Bearer token used when \-\-token is not given.
+.TP
+\fBROARK_BASE_URL\fR
+API base URL.
+.TP
+\fBROARK_ALLOW_PROJECT_BASE_URL\fR
+Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
+.TP
+\fBNO_COLOR\fR
+Disables colour when set to any value.
+.SH "EXIT STATUS"
+.TP
+\fB0\fR
+The command succeeded.
+.TP
+\fB1\fR
+The API rejected the request.
+.TP
+\fB2\fR
+The command line was wrong.
+.TP
+\fB3\fR
+No credential, or the credential was refused.
+.TP
+\fB4\fR
+The addressed resource does not exist.
+.TP
+\fB5\fR
+The request never completed: connection, timeout, or abort.
+.SH "SEE ALSO"
+.BR roark (1)

package/man/roark-agent-list.1

@@ -0,0 +1,99 @@
+.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
+.TH "ROARK\-AGENT\-LIST" "1" "" "roark-agent-list" "Roark Analytics API Manual"
+.SH "NAME"
+roark\-agent\-list \- List agents
+.SH "SYNOPSIS"
+.B roark agent list
+[\fIoptions\fR]
+.SH "DESCRIPTION"
+Returns a paginated list of agents for the authenticated project.
+.SH "API"
+GET /v1/agent
+.SH "OPTIONS"
+.TP
+\fB\-\-limit\fR \fI<value>\fR
+Optional.
+.TP
+\fB\-\-after\fR \fI<value>\fR
+Optional.
+.TP
+\fB\-\-search\-text\fR \fI<value>\fR
+Optional.
+.SH "GLOBAL OPTIONS"
+.TP
+\fB\-\-data\fR \fI<json>\fR
+Request body as JSON, or @file to read one (@\- for stdin).
+.TP
+\fB\-y\fR, \fB\-\-yes\fR
+Skip confirmation prompts.
+.TP
+\fB\-\-no\-input\fR
+Never prompt; fail instead.
+.TP
+\fB\-\-base\-url\fR \fI<url>\fR
+API base URL.
+.TP
+\fB\-\-token\fR \fI<token>\fR
+Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
+.TP
+\fB\-\-timeout\fR \fI<ms>\fR
+Request timeout in milliseconds.
+.TP
+\fB\-\-max\-retries\fR \fI<count>\fR
+Retries for retryable failures.
+.TP
+\fB\-\-format\fR \fI<format>\fR
+Output format: auto, json, jsonl, plain.
+.TP
+\fB\-\-json\fR
+Shorthand for \-\-format json.
+.TP
+\fB\-\-no\-color\fR
+Disable colour.
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+Suppress non\-essential output.
+.TP
+\fB\-\-allow\-project\-base\-url\fR
+Send the stored credential to a base URL set by a project .roark.json. Refused by default.
+.SH "EXAMPLES"
+.PP
+.RS 4
+.nf
+roark agent list
+.fi
+.RE
+.SH "ENVIRONMENT"
+.TP
+\fBROARK_API_BEARER_TOKEN\fR
+Bearer token used when \-\-token is not given.
+.TP
+\fBROARK_BASE_URL\fR
+API base URL.
+.TP
+\fBROARK_ALLOW_PROJECT_BASE_URL\fR
+Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
+.TP
+\fBNO_COLOR\fR
+Disables colour when set to any value.
+.SH "EXIT STATUS"
+.TP
+\fB0\fR
+The command succeeded.
+.TP
+\fB1\fR
+The API rejected the request.
+.TP
+\fB2\fR
+The command line was wrong.
+.TP
+\fB3\fR
+No credential, or the credential was refused.
+.TP
+\fB4\fR
+The addressed resource does not exist.
+.TP
+\fB5\fR
+The request never completed: connection, timeout, or abort.
+.SH "SEE ALSO"
+.BR roark (1)

package/man/roark-agent-update.1

@@ -0,0 +1,100 @@
+.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
+.TH "ROARK\-AGENT\-UPDATE" "1" "" "roark-agent-update" "Roark Analytics API Manual"
+.SH "NAME"
+roark\-agent\-update \- Update an agent
+.SH "SYNOPSIS"
+.B roark agent update
+\fIagent\-id\fR [\fIoptions\fR]
+.SH "DESCRIPTION"
+Updates an existing agent by its ID.
+.SH "API"
+PUT /v1/agent/{agentId}
+.SH "ARGUMENTS"
+.TP
+\fIagent\-id\fR
+The ID of the agent to update
+.SH "OPTIONS"
+.TP
+\fB\-\-name\fR \fI<value>\fR
+Name of the agent Optional.
+.TP
+\fB\-\-description\fR \fI<value>\fR
+Description of the agent Optional.
+.SH "GLOBAL OPTIONS"
+.TP
+\fB\-\-data\fR \fI<json>\fR
+Request body as JSON, or @file to read one (@\- for stdin).
+.TP
+\fB\-y\fR, \fB\-\-yes\fR
+Skip confirmation prompts.
+.TP
+\fB\-\-no\-input\fR
+Never prompt; fail instead.
+.TP
+\fB\-\-base\-url\fR \fI<url>\fR
+API base URL.
+.TP
+\fB\-\-token\fR \fI<token>\fR
+Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
+.TP
+\fB\-\-timeout\fR \fI<ms>\fR
+Request timeout in milliseconds.
+.TP
+\fB\-\-max\-retries\fR \fI<count>\fR
+Retries for retryable failures.
+.TP
+\fB\-\-format\fR \fI<format>\fR
+Output format: auto, json, jsonl, plain.
+.TP
+\fB\-\-json\fR
+Shorthand for \-\-format json.
+.TP
+\fB\-\-no\-color\fR
+Disable colour.
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+Suppress non\-essential output.
+.TP
+\fB\-\-allow\-project\-base\-url\fR
+Send the stored credential to a base URL set by a project .roark.json. Refused by default.
+.SH "EXAMPLES"
+.PP
+.RS 4
+.nf
+roark agent update <agent\-id>
+.fi
+.RE
+.SH "ENVIRONMENT"
+.TP
+\fBROARK_API_BEARER_TOKEN\fR
+Bearer token used when \-\-token is not given.
+.TP
+\fBROARK_BASE_URL\fR
+API base URL.
+.TP
+\fBROARK_ALLOW_PROJECT_BASE_URL\fR
+Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
+.TP
+\fBNO_COLOR\fR
+Disables colour when set to any value.
+.SH "EXIT STATUS"
+.TP
+\fB0\fR
+The command succeeded.
+.TP
+\fB1\fR
+The API rejected the request.
+.TP
+\fB2\fR
+The command line was wrong.
+.TP
+\fB3\fR
+No credential, or the credential was refused.
+.TP
+\fB4\fR
+The addressed resource does not exist.
+.TP
+\fB5\fR
+The request never completed: connection, timeout, or abort.
+.SH "SEE ALSO"
+.BR roark (1)

package/man/roark-call-create.1

@@ -0,0 +1,150 @@
+.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
+.TH "ROARK\-CALL\-CREATE" "1" "" "roark-call-create" "Roark Analytics API Manual"
+.SH "NAME"
+roark\-call\-create \- Create a call
+.SH "SYNOPSIS"
+.B roark call create
+[\fIoptions\fR]
+.SH "DESCRIPTION"
+Create a new call with recording, transcript, agents, and customers
+.SH "API"
+POST /v1/call
+.SH "OPTIONS"
+.TP
+\fB\-\-recording\-url\fR \fI<value>\fR
+URL of source recording (must be an accessible WAV, MP3, MP4, or OGG file). Can be a signed URL. Required.
+.TP
+\fB\-\-stereo\-recording\-url\fR \fI<value>\fR
+URL of source stereo recording. Must be accessible. Can be a signed URL. Supported formats: WAV, MP3, MP4, OGG. Optional.
+.TP
+\fB\-\-started\-at\fR \fI<value>\fR
+When the call started (ISO 8601 format) Required.
+.TP
+\fB\-\-interface\-type\fR \fI<value>\fR
+Interface type of the call (PHONE or WEB) One of: PHONE, WEB. Required.
+.TP
+\fB\-\-call\-direction\fR \fI<value>\fR
+Direction of the call (INBOUND or OUTBOUND) One of: INBOUND, OUTBOUND. Required.
+.TP
+\fB\-\-ended\-status\fR \fI<value>\fR
+High\-level call end status, indicating how the call terminated One of: PARTICIPANTS_DID_NOT_SPEAK, AGENT_DID_NOT_ANSWER, AGENT_DID_NOT_SPEAK, AGENT_STOPPED_SPEAKING, AGENT_ENDED_CALL, AGENT_TRANSFERRED_CALL, AGENT_BUSY, AGENT_ERROR, CUSTOMER_ENDED_CALL, VOICE_MAIL_REACHED, SILENCE_TIME_OUT, PHONE_CALL_PROVIDER_CONNECTION_ERROR, CUSTOMER_DID_NOT_ANSWER, CUSTOMER_DID_NOT_SPEAK, CUSTOMER_STOPPED_SPEAKING, CUSTOMER_BUSY, DIAL_ERROR, MAX_DURATION_REACHED, UNKNOWN. Optional.
+.TP
+\fB\-\-transcript\fR \fI<value>\fR
+List of transcript entries made during the call Optional.
+.TP
+\fB\-\-tool\-invocations\fR \fI<value>\fR
+List of tool invocations made during the call Optional.
+.TP
+\fB\-\-properties\fR \fI<value>\fR
+Custom properties to include with the call. These can be used for filtering and will show in the call details page Optional.
+.TP
+\fB\-\-vapi\-call\-id\fR \fI<value>\fR
+The Vapi call ID (UUID) to link this call with OpenTelemetry trace data from Vapi. Used for matching calls with OTEL traces. Optional.
+.TP
+\fB\-\-livekit\-room\-id\fR \fI<value>\fR
+The LiveKit Cloud room ID to link this call with OpenTelemetry trace data from LiveKit. Used for matching calls with OTEL traces. Optional.
+.TP
+\fB\-\-external\-id\fR \fI<value>\fR
+A stable identifier from your own system (e.g. session ID, conversation ID) used to correlate this call with OpenTelemetry traces. Set the same value as a `roark.external_id` span or resource attribute on your traces and the matching trace will be linked automatically. Must be unique within a project. Optional.
+.TP
+\fB\-\-agent\fR \fI<value>\fR
+Single agent participating in the call. Use this for simpler API when you have only one agent. Optional.
+.TP
+\fB\-\-agent.endpoint\fR \fI<value>\fR
+Endpoint configuration for this agent (optional) Optional.
+.TP
+\fB\-\-agent.prompt\fR \fI<value>\fR
+Agent's prompt configuration (optional) Optional.
+.TP
+\fB\-\-agents\fR \fI<value>\fR
+Agents participating in the call. Each agent requires identification and prompt information. Optional.
+.TP
+\fB\-\-customer\fR \fI<value>\fR
+Single customer participating in the call. Use this for simpler API when you have only one customer. Optional.
+.TP
+\fB\-\-customer.label\fR \fI<value>\fR
+Label to identify this customer in the transcript (e.g., "speaker\-01", "speaker\-02") Optional.
+.TP
+\fB\-\-customer.phone\-number\-e164\fR \fI<value>\fR
+Customer phone number in E.164 format (e.g., +14155551234) Required.
+.TP
+\fB\-\-customers\fR \fI<value>\fR
+Customers participating in the call. Optional.
+.SH "GLOBAL OPTIONS"
+.TP
+\fB\-\-data\fR \fI<json>\fR
+Request body as JSON, or @file to read one (@\- for stdin).
+.TP
+\fB\-y\fR, \fB\-\-yes\fR
+Skip confirmation prompts.
+.TP
+\fB\-\-no\-input\fR
+Never prompt; fail instead.
+.TP
+\fB\-\-base\-url\fR \fI<url>\fR
+API base URL.
+.TP
+\fB\-\-token\fR \fI<token>\fR
+Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
+.TP
+\fB\-\-timeout\fR \fI<ms>\fR
+Request timeout in milliseconds.
+.TP
+\fB\-\-max\-retries\fR \fI<count>\fR
+Retries for retryable failures.
+.TP
+\fB\-\-format\fR \fI<format>\fR
+Output format: auto, json, jsonl, plain.
+.TP
+\fB\-\-json\fR
+Shorthand for \-\-format json.
+.TP
+\fB\-\-no\-color\fR
+Disable colour.
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+Suppress non\-essential output.
+.TP
+\fB\-\-allow\-project\-base\-url\fR
+Send the stored credential to a base URL set by a project .roark.json. Refused by default.
+.SH "EXAMPLES"
+.PP
+.RS 4
+.nf
+roark call create \-\-recording\-url <value> \-\-started\-at <value> \-\-interface\-type <value> \-\-call\-direction <value> \-\-customer.phone\-number\-e164 <value>
+.fi
+.RE
+.SH "ENVIRONMENT"
+.TP
+\fBROARK_API_BEARER_TOKEN\fR
+Bearer token used when \-\-token is not given.
+.TP
+\fBROARK_BASE_URL\fR
+API base URL.
+.TP
+\fBROARK_ALLOW_PROJECT_BASE_URL\fR
+Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
+.TP
+\fBNO_COLOR\fR
+Disables colour when set to any value.
+.SH "EXIT STATUS"
+.TP
+\fB0\fR
+The command succeeded.
+.TP
+\fB1\fR
+The API rejected the request.
+.TP
+\fB2\fR
+The command line was wrong.
+.TP
+\fB3\fR
+No credential, or the credential was refused.
+.TP
+\fB4\fR
+The addressed resource does not exist.
+.TP
+\fB5\fR
+The request never completed: connection, timeout, or abort.
+.SH "SEE ALSO"
+.BR roark (1)