@lusor/sdk 0.0.0-stage → 1.0.0

package/dist/api/resources/secrets/index.js

@@ -0,0 +1,2 @@
+export * from "./client/index.js";
+export * from "./types/index.js";

package/dist/api/resources/secrets/types/GetSecretsResponse.d.ts

@@ -0,0 +1,4 @@
+import * as Lusor from "../../../index.js";
+export interface GetSecretsResponse {
+    data: Lusor.WorkspaceSecret;
+}

package/dist/api/resources/secrets/types/GetSecretsResponse.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/api/resources/secrets/types/ListTagsSecretsResponse.d.ts

@@ -0,0 +1,4 @@
+import * as Lusor from "../../../index.js";
+export interface ListTagsSecretsResponse {
+    data: Lusor.SecretTag[];
+}

package/dist/api/resources/secrets/types/ListTagsSecretsResponse.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/api/resources/secrets/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./GetSecretsResponse.js";
+export * from "./ListTagsSecretsResponse.js";

package/dist/api/resources/secrets/types/index.js

@@ -0,0 +1,2 @@
+export * from "./GetSecretsResponse.js";
+export * from "./ListTagsSecretsResponse.js";

package/dist/api/resources/sessions/client/Client.d.ts

@@ -0,0 +1,442 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as Lusor from "../../../index.js";
+import { LiveViewClient } from "../resources/liveView/client/Client.js";
+export declare namespace SessionsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Run records: list, inspect, stop, and read events and artifacts. Start
+ * a run with `POST /v1/agents/{id}/turns`, or without an agent through
+ * `POST /v1/workspaces/{workspaceId}/devices/{deviceId}/sessions`.
+ */
+export declare class SessionsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<SessionsClient.Options>;
+    protected _liveView: LiveViewClient | undefined;
+    constructor(options?: SessionsClient.Options);
+    get liveView(): LiveViewClient;
+    /**
+     * @param {Lusor.GetSessionsRequest} request
+     * @param {SessionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lusor.UnauthorizedError}
+     * @throws {@link Lusor.NotFoundError}
+     * @throws {@link errors.LusorError}
+     * @throws {@link errors.LusorTimeoutError}
+     *
+     * @example
+     *     await client.sessions.get({
+     *         id: "id"
+     *     })
+     */
+    get(request: Lusor.GetSessionsRequest, requestOptions?: SessionsClient.RequestOptions): core.HttpResponsePromise<Lusor.SessionDetail>;
+    private __get;
+    /**
+     * Sets the session's display name. Send `name: null` to clear it, so
+     * the name is derived from the prompt again. Returns the updated
+     * session.
+     *
+     * Workspace scope is resolved from `workspaceId` in the JSON body, or
+     * the workspace bound to the API key, so API-key callers may omit it.
+     *
+     * **Retries:** safe without an `Idempotency-Key`: the same patch converges on the same state.
+     *
+     * @param {Lusor.UpdateSessionInput} request
+     * @param {SessionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lusor.BadRequestError}
+     * @throws {@link Lusor.UnauthorizedError}
+     * @throws {@link Lusor.NotFoundError}
+     * @throws {@link errors.LusorError}
+     * @throws {@link errors.LusorTimeoutError}
+     *
+     * @example
+     *     await client.sessions.update({
+     *         id: "id"
+     *     })
+     */
+    update(request: Lusor.UpdateSessionInput, requestOptions?: SessionsClient.RequestOptions): core.HttpResponsePromise<Lusor.SessionDetail>;
+    private __update;
+    /**
+     * @param {Lusor.EventsSessionsRequest} request
+     * @param {SessionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lusor.UnauthorizedError}
+     * @throws {@link Lusor.NotFoundError}
+     * @throws {@link errors.LusorError}
+     * @throws {@link errors.LusorTimeoutError}
+     *
+     * @example
+     *     await client.sessions.events({
+     *         id: "id"
+     *     })
+     */
+    events(request: Lusor.EventsSessionsRequest, requestOptions?: SessionsClient.RequestOptions): core.HttpResponsePromise<Lusor.EventsSessionsResponse>;
+    private __events;
+    /**
+     * The replay view's JSON breakdown: the session detail and its full event
+     * list as one `lusor.session.v1` document. Included only on App tiers with
+     * the detailed step breakdown (Hobby and above); other tiers get 403
+     * `detailed_breakdown_not_in_plan` and no session data. The same
+     * retention window as `GET /v1/sessions/{id}` and `/events` applies.
+     *
+     * @param {Lusor.BreakdownSessionsRequest} request
+     * @param {SessionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lusor.UnauthorizedError}
+     * @throws {@link Lusor.ForbiddenError}
+     * @throws {@link Lusor.NotFoundError}
+     * @throws {@link Lusor.ServiceUnavailableError}
+     * @throws {@link errors.LusorError}
+     * @throws {@link errors.LusorTimeoutError}
+     *
+     * @example
+     *     await client.sessions.breakdown({
+     *         id: "id"
+     *     })
+     */
+    breakdown(request: Lusor.BreakdownSessionsRequest, requestOptions?: SessionsClient.RequestOptions): core.HttpResponsePromise<Lusor.BreakdownSessionsResponse>;
+    private __breakdown;
+    /**
+     * Server-side filtering over the workspace's session history, newest
+     * first. `deviceId` and `status` are exact single-value matches; the
+     * filter parameters (`statuses`, `statusMode`,
+     * `nameContains`, `deviceContains`, `createdBefore`, `createdAfter`)
+     * are applied server-side so the result stays correct across
+     * `limit`/`offset` pages.
+     *
+     * @param {Lusor.ListSessionsRequest} request
+     * @param {SessionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lusor.BadRequestError}
+     * @throws {@link errors.LusorError}
+     * @throws {@link errors.LusorTimeoutError}
+     *
+     * @example
+     *     await client.sessions.list()
+     */
+    list(request?: Lusor.ListSessionsRequest, requestOptions?: SessionsClient.RequestOptions): core.HttpResponsePromise<Lusor.ListSessionsResponse>;
+    private __list;
+    /**
+     * How long the workspace's plan keeps session history and recordings,
+     * with the server's clock. A session older than `cutoff` answers
+     * `403 upgrade_required` on its reads.
+     *
+     * @param {Lusor.HistoryPolicySessionsRequest} request
+     * @param {SessionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lusor.BadRequestError}
+     * @throws {@link Lusor.UnauthorizedError}
+     * @throws {@link Lusor.NotFoundError}
+     * @throws {@link errors.LusorError}
+     * @throws {@link errors.LusorTimeoutError}
+     *
+     * @example
+     *     await client.sessions.historyPolicy()
+     */
+    historyPolicy(request?: Lusor.HistoryPolicySessionsRequest, requestOptions?: SessionsClient.RequestOptions): core.HttpResponsePromise<Lusor.HistoryPolicySessionsResponse>;
+    private __historyPolicy;
+    /**
+     * @deprecated
+     *
+     * The original session shape, kept for older clients. Use
+     * `GET /v1/sessions/{id}`.
+     *
+     * @param {Lusor.GetLegacySessionsRequest} request
+     * @param {SessionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lusor.BadRequestError}
+     * @throws {@link Lusor.UnauthorizedError}
+     * @throws {@link Lusor.NotFoundError}
+     * @throws {@link errors.LusorError}
+     * @throws {@link errors.LusorTimeoutError}
+     *
+     * @example
+     *     await client.sessions.getLegacy({
+     *         id: "id"
+     *     })
+     */
+    getLegacy(request: Lusor.GetLegacySessionsRequest, requestOptions?: SessionsClient.RequestOptions): core.HttpResponsePromise<Lusor.LegacySession>;
+    private __getLegacy;
+    /**
+     * @param {Lusor.StatusSessionsRequest} request
+     * @param {SessionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lusor.NotFoundError}
+     * @throws {@link errors.LusorError}
+     * @throws {@link errors.LusorTimeoutError}
+     *
+     * @example
+     *     await client.sessions.status({
+     *         id: "id"
+     *     })
+     */
+    status(request: Lusor.StatusSessionsRequest, requestOptions?: SessionsClient.RequestOptions): core.HttpResponsePromise<Lusor.SessionStatusView>;
+    private __status;
+    /**
+     * @param {Lusor.ArtifactsSessionsRequest} request
+     * @param {SessionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lusor.NotFoundError}
+     * @throws {@link errors.LusorError}
+     * @throws {@link errors.LusorTimeoutError}
+     *
+     * @example
+     *     await client.sessions.artifacts({
+     *         id: "id"
+     *     })
+     */
+    artifacts(request: Lusor.ArtifactsSessionsRequest, requestOptions?: SessionsClient.RequestOptions): core.HttpResponsePromise<Lusor.SessionArtifacts>;
+    private __artifacts;
+    /**
+     * Idempotent cancel. Repeated calls after a successful cancel return
+     * `status: "noop"`.
+     *
+     * Workspace scope is resolved in this order (first non-empty wins):
+     * `workspaceId` in the JSON body, then `?workspaceId=`, then the
+     * workspace bound to the API key, so API-key callers may omit it.
+     *
+     * **Retries:** safe without an `Idempotency-Key`: a repeat converges on the same stopped state.
+     *
+     * @param {Lusor.StopSessionsRequest} request
+     * @param {SessionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lusor.BadRequestError}
+     * @throws {@link Lusor.NotFoundError}
+     * @throws {@link errors.LusorError}
+     * @throws {@link errors.LusorTimeoutError}
+     *
+     * @example
+     *     await client.sessions.stop({
+     *         id: "id",
+     *         body: {}
+     *     })
+     */
+    stop(request: Lusor.StopSessionsRequest, requestOptions?: SessionsClient.RequestOptions): core.HttpResponsePromise<Lusor.StopSessionResult>;
+    private __stop;
+    /**
+     * The UI tree the agent saw at one step of the run, as the JSON array
+     * of nodes it was captured as. `file` is the step index followed by
+     * `.json`, for example `0.json`. Content follows the workspace's
+     * history window: a state older than the window returns `404`.
+     *
+     * @param {Lusor.GetUiStateSessionsRequest} request
+     * @param {SessionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lusor.BadRequestError}
+     * @throws {@link Lusor.UnauthorizedError}
+     * @throws {@link Lusor.NotFoundError}
+     * @throws {@link Lusor.BadGatewayError}
+     * @throws {@link Lusor.ServiceUnavailableError}
+     * @throws {@link errors.LusorError}
+     * @throws {@link errors.LusorTimeoutError}
+     *
+     * @example
+     *     await client.sessions.getUiState({
+     *         id: "id",
+     *         file: "file"
+     *     })
+     */
+    getUiState(request: Lusor.GetUiStateSessionsRequest, requestOptions?: SessionsClient.RequestOptions): core.HttpResponsePromise<Record<string, unknown>[]>;
+    private __getUiState;
+    /**
+     * Removes a turn that is waiting behind a running one, before it
+     * starts. `invocationId` is the `invocationId` of the `202`
+     * `{ queued: true }` response of `POST /v1/sessions/{id}/continue` or
+     * `POST /v1/agents/{id}/turns`. Idempotent: cancelling an
+     * already-cancelled entry returns `alreadyCancelled: true`. An unknown
+     * `invocationId` returns `404`.
+     *
+     * Workspace scope is resolved from `?workspaceId=` or the workspace
+     * bound to the API key.
+     *
+     * **Retries:** safe without an `Idempotency-Key`: a repeat converges on the same cancelled state.
+     *
+     * @param {Lusor.CancelQueuedSessionsRequest} request
+     * @param {SessionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lusor.BadRequestError}
+     * @throws {@link Lusor.UnauthorizedError}
+     * @throws {@link Lusor.NotFoundError}
+     * @throws {@link Lusor.BadGatewayError}
+     * @throws {@link errors.LusorError}
+     * @throws {@link errors.LusorTimeoutError}
+     *
+     * @example
+     *     await client.sessions.cancelQueued({
+     *         id: "id",
+     *         invocationId: "invocationId"
+     *     })
+     */
+    cancelQueued(request: Lusor.CancelQueuedSessionsRequest, requestOptions?: SessionsClient.RequestOptions): core.HttpResponsePromise<Lusor.CancelQueuedFollowupResult>;
+    private __cancelQueued;
+    /**
+     * Continues the session with a new prompt on the same transcript. The
+     * follow-up runs on the session's phone (for an agent's session, the
+     * phone the agent has now). If the session is still running, the
+     * follow-up is queued behind it (`queued: true`) and runs when the
+     * current run ends. Continuing a finished session is allowed.
+     *
+     * Send an `Idempotency-Key` header to make retries safe: the same key
+     * attaches to the original follow-up instead of sending a second one.
+     *
+     * Workspace scope: `workspaceId` in the body, otherwise the workspace
+     * bound to the API key.
+     *
+     * @param {Lusor.ContinueSessionInput} request
+     * @param {SessionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lusor.BadRequestError}
+     * @throws {@link Lusor.UnauthorizedError}
+     * @throws {@link Lusor.PaymentRequiredError}
+     * @throws {@link Lusor.NotFoundError}
+     * @throws {@link Lusor.ConflictError}
+     * @throws {@link Lusor.TooManyRequestsError}
+     * @throws {@link Lusor.BadGatewayError}
+     * @throws {@link errors.LusorError}
+     * @throws {@link errors.LusorTimeoutError}
+     *
+     * @example
+     *     await client.sessions.continue({
+     *         id: "id",
+     *         prompt: "prompt"
+     *     })
+     */
+    continue(request: Lusor.ContinueSessionInput, requestOptions?: SessionsClient.RequestOptions): core.HttpResponsePromise<Lusor.ContinueSessionResult>;
+    private __continue;
+    /**
+     * When the agent asks a question, the run pauses: the session's status
+     * becomes `awaiting_human` and its events include a `hitl_requested`
+     * event whose `data.correlation_id` identifies the question
+     * (`data.question`, and `data.options` when the agent offered
+     * answer labels). Post the answer here; the run resumes with your text
+     * as the reply. A question stays answerable until the session ends or
+     * a newer message supersedes it.
+     *
+     * Only plain questions can be answered here. A request for a secret
+     * (a `hitl_requested` event whose `data.kind` is `credential` or
+     * `2fa`) is answered only in the Lusor dashboard: any reply to it
+     * made with an API key returns `403` `secure_ask_dashboard_only` and
+     * stores nothing.
+     *
+     * A run created with an API key never reaches that state: when the
+     * agent asks for a secret, the run ends as `failed` with `error`
+     * `secret_required:<name>` (see `SessionV2.error`) instead of
+     * pausing, so there is nothing to answer. Save the secret in the
+     * workspace, then retry the run naming it in `secrets`.
+     *
+     * Retrying with the same text is idempotent (`idempotent: true`). A
+     * different answer to a question that was already answered returns
+     * `409`; the first answer stands.
+     *
+     * Workspace scope: `workspaceId` in the body, otherwise the workspace
+     * bound to the API key.
+     *
+     * **Retries:** safe without an `Idempotency-Key`: an answer is keyed by its `correlationId`, so a repeat is delivered once.
+     *
+     * @param {Lusor.AnswerHitlInput} request
+     * @param {SessionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lusor.BadRequestError}
+     * @throws {@link Lusor.UnauthorizedError}
+     * @throws {@link Lusor.PaymentRequiredError}
+     * @throws {@link Lusor.ForbiddenError}
+     * @throws {@link Lusor.NotFoundError}
+     * @throws {@link Lusor.ConflictError}
+     * @throws {@link Lusor.GoneError}
+     * @throws {@link Lusor.TooManyRequestsError}
+     * @throws {@link Lusor.InternalServerError}
+     * @throws {@link Lusor.BadGatewayError}
+     * @throws {@link errors.LusorError}
+     * @throws {@link errors.LusorTimeoutError}
+     *
+     * @example
+     *     await client.sessions.answer({
+     *         id: "id",
+     *         correlation_id: "correlation_id",
+     *         response: "response"
+     *     })
+     */
+    answer(request: Lusor.AnswerHitlInput, requestOptions?: SessionsClient.RequestOptions): core.HttpResponsePromise<Lusor.AnswerHitlResult>;
+    private __answer;
+    /**
+     * Returns signed URLs for the recording's MP4 segments, in order.
+     * URLs expire at each segment's `expires_at` (Unix seconds); fetch
+     * this endpoint again for fresh ones.
+     *
+     * `recording_status` is always present:
+     *
+     * - `absent`: the session has no recording.
+     * - `pending`: the recording is still being finalized. Poll again.
+     * - `complete`: finished. When `data` is present it is always
+     *   `complete`.
+     * - `failed`: finalization failed; `recording_status_reason` says
+     *   why.
+     *
+     * `data` is null until there is playable media. A recording follows
+     * the workspace's history window: past it, `402` with
+     * `reason: "history_window"`, unless the plan includes video replay
+     * or the recording was made on a paid Lusor Phone plan.
+     *
+     * @param {Lusor.RecordingSessionsRequest} request
+     * @param {SessionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lusor.UnauthorizedError}
+     * @throws {@link Lusor.PaymentRequiredError}
+     * @throws {@link Lusor.NotFoundError}
+     * @throws {@link Lusor.BadGatewayError}
+     * @throws {@link Lusor.ServiceUnavailableError}
+     * @throws {@link errors.LusorError}
+     * @throws {@link errors.LusorTimeoutError}
+     *
+     * @example
+     *     await client.sessions.recording({
+     *         id: "id"
+     *     })
+     */
+    recording(request: Lusor.RecordingSessionsRequest, requestOptions?: SessionsClient.RequestOptions): core.HttpResponsePromise<Lusor.SessionRecordingResponse>;
+    private __recording;
+    /**
+     * Each completed action paired with the screenshot taken after it, in
+     * time order, with a signed `frame_url` that expires at `expires_at`
+     * (Unix seconds, about five minutes). Frames still uploading are left
+     * out until they are ready. Past the workspace's history window this
+     * returns `402` with `reason: "history_window"`.
+     *
+     * @param {Lusor.ReplaySessionsRequest} request
+     * @param {SessionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lusor.UnauthorizedError}
+     * @throws {@link Lusor.PaymentRequiredError}
+     * @throws {@link Lusor.NotFoundError}
+     * @throws {@link Lusor.BadGatewayError}
+     * @throws {@link Lusor.ServiceUnavailableError}
+     * @throws {@link errors.LusorError}
+     * @throws {@link errors.LusorTimeoutError}
+     *
+     * @example
+     *     await client.sessions.replay({
+     *         id: "id"
+     *     })
+     */
+    replay(request: Lusor.ReplaySessionsRequest, requestOptions?: SessionsClient.RequestOptions): core.HttpResponsePromise<Lusor.SessionReplayResponse>;
+    private __replay;
+    /**
+     * The bytes of one replay screenshot, served by the API instead of a
+     * signed URL. `index` selects into the list `GET
+     * /v1/sessions/{id}/replay` returns, counting from 0.
+     *
+     * @throws {@link Lusor.UnauthorizedError}
+     * @throws {@link Lusor.PaymentRequiredError}
+     * @throws {@link Lusor.NotFoundError}
+     * @throws {@link Lusor.BadGatewayError}
+     * @throws {@link Lusor.ServiceUnavailableError}
+     * @throws {@link errors.LusorError}
+     * @throws {@link errors.LusorTimeoutError}
+     */
+    replayFrame(request: Lusor.ReplayFrameSessionsRequest, requestOptions?: SessionsClient.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
+    private __replayFrame;
+}