@lusor/sdk 0.0.0-stage → 1.0.0

package/dist/api/resources/devices/client/requests/ListInWorkspaceDevicesRequest.js

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

package/dist/api/resources/devices/client/requests/ListInternetLocationsRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         workspaceId: "workspaceId"
+ *     }
+ */
+export interface ListInternetLocationsRequest {
+    /** Workspace UUID. Caller must have access. */
+    workspaceId: string;
+}

package/dist/api/resources/devices/client/requests/ListInternetLocationsRequest.js

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

package/dist/api/resources/devices/client/requests/OccupancyDevicesRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @example
+ *     {
+ *         workspaceId: "workspaceId",
+ *         deviceId: "deviceId"
+ *     }
+ */
+export interface OccupancyDevicesRequest {
+    /** Workspace UUID. Caller must have access. */
+    workspaceId: string;
+    /** Device id (paired into the workspace). */
+    deviceId: string;
+}

package/dist/api/resources/devices/client/requests/OccupancyDevicesRequest.js

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

package/dist/api/resources/devices/client/requests/PreviewRemoveDevicesRequest.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @example
+ *     {
+ *         workspaceId: "workspaceId",
+ *         deviceId: "deviceId",
+ *         body: {
+ *             "key": "value"
+ *         }
+ *     }
+ */
+export interface PreviewRemoveDevicesRequest {
+    /** Workspace UUID. Caller must have access. */
+    workspaceId: string;
+    /** Device id (paired into the workspace). */
+    deviceId: string;
+    body?: Record<string, unknown>;
+}

package/dist/api/resources/devices/client/requests/PreviewRemoveDevicesRequest.js

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

package/dist/api/resources/devices/client/requests/RecentDevicesRequest.d.ts

@@ -0,0 +1,46 @@
+import * as Lusor from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         workspaceId: "workspaceId",
+ *         deviceId: "deviceId",
+ *         body: {}
+ *     }
+ */
+export interface RecentDevicesRequest {
+    /** Workspace UUID. Caller must have access. */
+    workspaceId: string;
+    /** Device id (paired into the workspace). */
+    deviceId: string;
+    /**
+     * Makes a retry of this device action safe. Send a fresh key (for
+     * example a UUID) per action and the same key when you retry it.
+     *
+     * * The first request with a key runs the action and its result is
+     *   kept for 24 hours, whatever it was (success or error).
+     * * A repeat with the same key and the same request returns that
+     *   result unchanged, without running the action again and without
+     *   counting Lusor Phone minutes, with the header
+     *   `Idempotent-Replayed: true`.
+     * * A repeat while the first is still running returns
+     *   `409 idempotency_key_in_use`. If the first never finished (the
+     *   server stopped mid-request) a repeat returns
+     *   `409 idempotency_outcome_unknown`; the action is not run again, so
+     *   check the device and use a new key.
+     * * The same key with a different request (path, query or body)
+     *   returns `422 idempotency_key_reused`.
+     * * A key that is not 1–255 visible ASCII characters returns `400
+     *   invalid_idempotency_key`. Without the header, or with an empty
+     *   one, nothing is deduplicated.
+     * * A replayed `screenshot_url` is the original one and may have
+     *   expired; take a new screenshot to get a fresh URL.
+     *
+     * Keys are scoped to the workspace and the operation. Refusals before
+     * the action is sent (validation, access, `402`, `503
+     * meter_unavailable`) do not use up the key. If the key cannot be
+     * recorded the action is not sent and the response is `503
+     * idempotency_unavailable`.
+     */
+    "Idempotency-Key"?: string;
+    body?: Lusor.EmptyVerbInput;
+}

package/dist/api/resources/devices/client/requests/RecentDevicesRequest.js

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

package/dist/api/resources/devices/client/requests/RemoveDevicesRequest.d.ts

@@ -0,0 +1,18 @@
+import * as Lusor from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         workspaceId: "workspaceId",
+ *         deviceId: "deviceId",
+ *         body: {
+ *             previewId: "previewId"
+ *         }
+ *     }
+ */
+export interface RemoveDevicesRequest {
+    /** Workspace UUID. Caller must have access. */
+    workspaceId: string;
+    /** Device id (paired into the workspace). */
+    deviceId: string;
+    body: Lusor.DeviceChangeConfirmInput;
+}

package/dist/api/resources/devices/client/requests/RemoveDevicesRequest.js

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

