@lusor/sdk 0.0.0-stage → 1.0.0

package/dist/api/types/DeviceControlState.js

@@ -0,0 +1,18 @@
+// This file was auto-generated by Fern from our API Definition.
+/**
+ * `pending` while the change is applied, then `applied`, `failed` or
+ * `unknown`. `null` when no change was ever made.
+ *
+ * The reported value is the one the phone was actually given: a `failed`
+ * or `unknown` change never changes it.
+ *
+ * `unknown` means the phone may or may not have taken the change. Further
+ * changes are refused (`phone_busy`) until support resolves it, so an
+ * irreversible advertising-ID reset is never repeated on its own.
+ */
+export const DeviceControlState = {
+    Pending: "pending",
+    Applied: "applied",
+    Failed: "failed",
+    Unknown: "unknown",
+};

package/dist/api/types/DeviceGeo.d.ts

@@ -0,0 +1,37 @@
+export interface DeviceGeo {
+    /** `auto` follows the Internet exit IP; `override` is a value set with `PUT /geo`. */
+    mode: DeviceGeo.Mode;
+    /** The latitude the phone was last given; null when none is known yet. */
+    latitude: number | null;
+    longitude: number | null;
+    timezone: string | null;
+    /** Override mode only. Whether the phone has been given the override. */
+    apply: DeviceGeo.Apply | null;
+}
+export declare namespace DeviceGeo {
+    /** `auto` follows the Internet exit IP; `override` is a value set with `PUT /geo`. */
+    const Mode: {
+        readonly Auto: "auto";
+        readonly Override: "override";
+    };
+    type Mode = (typeof Mode)[keyof typeof Mode];
+    /**
+     * Override mode only. Whether the phone has been given the override.
+     */
+    interface Apply {
+        state: Apply.State;
+        /** `held` only: `lifecycle` (restarting or resetting; applied when it finishes) or `no_pad`. */
+        reason?: string | undefined;
+        /** `failed` only: `geo_apply_failed`. Send the PUT again to retry. */
+        error?: string | undefined;
+    }
+    namespace Apply {
+        const State: {
+            readonly Pending: "pending";
+            readonly Applied: "applied";
+            readonly Held: "held";
+            readonly Failed: "failed";
+        };
+        type State = (typeof State)[keyof typeof State];
+    }
+}

package/dist/api/types/DeviceGeo.js

@@ -0,0 +1,18 @@
+// This file was auto-generated by Fern from our API Definition.
+export var DeviceGeo;
+(function (DeviceGeo) {
+    /** `auto` follows the Internet exit IP; `override` is a value set with `PUT /geo`. */
+    DeviceGeo.Mode = {
+        Auto: "auto",
+        Override: "override",
+    };
+    let Apply;
+    (function (Apply) {
+        Apply.State = {
+            Pending: "pending",
+            Applied: "applied",
+            Held: "held",
+            Failed: "failed",
+        };
+    })(Apply = DeviceGeo.Apply || (DeviceGeo.Apply = {}));
+})(DeviceGeo || (DeviceGeo = {}));

package/dist/api/types/DeviceIdentity.d.ts

@@ -0,0 +1,9 @@
+import * as Lusor from "../index.js";
+export interface DeviceIdentity {
+    fields: Lusor.DeviceIdentityFields;
+    state: Lusor.DeviceControlState | null;
+    /** The values were written and the phone's restart was queued; they take effect when it completes. */
+    restartQueued: boolean;
+    error: Lusor.DeviceControlError | null;
+    inProgress: Lusor.DeviceControlInProgress | null;
+}

package/dist/api/types/DeviceIdentity.js

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

package/dist/api/types/DeviceIdentityFields.d.ts

@@ -0,0 +1,16 @@
+/**
+ * At least one field. Text fields are 1-64 letters, digits, spaces or `. _ + -`.
+ */
+export interface DeviceIdentityFields {
+    brand?: string | undefined;
+    manufacturer?: string | undefined;
+    model?: string | undefined;
+    /** Device codename (`ro.product.device`). */
+    device?: string | undefined;
+    /** Product name (`ro.product.name`). */
+    name?: string | undefined;
+    /** Build fingerprint: `brand/name/device:release/id/incremental:type/tags`. */
+    fingerprint?: string | undefined;
+    /** The Android ID, 16 hex digits. */
+    androidId?: string | undefined;
+}