package/dist/api/resources/devices/client/requests/ResetAdvertisingIdDevicesRequest.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @example
+ *     {
+ *         workspaceId: "workspaceId",
+ *         deviceId: "deviceId"
+ *     }
+ */
+export interface ResetAdvertisingIdDevicesRequest {
+    /** Workspace UUID. Caller must have access. */
+    workspaceId: string;
+    /** Device id (paired into the workspace). */
+    deviceId: string;
+    /**
+     * Makes a retry of this write safe. Send a fresh key (for example a
+     * UUID) per change and the same key when you retry it.
+     *
+     * * The first request with a key runs and its result is kept for 24
+     *   hours, whatever it was (success or error).
+     * * A repeat with the same key and the same request returns that
+     *   result unchanged, without running it again, with the header
+     *   `Idempotent-Replayed: true`.
+     * * A repeat while the first is still running returns
+     *   `409 idempotency_key_in_use`; if the first never finished,
+     *   `409 idempotency_outcome_unknown` (it is not run again: read the
+     *   current state, then use a new key).
+     * * The same key with a different request (path, query or body)
+     *   returns `422 idempotency_key_reused`.
+     * * A key that is not 1–255 visible ASCII characters returns `400
+     *   invalid_idempotency_key`. Without the header, or with an empty
+     *   one, nothing is deduplicated.
+     *
+     * Keys are scoped to the workspace (skills: the user) and the
+     * operation. Refusals before the write runs (validation, access,
+     * role, `409 phone_busy` from the busy-phone check, `409
+     * skill_exists`) do not use up the key. If the key cannot be recorded nothing
+     * runs and the response is `503 idempotency_unavailable`.
+     */
+    "Idempotency-Key"?: string;
+}

package/dist/api/resources/devices/client/requests/ResetAdvertisingIdDevicesRequest.js

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

package/dist/api/resources/devices/client/requests/ScreenshotDevicesRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @example
+ *     {
+ *         workspaceId: "workspaceId",
+ *         deviceId: "deviceId"
+ *     }
+ */
+export interface ScreenshotDevicesRequest {
+    /** Workspace UUID. Caller must have access. */
+    workspaceId: string;
+    /** Device id (paired into the workspace). */
+    deviceId: string;
+}

package/dist/api/resources/devices/client/requests/ScreenshotDevicesRequest.js

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

package/dist/api/resources/devices/client/requests/SetIdentityDevicesRequest.d.ts

@@ -0,0 +1,42 @@
+import * as Lusor from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         workspaceId: "workspaceId",
+ *         deviceId: "deviceId",
+ *         body: {}
+ *     }
+ */
+export interface SetIdentityDevicesRequest {
+    /** Workspace UUID. Caller must have access. */
+    workspaceId: string;
+    /** Device id (paired into the workspace). */
+    deviceId: string;
+    /**
+     * Makes a retry of this write safe. Send a fresh key (for example a
+     * UUID) per change and the same key when you retry it.
+     *
+     * * The first request with a key runs and its result is kept for 24
+     *   hours, whatever it was (success or error).
+     * * A repeat with the same key and the same request returns that
+     *   result unchanged, without running it again, with the header
+     *   `Idempotent-Replayed: true`.
+     * * A repeat while the first is still running returns
+     *   `409 idempotency_key_in_use`; if the first never finished,
+     *   `409 idempotency_outcome_unknown` (it is not run again: read the
+     *   current state, then use a new key).
+     * * The same key with a different request (path, query or body)
+     *   returns `422 idempotency_key_reused`.
+     * * A key that is not 1–255 visible ASCII characters returns `400
+     *   invalid_idempotency_key`. Without the header, or with an empty
+     *   one, nothing is deduplicated.
+     *
+     * Keys are scoped to the workspace (skills: the user) and the
+     * operation. Refusals before the write runs (validation, access,
+     * role, `409 phone_busy` from the busy-phone check, `409
+     * skill_exists`) do not use up the key. If the key cannot be recorded nothing
+     * runs and the response is `503 idempotency_unavailable`.
+     */
+    "Idempotency-Key"?: string;
+    body: Lusor.DeviceIdentityFields;
+}

package/dist/api/resources/devices/client/requests/SetIdentityDevicesRequest.js

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

package/dist/api/resources/devices/client/requests/ShellInput.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @example
+ *     {
+ *         workspaceId: "workspaceId",
+ *         deviceId: "deviceId",
+ *         command: "command"
+ *     }
+ */
+export interface ShellInput {
+    /** Workspace UUID. Caller must have access. */
+    workspaceId: string;
+    /** Device id (paired into the workspace). */
+    deviceId: string;
+    /**
+     * Makes a retry of this device action safe. Send a fresh key (for
+     * example a UUID) per action and the same key when you retry it.
+     *
+     * * The first request with a key runs the action and its result is
+     *   kept for 24 hours, whatever it was (success or error).
+     * * A repeat with the same key and the same request returns that
+     *   result unchanged, without running the action again and without
+     *   counting Lusor Phone minutes, with the header
+     *   `Idempotent-Replayed: true`.
+     * * A repeat while the first is still running returns
+     *   `409 idempotency_key_in_use`. If the first never finished (the
+     *   server stopped mid-request) a repeat returns
+     *   `409 idempotency_outcome_unknown`; the action is not run again, so
+     *   check the device and use a new key.
+     * * The same key with a different request (path, query or body)
+     *   returns `422 idempotency_key_reused`.
+     * * A key that is not 1–255 visible ASCII characters returns `400
+     *   invalid_idempotency_key`. Without the header, or with an empty
+     *   one, nothing is deduplicated.
+     * * A replayed `screenshot_url` is the original one and may have
+     *   expired; take a new screenshot to get a fresh URL.
+     *
+     * Keys are scoped to the workspace and the operation. Refusals before
+     * the action is sent (validation, access, `402`, `503
+     * meter_unavailable`) do not use up the key. If the key cannot be
+     * recorded the action is not sent and the response is `503
+     * idempotency_unavailable`.
+     */
+    "Idempotency-Key"?: string;
+    command: string;
+}

package/dist/api/resources/devices/client/requests/ShellInput.js

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

package/dist/api/resources/devices/client/requests/StartAppInput.d.ts

@@ -0,0 +1,58 @@
+import * as Lusor from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         workspaceId: "workspaceId",
+ *         deviceId: "deviceId",
+ *         "package": "package"
+ *     }
+ */
+export interface StartAppInput {
+    /** Workspace UUID. Caller must have access. */
+    workspaceId: string;
+    /** Device id (paired into the workspace). */
+    deviceId: string;
+    /**
+     * Makes a retry of this device action safe. Send a fresh key (for
+     * example a UUID) per action and the same key when you retry it.
+     *
+     * * The first request with a key runs the action and its result is
+     *   kept for 24 hours, whatever it was (success or error).
+     * * A repeat with the same key and the same request returns that
+     *   result unchanged, without running the action again and without
+     *   counting Lusor Phone minutes, with the header
+     *   `Idempotent-Replayed: true`.
+     * * A repeat while the first is still running returns
+     *   `409 idempotency_key_in_use`. If the first never finished (the
+     *   server stopped mid-request) a repeat returns
+     *   `409 idempotency_outcome_unknown`; the action is not run again, so
+     *   check the device and use a new key.
+     * * The same key with a different request (path, query or body)
+     *   returns `422 idempotency_key_reused`.
+     * * A key that is not 1–255 visible ASCII characters returns `400
+     *   invalid_idempotency_key`. Without the header, or with an empty
+     *   one, nothing is deduplicated.
+     * * A replayed `screenshot_url` is the original one and may have
+     *   expired; take a new screenshot to get a fresh URL.
+     *
+     * Keys are scoped to the workspace and the operation. Refusals before
+     * the action is sent (validation, access, `402`, `503
+     * meter_unavailable`) do not use up the key. If the key cannot be
+     * recorded the action is not sent and the response is `503
+     * idempotency_unavailable`.
+     */
+    "Idempotency-Key"?: string;
+    /**
+     * Dotted Java identifier, first segment letter-led. Case-insensitive
+     * (the runtime regex carries the `i` flag). A value such as
+     * `com.x; reboot` is rejected with a 400.
+     */
+    package: string;
+    /**
+     * Relative-or-fully-qualified Android activity name; a leading `.`
+     * (`.MainActivity`) is accepted. Validated against the same regex
+     * before dispatch.
+     */
+    activity?: string;
+    capture?: Lusor.CaptureField;
+}

package/dist/api/resources/devices/client/requests/StartAppInput.js

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

package/dist/api/resources/devices/client/requests/StateDevicesRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @example
+ *     {
+ *         workspaceId: "workspaceId",
+ *         deviceId: "deviceId"
+ *     }
+ */
+export interface StateDevicesRequest {
+    /** Workspace UUID. Caller must have access. */
+    workspaceId: string;
+    /** Device id (paired into the workspace). */
+    deviceId: string;
+}

package/dist/api/resources/devices/client/requests/StateDevicesRequest.js

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

package/dist/api/resources/devices/client/requests/StopAppInput.d.ts