package/dist/api/types/DeviceIdentityFields.js

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

package/dist/api/types/DeviceInternetLocation.d.ts

@@ -0,0 +1,28 @@
+import * as Lusor from "../index.js";
+export interface DeviceInternetLocation {
+    /** ISO 3166-1 alpha-2, lowercase. */
+    country: string;
+    /** Changes each time the phone's route changes; null until it has one. */
+    generation: number | null;
+    applied: DeviceInternetLocation.Applied;
+    network: DeviceInternetLocation.Network;
+    route: DeviceInternetLocation.Route;
+    static: Lusor.DeviceStaticIp | null;
+}
+export declare namespace DeviceInternetLocation {
+    const Applied: {
+        readonly Route: "route";
+        readonly Pending: "pending";
+    };
+    type Applied = (typeof Applied)[keyof typeof Applied];
+    const Network: {
+        readonly Home: "home";
+        readonly Mobile: "mobile";
+    };
+    type Network = (typeof Network)[keyof typeof Network];
+    const Route: {
+        readonly Static: "static";
+        readonly Residential: "residential";
+    };
+    type Route = (typeof Route)[keyof typeof Route];
+}

package/dist/api/types/DeviceInternetLocation.js

@@ -0,0 +1,16 @@
+// This file was auto-generated by Fern from our API Definition.
+export var DeviceInternetLocation;
+(function (DeviceInternetLocation) {
+    DeviceInternetLocation.Applied = {
+        Route: "route",
+        Pending: "pending",
+    };
+    DeviceInternetLocation.Network = {
+        Home: "home",
+        Mobile: "mobile",
+    };
+    DeviceInternetLocation.Route = {
+        Static: "static",
+        Residential: "residential",
+    };
+})(DeviceInternetLocation || (DeviceInternetLocation = {}));

package/dist/api/types/DeviceLanguage.d.ts

@@ -0,0 +1,8 @@
+import * as Lusor from "../index.js";
+export interface DeviceLanguage {
+    language: string | null;
+    country: string | null;
+    state: Lusor.DeviceControlState | null;
+    error: Lusor.DeviceControlError | null;
+    inProgress: Lusor.DeviceControlInProgress | null;
+}

package/dist/api/types/DeviceLanguage.js

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

package/dist/api/types/DeviceOccupancy.d.ts

@@ -0,0 +1,39 @@
+export interface DeviceOccupancy {
+    /** The run holding the phone; null when it is idle. */
+    active: DeviceOccupancy.Active | null;
+    /** Agent turns waiting for the phone, oldest first. */
+    queue: DeviceOccupancy.Queue.Item[];
+    /** Agents attached to the phone. */
+    assigned: DeviceOccupancy.Assigned.Item[];
+}
+export declare namespace DeviceOccupancy {
+    /**
+     * The run holding the phone; null when it is idle.
+     */
+    interface Active {
+        agentId: string | null;
+        agentName: string | null;
+        agentColor: string | null;
+        sessionId: string;
+        startedAt: string | null;
+    }
+    type Queue = Queue.Item[];
+    namespace Queue {
+        interface Item {
+            agentId: string;
+            agentName: string;
+            agentColor: string;
+            sessionId: string;
+            queuedAt: string;
+        }
+    }
+    type Assigned = Assigned.Item[];
+    namespace Assigned {
+        interface Item {
+            agentId: string;
+            agentName: string;
+            agentColor: string;
+            label: string | null;
+        }
+    }
+}

package/dist/api/types/DeviceOccupancy.js

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

package/dist/api/types/DeviceRemoveResult.d.ts

@@ -0,0 +1,8 @@
+export interface DeviceRemoveResult {
+    status: string;
+    /** Lusor Phones on the plan after the removal. */
+    quantity: number;
+    paymentPending: boolean;
+    /** The phone being wiped and released. */
+    deviceId: string;
+}

package/dist/api/types/DeviceRemoveResult.js

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

package/dist/api/types/DeviceReset.d.ts