@@ -0,0 +1,51 @@
+import * as Lusor from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         workspaceId: "workspaceId",
+ *         deviceId: "deviceId",
+ *         "package": "package"
+ *     }
+ */
+export interface StopAppInput {
+    /** Workspace UUID. Caller must have access. */
+    workspaceId: string;
+    /** Device id (paired into the workspace). */
+    deviceId: string;
+    /**
+     * Makes a retry of this device action safe. Send a fresh key (for
+     * example a UUID) per action and the same key when you retry it.
+     *
+     * * The first request with a key runs the action and its result is
+     *   kept for 24 hours, whatever it was (success or error).
+     * * A repeat with the same key and the same request returns that
+     *   result unchanged, without running the action again and without
+     *   counting Lusor Phone minutes, with the header
+     *   `Idempotent-Replayed: true`.
+     * * A repeat while the first is still running returns
+     *   `409 idempotency_key_in_use`. If the first never finished (the
+     *   server stopped mid-request) a repeat returns
+     *   `409 idempotency_outcome_unknown`; the action is not run again, so
+     *   check the device and use a new key.
+     * * The same key with a different request (path, query or body)
+     *   returns `422 idempotency_key_reused`.
+     * * A key that is not 1–255 visible ASCII characters returns `400
+     *   invalid_idempotency_key`. Without the header, or with an empty
+     *   one, nothing is deduplicated.
+     * * A replayed `screenshot_url` is the original one and may have
+     *   expired; take a new screenshot to get a fresh URL.
+     *
+     * Keys are scoped to the workspace and the operation. Refusals before
+     * the action is sent (validation, access, `402`, `503
+     * meter_unavailable`) do not use up the key. If the key cannot be
+     * recorded the action is not sent and the response is `503
+     * idempotency_unavailable`.
+     */
+    "Idempotency-Key"?: string;
+    /**
+     * Dotted Java identifier, first segment letter-led. Case-insensitive;
+     * validated against the same regex as `apps/start`.
+     */
+    package: string;
+    capture?: Lusor.CaptureField;
+}

package/dist/api/resources/devices/client/requests/StopAppInput.js

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

package/dist/api/resources/devices/client/requests/SwipeInput.d.ts

@@ -0,0 +1,61 @@
+import * as Lusor from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         workspaceId: "workspaceId",
+ *         deviceId: "deviceId",
+ *         startX: 1.1,
+ *         startY: 1.1,
+ *         endX: 1.1,
+ *         endY: 1.1
+ *     }
+ */
+export interface SwipeInput {
+    /** Workspace UUID. Caller must have access. */
+    workspaceId: string;
+    /** Device id (paired into the workspace). */
+    deviceId: string;
+    /**
+     * Makes a retry of this device action safe. Send a fresh key (for
+     * example a UUID) per action and the same key when you retry it.
+     *
+     * * The first request with a key runs the action and its result is
+     *   kept for 24 hours, whatever it was (success or error).
+     * * A repeat with the same key and the same request returns that
+     *   result unchanged, without running the action again and without
+     *   counting Lusor Phone minutes, with the header
+     *   `Idempotent-Replayed: true`.
+     * * A repeat while the first is still running returns
+     *   `409 idempotency_key_in_use`. If the first never finished (the
+     *   server stopped mid-request) a repeat returns
+     *   `409 idempotency_outcome_unknown`; the action is not run again, so
+     *   check the device and use a new key.
+     * * The same key with a different request (path, query or body)
+     *   returns `422 idempotency_key_reused`.
+     * * A key that is not 1–255 visible ASCII characters returns `400
+     *   invalid_idempotency_key`. Without the header, or with an empty
+     *   one, nothing is deduplicated.
+     * * A replayed `screenshot_url` is the original one and may have
+     *   expired; take a new screenshot to get a fresh URL.
+     *
+     * Keys are scoped to the workspace and the operation. Refusals before
+     * the action is sent (validation, access, `402`, `503
+     * meter_unavailable`) do not use up the key. If the key cannot be
+     * recorded the action is not sent and the response is `503
+     * idempotency_unavailable`.
+     */
+    "Idempotency-Key"?: string;
+    startX: number;
+    startY: number;
+    endX: number;
+    endY: number;
+    durationMs?: number;
+    /**
+     * Follow a curved, eased path between the two points instead of a
+     * straight line at constant speed. The duration is unchanged.
+     * Returns `412 unsupported_stealth_input` when the phone's agent
+     * cannot do it.
+     */
+    stealth?: boolean;
+    capture?: Lusor.CaptureField;
+}

package/dist/api/resources/devices/client/requests/SwipeInput.js

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

package/dist/api/resources/devices/client/requests/TakeScreenshotDevicesRequest.d.ts

@@ -0,0 +1,46 @@
+import * as Lusor from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         workspaceId: "workspaceId",
+ *         deviceId: "deviceId",
+ *         body: {}
+ *     }
+ */
+export interface TakeScreenshotDevicesRequest {
+    /** Workspace UUID. Caller must have access. */
+    workspaceId: string;
+    /** Device id (paired into the workspace). */
+    deviceId: string;
+    /**
+     * Makes a retry of this device action safe. Send a fresh key (for
+     * example a UUID) per action and the same key when you retry it.
+     *
+     * * The first request with a key runs the action and its result is
+     *   kept for 24 hours, whatever it was (success or error).
+     * * A repeat with the same key and the same request returns that
+     *   result unchanged, without running the action again and without
+     *   counting Lusor Phone minutes, with the header
+     *   `Idempotent-Replayed: true`.
+     * * A repeat while the first is still running returns
+     *   `409 idempotency_key_in_use`. If the first never finished (the
+     *   server stopped mid-request) a repeat returns
+     *   `409 idempotency_outcome_unknown`; the action is not run again, so
+     *   check the device and use a new key.
+     * * The same key with a different request (path, query or body)
+     *   returns `422 idempotency_key_reused`.
+     * * A key that is not 1–255 visible ASCII characters returns `400
+     *   invalid_idempotency_key`. Without the header, or with an empty
+     *   one, nothing is deduplicated.
+     * * A replayed `screenshot_url` is the original one and may have
+     *   expired; take a new screenshot to get a fresh URL.
+     *
+     * Keys are scoped to the workspace and the operation. Refusals before
+     * the action is sent (validation, access, `402`, `503
+     * meter_unavailable`) do not use up the key. If the key cannot be
+     * recorded the action is not sent and the response is `503
+     * idempotency_unavailable`.
+     */
+    "Idempotency-Key"?: string;
+    body?: Lusor.EmptyVerbInput;
+}

package/dist/api/resources/devices/client/requests/TakeScreenshotDevicesRequest.js

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

package/dist/api/resources/devices/client/requests/TapInput.d.ts

@@ -0,0 +1,58 @@
+import * as Lusor from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         workspaceId: "workspaceId",
+ *         deviceId: "deviceId"
+ *     }
+ */
+export interface TapInput {
+    /** Workspace UUID. Caller must have access. */
+    workspaceId: string;
+    /** Device id (paired into the workspace). */
+    deviceId: string;
+    /**
+     * Makes a retry of this device action safe. Send a fresh key (for
+     * example a UUID) per action and the same key when you retry it.
+     *
+     * * The first request with a key runs the action and its result is
+     *   kept for 24 hours, whatever it was (success or error).
+     * * A repeat with the same key and the same request returns that
+     *   result unchanged, without running the action again and without
+     *   counting Lusor Phone minutes, with the header
+     *   `Idempotent-Replayed: true`.
+     * * A repeat while the first is still running returns
+     *   `409 idempotency_key_in_use`. If the first never finished (the
+     *   server stopped mid-request) a repeat returns
+     *   `409 idempotency_outcome_unknown`; the action is not run again, so
+     *   check the device and use a new key.
+     * * The same key with a different request (path, query or body)
+     *   returns `422 idempotency_key_reused`.
+     * * A key that is not 1–255 visible ASCII characters returns `400
+     *   invalid_idempotency_key`. Without the header, or with an empty
+     *   one, nothing is deduplicated.
+     * * A replayed `screenshot_url` is the original one and may have
+     *   expired; take a new screenshot to get a fresh URL.
+     *
+     * Keys are scoped to the workspace and the operation. Refusals before
+     * the action is sent (validation, access, `402`, `503
+     * meter_unavailable`) do not use up the key. If the key cannot be
+     * recorded the action is not sent and the response is `503
+     * idempotency_unavailable`.
+     */
+    "Idempotency-Key"?: string;
+    /** 1-based interactive element index from `/state.a11yTree`. */
+    index?: number;
+    /** Pixel x-coordinate (alternative to `index`). */
+    x?: number;
+    /** Pixel y-coordinate (alternative to `index`). */
+    y?: number;
+    /**
+     * Inject this tap the way a person would: the press held 45–110 ms
+     * instead of a single frame, and the point nudged by up to 2 px.
+     * Returns `412 unsupported_stealth_input` when the phone's agent
+     * cannot do it; it is never silently downgraded.
+     */
+    stealth?: boolean;
+    capture?: Lusor.CaptureField;
+}

package/dist/api/resources/devices/client/requests/TapInput.js

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