@@ -0,0 +1,35 @@
+export interface DeviceReset {
+    device_id: string;
+    attempt: number;
+    state: DeviceReset.State;
+    reason: string | null;
+    device_status: string | null;
+    /** How the phone's Internet connection was restored after the reset; null before it ran. */
+    internet: DeviceReset.Internet | null;
+    requested_at: string | null;
+    finished_at: string | null;
+}
+export declare namespace DeviceReset {
+    const State: {
+        readonly Idle: "idle";
+        readonly Running: "running";
+        readonly Succeeded: "succeeded";
+        readonly Refused: "refused";
+        readonly Failed: "failed";
+    };
+    type State = (typeof State)[keyof typeof State];
+    interface Internet {
+        status: Internet.Status;
+        /** Present when `status` is `held`. */
+        reason?: string | undefined;
+    }
+    namespace Internet {
+        const Status: {
+            readonly Bound: "bound";
+            readonly NeedsProxyReassign: "needs_proxy_reassign";
+            readonly Held: "held";
+            readonly Failed: "failed";
+        };
+        type Status = (typeof Status)[keyof typeof Status];
+    }
+}

package/dist/api/types/DeviceReset.js

@@ -0,0 +1,20 @@
+// This file was auto-generated by Fern from our API Definition.
+export var DeviceReset;
+(function (DeviceReset) {
+    DeviceReset.State = {
+        Idle: "idle",
+        Running: "running",
+        Succeeded: "succeeded",
+        Refused: "refused",
+        Failed: "failed",
+    };
+    let Internet;
+    (function (Internet) {
+        Internet.Status = {
+            Bound: "bound",
+            NeedsProxyReassign: "needs_proxy_reassign",
+            Held: "held",
+            Failed: "failed",
+        };
+    })(Internet = DeviceReset.Internet || (DeviceReset.Internet = {}));
+})(DeviceReset || (DeviceReset = {}));

package/dist/api/types/DeviceState.d.ts

@@ -0,0 +1,21 @@
+export interface DeviceState {
+    deviceId: string;
+    phoneState: Record<string, unknown>;
+    deviceContext: DeviceState.DeviceContext;
+    /**
+     * Formatted UI element tree with 1-based interactive indices.
+     * Use `[N]` in `POST /tap { index: N }` to tap the Nth
+     * interactive element. On an iPhone it is the iOS
+     * accessibility tree, each frame `{{x, y}, {width, height}}`
+     * in points, and `[N]` taps the centre of that frame.
+     */
+    a11yTree: string;
+}
+export declare namespace DeviceState {
+    interface DeviceContext {
+        screenWidth: number;
+        screenHeight: number;
+        interactiveCount: number;
+        elementCount: number;
+    }
+}

package/dist/api/types/DeviceState.js

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

package/dist/api/types/DeviceStaticIp.d.ts

@@ -0,0 +1,18 @@
+export interface DeviceStaticIp {
+    state: DeviceStaticIp.State;
+    /** ISO 3166-1 alpha-2, lowercase. */
+    country: string | null;
+    /** The address the phone's traffic exits from. */
+    publicIp: string | null;
+    /** End of the paid term. */
+    expiresAt: string | null;
+}
+export declare namespace DeviceStaticIp {
+    const State: {
+        readonly Active: "active";
+        readonly Provisioning: "provisioning";
+        readonly NeedsReview: "needs_review";
+        readonly Disabled: "disabled";
+    };
+    type State = (typeof State)[keyof typeof State];
+}

package/dist/api/types/DeviceStaticIp.js

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+export var DeviceStaticIp;
+(function (DeviceStaticIp) {
+    DeviceStaticIp.State = {
+        Active: "active",
+        Provisioning: "provisioning",
+        NeedsReview: "needs_review",
+        Disabled: "disabled",
+    };
+})(DeviceStaticIp || (DeviceStaticIp = {}));

package/dist/api/types/DeviceStaticIpStatus.d.ts

@@ -0,0 +1,17 @@
+import * as Lusor from "../index.js";
+export interface DeviceStaticIpStatus {
+    state: DeviceStaticIpStatus.State;
+    /** Absent while an operation is in progress. */
+    static?: (Lusor.DeviceStaticIp | null) | undefined;
+    /** Present while an operation is in progress. Pass it as `operation` to poll. */
+    operationId?: string | undefined;
+}
+export declare namespace DeviceStaticIpStatus {
+    const State: {
+        readonly Active: "active";
+        readonly Provisioning: "provisioning";
+        readonly NeedsReview: "needs_review";
+        readonly Disabled: "disabled";
+    };
+    type State = (typeof State)[keyof typeof State];
+}

package/dist/api/types/DeviceStaticIpStatus.js

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+export var DeviceStaticIpStatus;
+(function (DeviceStaticIpStatus) {
+    DeviceStaticIpStatus.State = {
+        Active: "active",
+        Provisioning: "provisioning",
+        NeedsReview: "needs_review",
+        Disabled: "disabled",
+    };
+})(DeviceStaticIpStatus || (DeviceStaticIpStatus = {}));

package/dist/api/types/EmailAddress.d.ts

@@ -0,0 +1,11 @@
+export interface EmailAddress {
+    id: string;
+    /** Canonical lowercase agent mailbox address, unique across workspaces. */
+    address: string;
+    /**
+     * True when the address is included free with the tenant's paid phones,
+     * false when it is a paid Inbox address, null when billing could not
+     * be read (the list is still returned).
+     */
+    included: boolean | null;
+}

package/dist/api/types/EmailAddress.js

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

package/dist/api/types/EmailAddressListResponse.d.ts

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

package/dist/api/types/EmailAddressListResponse.js

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

package/dist/api/types/EmailMessage.d.ts

@@ -0,0 +1,15 @@
+export interface EmailMessage {
+    id: string;
+    /** Recipient Agent Mail address the message was delivered to. */
+    addressId: string;
+    /** Stored display name, or null when the message carried none. Not a verified identity. */
+    senderName: string | null;
+    /** Stored sender mailbox, or null when the message carried none. Not a verified identity. */
+    senderAddress: string | null;
+    /** Stored receipt timestamp with original database precision. */
+    receivedAt: string;
+    /** Stored subject line, or null when absent. Never rendered as markup. */
+    subject: string | null;
+    /** Raw stored plain-text body. Render as text, never HTML; no remote assets are fetched. */
+    body: string;
+}

package/dist/api/types/EmailMessage.js

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

package/dist/api/types/EmailMessageListResponse.d.ts

@@ -0,0 +1,6 @@
+import * as Lusor from "../index.js";
+export interface EmailMessageListResponse {
+    data: Lusor.EmailMessage[];
+    /** Pass unchanged as cursor; null when no older retained rows were observed. */
+    nextCursor: string | null;
+}

package/dist/api/types/EmailMessageListResponse.js

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

package/dist/api/types/EmptyChainStepParams.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Empty params object for verbs without inputs (`clear`, `back`,
+ * `home`, `recent`, `screenshot`). Server treats both `params: {}`
+ * and an omitted `params` as equivalent.
+ */
+export type EmptyChainStepParams = Record<string, unknown>;

package/dist/api/types/EmptyChainStepParams.js

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

package/dist/api/types/EmptyVerbInput.d.ts

@@ -0,0 +1,9 @@
+import * as Lusor from "../index.js";
+/**
+ * Body shape for empty-body verbs (`clear`, `back`, `home`,
+ * `recent`, `screenshot/trigger`). The body itself is optional;
+ * when supplied the only meaningful field is `capture`.
+ */
+export interface EmptyVerbInput {
+    capture?: Lusor.CaptureField | undefined;
+}

package/dist/api/types/EmptyVerbInput.js

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

package/dist/api/types/ErrorResponse.d.ts

@@ -0,0 +1,4 @@
+export interface ErrorResponse {
+    error: string;
+    message: string;
+}

package/dist/api/types/ErrorResponse.js

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

package/dist/api/types/HistoryPolicy.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The workspace plan's history limits, plus its history feature flags.
+ */
+export interface HistoryPolicy {
+    /** The server's clock when this was read. */
+    server_now: string;
+    /** Days of session history the plan keeps. */
+    retention_days: number;
+    /** Sessions older than this are outside the plan's window. */
+    cutoff: string;
+    /** The plan keeps history without a limit. */
+    unlimited: boolean;
+    /** Days recordings are kept. */
+    video_retention_days: number;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/api/types/HistoryPolicy.js

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

package/dist/api/types/HomeChainStep.d.ts

@@ -0,0 +1,5 @@
+import * as Lusor from "../index.js";
+export interface HomeChainStep {
+    params?: Lusor.EmptyChainStepParams | undefined;
+    capture?: Lusor.CaptureField | undefined;
+}

package/dist/api/types/HomeChainStep.js

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

package/dist/api/types/IceServer.d.ts

@@ -0,0 +1,8 @@
+export interface IceServer {
+    urls: IceServer.Urls;
+    username?: string | undefined;
+    credential?: string | undefined;
+}
+export declare namespace IceServer {
+    type Urls = string | string[];
+}

package/dist/api/types/IceServer.js

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

package/dist/api/types/IceServerIssuance.d.ts

@@ -0,0 +1,13 @@
+import * as Lusor from "../index.js";
+export interface IceServerIssuance {
+    /** Null when TURN is not available. */
+    iceServers: Lusor.IceServer[] | null;
+    /** Credential generation; increases with each rotation. */
+    generation: number;
+    /** Unix seconds. */
+    issuedAt: number;
+    /** When the credential stops working, in Unix seconds. */
+    expiresAt: number;
+    /** When the dashboard starts rotating the credential, in Unix seconds. API callers cannot rotate yet. */
+    refreshAfter: number;
+}

package/dist/api/types/IceServerIssuance.js

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

package/dist/api/types/InboxAddressAddResult.d.ts

@@ -0,0 +1,18 @@
+export interface InboxAddressAddResult {
+    /** Billing status after the change. */
+    status: string;
+    /** Paid Inbox addresses on the plan. */
+    quantity: number;
+    paymentPending: boolean;
+    /** False when this request was already applied and its address is returned again. */
+    created: boolean;
+    address: InboxAddressAddResult.Address;
+}
+export declare namespace InboxAddressAddResult {
+    interface Address {
+        id: string;
+        /** The new mailbox address. */
+        address: string;
+        workspaceId: string;
+    }
+}

package/dist/api/types/InboxAddressAddResult.js

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

package/dist/api/types/InboxAddressPreview.d.ts

@@ -0,0 +1,34 @@
+export interface InboxAddressPreview {
+    previewId: string;
+    /** Paid Inbox addresses on the plan after the change. */
+    quantity: number;
+    currency: InboxAddressPreview.Currency;
+    /** US cents charged when the change is confirmed (0 for a removal or an included address). */
+    dueToday: number;
+    /** US cents credited to the account balance when a removal is confirmed. */
+    creditToday: number;
+    /** US cents of the next full invoice after the change. */
+    totalAtRenewal: number;
+    /** Unix seconds after which the quote cannot be confirmed. */
+    expiresAt: number;
+    /** US cents */
+    subtotal: number;
+    /** US cents of tax on that invoice. */
+    tax: number;
+    /** US cents of discounts on the invoice billed now. Absent on older previews. */
+    discountToday?: number | undefined;
+    /** US cents of discounts on the renewal invoice. Absent on older previews. */
+    discountAtRenewal?: number | undefined;
+    /** US cents */
+    subtotalAtRenewal?: number | undefined;
+    /** US cents of tax on the renewal invoice. Absent on older previews. */
+    taxAtRenewal?: number | undefined;
+    /** An included address (one per paid Lusor Phone), or the removal of one; nothing is billed. */
+    free?: boolean | undefined;
+}
+export declare namespace InboxAddressPreview {
+    const Currency: {
+        readonly Usd: "usd";
+    };
+    type Currency = (typeof Currency)[keyof typeof Currency];
+}

package/dist/api/types/InboxAddressPreview.js

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+export var InboxAddressPreview;
+(function (InboxAddressPreview) {
+    InboxAddressPreview.Currency = {
+        Usd: "usd",
+    };
+})(InboxAddressPreview || (InboxAddressPreview = {}));

package/dist/api/types/InboxAddressRemoveResult.d.ts

@@ -0,0 +1,13 @@
+export interface InboxAddressRemoveResult {
+    status: string;
+    /** Paid Inbox addresses on the plan after the removal. */
+    quantity: number;
+    paymentPending: boolean;
+    address: InboxAddressRemoveResult.Address;
+}
+export declare namespace InboxAddressRemoveResult {
+    interface Address {
+        id: string;
+        deleted: boolean;
+    }
+}

package/dist/api/types/InboxAddressRemoveResult.js

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

package/dist/api/types/KeyChainStep.d.ts

@@ -0,0 +1,5 @@
+import * as Lusor from "../index.js";
+export interface KeyChainStep {
+    params: Lusor.KeyChainStepParams;
+    capture?: Lusor.CaptureField | undefined;
+}

package/dist/api/types/KeyChainStep.js

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

package/dist/api/types/KeyChainStepParams.d.ts

@@ -0,0 +1,3 @@
+export interface KeyChainStepParams {
+    keyCode: number;
+}