@anduril-industries/lattice-sdk 3.0.0 → 4.0.0

package/README.md

@@ -6,6 +6,30 @@
 
 The Lattice SDK TypeScript library provides convenient access to the Lattice SDK APIs from TypeScript.
 
+## Table of Contents
+
+- [Documentation](#documentation)
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Support](#support)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Request and Response Types](#request-and-response-types)
+- [Exception Handling](#exception-handling)
+- [Streaming Response](#streaming-response)
+- [File Uploads](#file-uploads)
+- [Binary Response](#binary-response)
+- [Pagination](#pagination)
+- [Advanced](#advanced)
+  - [Additional Headers](#additional-headers)
+  - [Additional Query String Parameters](#additional-query-string-parameters)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Aborting Requests](#aborting-requests)
+  - [Access Raw Response Data](#access-raw-response-data)
+  - [Logging](#logging)
+  - [Runtime Compatibility](#runtime-compatibility)
+
 ## Documentation
 
 API reference documentation is available [here](https://developer.anduril.com/).
@@ -43,7 +67,7 @@ await client.entities.longPollEntityEvents({
 });
 ```
 
-## Request And Response Types
+## Request and Response Types
 
 The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
 following namespace:
@@ -51,7 +75,7 @@ following namespace:
 ```typescript
 import { Lattice } from "@anduril-industries/lattice-sdk";
 
-const request: Lattice.EntityOverride = {
+const request: Lattice.GetEntityRequest = {
     ...
 };
 ```
@@ -76,6 +100,21 @@ try {
 }
 ```
 
+## Streaming Response
+
+Some endpoints return streaming responses instead of returning the full response at once.
+The SDK uses async iterators, so you can consume the responses using a `for await...of` loop.
+
+```typescript
+import { LatticeClient } from "@anduril-industries/lattice-sdk";
+
+const client = new LatticeClient({ token: "YOUR_TOKEN" });
+const response = await client.entities.streamEntities();
+for await (const item of response) {
+    console.log(item);
+}
+```
+
 ## File Uploads
 
 You can upload files using the client:
@@ -518,26 +557,19 @@ List endpoints are paginated. The SDK provides an iterator so that you can simpl
 import { LatticeClient } from "@anduril-industries/lattice-sdk";
 
 const client = new LatticeClient({ token: "YOUR_TOKEN" });
-const response = await client.objects.listObjects({
-    prefix: "prefix",
-    sinceTimestamp: "2024-01-15T09:30:00Z",
-    pageToken: "pageToken",
-    allObjectsInMesh: true
-});
-for await (const item of response) {
+const pageableResponse = await client.objects.listObjects();
+for await (const item of pageableResponse) {
     console.log(item);
 }
 
 // Or you can manually iterate page-by-page
-let page = await client.objects.listObjects({
-    prefix: "prefix",
-    sinceTimestamp: "2024-01-15T09:30:00Z",
-    pageToken: "pageToken",
-    allObjectsInMesh: true
-});
+let page = await client.objects.listObjects();
 while (page.hasNextPage()) {
     page = page.getNextPage();
 }
+
+// You can also access the underlying response
+const response = page.response;
 ```
 
 ## Advanced
@@ -547,6 +579,15 @@ while (page.hasNextPage()) {
 If you would like to send additional headers as part of the request, use the `headers` request option.
 
 ```typescript
+import { LatticeClient } from "@anduril-industries/lattice-sdk";
+
+const client = new LatticeClient({
+    ...
+    headers: {
+        'X-Custom-Header': 'custom value'
+    }
+});
+
 const response = await client.entities.longPollEntityEvents(..., {
     headers: {
         'X-Custom-Header': 'custom value'
@@ -620,6 +661,69 @@ console.log(data);
 console.log(rawResponse.headers['X-My-Header']);
 ```
 
+### Logging
+
+The SDK supports logging. You can configure the logger by passing in a `logging` object to the client options.
+
+```typescript
+import { LatticeClient, logging } from "@anduril-industries/lattice-sdk";
+
+const client = new LatticeClient({
+    ...
+    logging: {
+        level: logging.LogLevel.Debug, // defaults to logging.LogLevel.Info
+        logger: new logging.ConsoleLogger(), // defaults to ConsoleLogger
+        silent: false, // defaults to true, set to false to enable logging
+    }
+});
+```
+The `logging` object can have the following properties:
+- `level`: The log level to use. Defaults to `logging.LogLevel.Info`.
+- `logger`: The logger to use. Defaults to a `logging.ConsoleLogger`.
+- `silent`: Whether to silence the logger. Defaults to `true`.
+
+The `level` property can be one of the following values:
+- `logging.LogLevel.Debug`
+- `logging.LogLevel.Info`
+- `logging.LogLevel.Warn`
+- `logging.LogLevel.Error`
+
+To provide a custom logger, you can pass in an object that implements the `logging.ILogger` interface.
+
+<details>
+<summary>Custom logger examples</summary>
+
+Here's an example using the popular `winston` logging library.
+```ts
+import winston from 'winston';
+
+const winstonLogger = winston.createLogger({...});
+
+const logger: logging.ILogger = {
+    debug: (msg, ...args) => winstonLogger.debug(msg, ...args),
+    info: (msg, ...args) => winstonLogger.info(msg, ...args),
+    warn: (msg, ...args) => winstonLogger.warn(msg, ...args),
+    error: (msg, ...args) => winstonLogger.error(msg, ...args),
+};
+```
+
+Here's an example using the popular `pino` logging library.
+
+```ts
+import pino from 'pino';
+
+const pinoLogger = pino({...});
+
+const logger: logging.ILogger = {
+  debug: (msg, ...args) => pinoLogger.debug(args, msg),
+  info: (msg, ...args) => pinoLogger.info(args, msg),
+  warn: (msg, ...args) => pinoLogger.warn(args, msg),
+  error: (msg, ...args) => pinoLogger.error(args, msg),
+};
+```
+</details>
+
+
 ### Runtime Compatibility
 
 

package/dist/cjs/BaseClient.d.ts

@@ -1,17 +1,21 @@
-import type * as core from "./core/index.js";
+import { BearerAuthProvider } from "./auth/BearerAuthProvider.js";
+import * as core from "./core/index.js";
 import type * as environments from "./environments.js";
-export interface BaseClientOptions {
+export type BaseClientOptions = {
     environment?: core.Supplier<environments.LatticeEnvironment | string>;
     /** Specify a custom URL to connect the client to. */
     baseUrl?: core.Supplier<string>;
-    token?: core.Supplier<core.BearerToken | undefined>;
     /** Additional headers to include in requests. */
     headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     /** The default maximum time to wait for a response in seconds. */
     timeoutInSeconds?: number;
     /** The default number of times to retry the request. Defaults to 2. */
     maxRetries?: number;
-}
+    /** Provide a custom fetch implementation. Useful for platforms that don't have a built-in fetch or need a custom implementation. */
+    fetch?: typeof fetch;
+    /** Configure logging for the client. */
+    logging?: core.logging.LogConfig | core.logging.Logger;
+} & BearerAuthProvider.AuthOptions;
 export interface BaseRequestOptions {
     /** The maximum time to wait for a response in seconds. */
     timeoutInSeconds?: number;
@@ -24,3 +28,12 @@ export interface BaseRequestOptions {
     /** Additional headers to include in the request. */
     headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
 }
+export type NormalizedClientOptions<T extends BaseClientOptions> = T & {
+    logging: core.logging.Logger;
+    authProvider?: core.AuthProvider;
+};
+export type NormalizedClientOptionsWithAuth<T extends BaseClientOptions> = NormalizedClientOptions<T> & {
+    authProvider: core.AuthProvider;
+};
+export declare function normalizeClientOptions<T extends BaseClientOptions>(options: T): NormalizedClientOptions<T>;
+export declare function normalizeClientOptionsWithAuth<T extends BaseClientOptions>(options: T): NormalizedClientOptionsWithAuth<T>;

package/dist/cjs/BaseClient.js

@@ -1,3 +1,62 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeClientOptions = normalizeClientOptions;
+exports.normalizeClientOptionsWithAuth = normalizeClientOptionsWithAuth;
+const BearerAuthProvider_js_1 = require("./auth/BearerAuthProvider.js");
+const headers_js_1 = require("./core/headers.js");
+const core = __importStar(require("./core/index.js"));
+function normalizeClientOptions(options) {
+    const headers = (0, headers_js_1.mergeHeaders)({
+        "X-Fern-Language": "JavaScript",
+        "X-Fern-SDK-Name": "@anduril-industries/lattice-sdk",
+        "X-Fern-SDK-Version": "4.0.0",
+        "User-Agent": "@anduril-industries/lattice-sdk/4.0.0",
+        "X-Fern-Runtime": core.RUNTIME.type,
+        "X-Fern-Runtime-Version": core.RUNTIME.version,
+    }, options === null || options === void 0 ? void 0 : options.headers);
+    return Object.assign(Object.assign({}, options), { logging: core.logging.createLogger(options === null || options === void 0 ? void 0 : options.logging), headers });
+}
+function normalizeClientOptionsWithAuth(options) {
+    var _a;
+    const normalized = normalizeClientOptions(options);
+    const normalizedWithNoOpAuthProvider = withNoOpAuthProvider(normalized);
+    (_a = normalized.authProvider) !== null && _a !== void 0 ? _a : (normalized.authProvider = new BearerAuthProvider_js_1.BearerAuthProvider(normalizedWithNoOpAuthProvider));
+    return normalized;
+}
+function withNoOpAuthProvider(options) {
+    return Object.assign(Object.assign({}, options), { authProvider: new core.NoOpAuthProvider() });
+}

package/dist/cjs/Client.d.ts

@@ -1,20 +1,20 @@
-import { Entities } from "./api/resources/entities/client/Client.js";
-import { Objects } from "./api/resources/objects/client/Client.js";
-import { Tasks } from "./api/resources/tasks/client/Client.js";
+import { EntitiesClient } from "./api/resources/entities/client/Client.js";
+import { ObjectsClient } from "./api/resources/objects/client/Client.js";
+import { TasksClient } from "./api/resources/tasks/client/Client.js";
 import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "./BaseClient.js";
 export declare namespace LatticeClient {
-    interface Options extends BaseClientOptions {
-    }
+    type Options = BaseClientOptions;
     interface RequestOptions extends BaseRequestOptions {
     }
 }
 export declare class LatticeClient {
-    protected readonly _options: LatticeClient.Options;
-    protected _entities: Entities | undefined;
-    protected _tasks: Tasks | undefined;
-    protected _objects: Objects | undefined;
-    constructor(_options?: LatticeClient.Options);
-    get entities(): Entities;
-    get tasks(): Tasks;
-    get objects(): Objects;
+    protected readonly _options: NormalizedClientOptionsWithAuth<LatticeClient.Options>;
+    protected _entities: EntitiesClient | undefined;
+    protected _tasks: TasksClient | undefined;
+    protected _objects: ObjectsClient | undefined;
+    constructor(options: LatticeClient.Options);
+    get entities(): EntitiesClient;
+    get tasks(): TasksClient;
+    get objects(): ObjectsClient;
 }

package/dist/cjs/Client.js

@@ -1,67 +1,26 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LatticeClient = void 0;
 const Client_js_1 = require("./api/resources/entities/client/Client.js");
 const Client_js_2 = require("./api/resources/objects/client/Client.js");
 const Client_js_3 = require("./api/resources/tasks/client/Client.js");
-const headers_js_1 = require("./core/headers.js");
-const core = __importStar(require("./core/index.js"));
+const BaseClient_js_1 = require("./BaseClient.js");
 class LatticeClient {
-    constructor(_options = {}) {
-        this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
-                "X-Fern-Language": "JavaScript",
-                "X-Fern-SDK-Name": "@anduril-industries/lattice-sdk",
-                "X-Fern-SDK-Version": "3.0.0",
-                "User-Agent": "@anduril-industries/lattice-sdk/3.0.0",
-                "X-Fern-Runtime": core.RUNTIME.type,
-                "X-Fern-Runtime-Version": core.RUNTIME.version,
-            }, _options === null || _options === void 0 ? void 0 : _options.headers) });
+    constructor(options) {
+        this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     get entities() {
         var _a;
-        return ((_a = this._entities) !== null && _a !== void 0 ? _a : (this._entities = new Client_js_1.Entities(this._options)));
+        return ((_a = this._entities) !== null && _a !== void 0 ? _a : (this._entities = new Client_js_1.EntitiesClient(this._options)));
     }
     get tasks() {
         var _a;
-        return ((_a = this._tasks) !== null && _a !== void 0 ? _a : (this._tasks = new Client_js_3.Tasks(this._options)));
+        return ((_a = this._tasks) !== null && _a !== void 0 ? _a : (this._tasks = new Client_js_3.TasksClient(this._options)));
     }
     get objects() {
         var _a;
-        return ((_a = this._objects) !== null && _a !== void 0 ? _a : (this._objects = new Client_js_2.Objects(this._options)));
+        return ((_a = this._objects) !== null && _a !== void 0 ? _a : (this._objects = new Client_js_2.ObjectsClient(this._options)));
     }
 }
 exports.LatticeClient = LatticeClient;

package/dist/cjs/api/errors/BadRequestError.js

@@ -44,7 +44,11 @@ class BadRequestError extends errors.LatticeError {
             body: body,
             rawResponse: rawResponse,
         });
-        Object.setPrototypeOf(this, BadRequestError.prototype);
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
     }
 }
 exports.BadRequestError = BadRequestError;

package/dist/cjs/api/errors/ContentTooLargeError.js

@@ -44,7 +44,11 @@ class ContentTooLargeError extends errors.LatticeError {
             body: body,
             rawResponse: rawResponse,
         });
-        Object.setPrototypeOf(this, ContentTooLargeError.prototype);
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
     }
 }
 exports.ContentTooLargeError = ContentTooLargeError;

package/dist/cjs/api/errors/InsufficientStorageError.js

@@ -44,7 +44,11 @@ class InsufficientStorageError extends errors.LatticeError {
             body: body,
             rawResponse: rawResponse,
         });
-        Object.setPrototypeOf(this, InsufficientStorageError.prototype);
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
     }
 }
 exports.InsufficientStorageError = InsufficientStorageError;

package/dist/cjs/api/errors/InternalServerError.js

@@ -44,7 +44,11 @@ class InternalServerError extends errors.LatticeError {
             body: body,
             rawResponse: rawResponse,
         });
-        Object.setPrototypeOf(this, InternalServerError.prototype);
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
     }
 }
 exports.InternalServerError = InternalServerError;

package/dist/cjs/api/errors/NotFoundError.js

@@ -44,7 +44,11 @@ class NotFoundError extends errors.LatticeError {
             body: body,
             rawResponse: rawResponse,
         });
-        Object.setPrototypeOf(this, NotFoundError.prototype);
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
     }
 }
 exports.NotFoundError = NotFoundError;

package/dist/cjs/api/errors/RequestTimeoutError.js

@@ -44,7 +44,11 @@ class RequestTimeoutError extends errors.LatticeError {
             body: body,
             rawResponse: rawResponse,
         });
-        Object.setPrototypeOf(this, RequestTimeoutError.prototype);
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
     }
 }
 exports.RequestTimeoutError = RequestTimeoutError;

package/dist/cjs/api/errors/TooManyRequestsError.js

@@ -44,7 +44,11 @@ class TooManyRequestsError extends errors.LatticeError {
             body: body,
             rawResponse: rawResponse,
         });
-        Object.setPrototypeOf(this, TooManyRequestsError.prototype);
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
     }
 }
 exports.TooManyRequestsError = TooManyRequestsError;

package/dist/cjs/api/errors/UnauthorizedError.js

@@ -44,7 +44,11 @@ class UnauthorizedError extends errors.LatticeError {
             body: body,
             rawResponse: rawResponse,
         });
-        Object.setPrototypeOf(this, UnauthorizedError.prototype);
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
     }
 }
 exports.UnauthorizedError = UnauthorizedError;

package/dist/cjs/api/resources/entities/client/Client.d.ts

@@ -1,18 +1,18 @@
 import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
 import * as core from "../../../../core/index.js";
 import * as Lattice from "../../../index.js";
-export declare namespace Entities {
-    interface Options extends BaseClientOptions {
-    }
+export declare namespace EntitiesClient {
+    type Options = BaseClientOptions;
     interface RequestOptions extends BaseRequestOptions {
     }
 }
 /**
  * The Entities API
  */
-export declare class Entities {
-    protected readonly _options: Entities.Options;
-    constructor(_options?: Entities.Options);
+export declare class EntitiesClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<EntitiesClient.Options>;
+    constructor(options: EntitiesClient.Options);
     /**
      * Publish an entity for ingest into the Entities API. Entities created with this method are "owned" by the originator: other sources,
      * such as the UI, may not edit or delete these entities. The server validates entities at API call time and
@@ -23,7 +23,7 @@ export declare class Entities {
      * provenance.sourceUpdateTime is greater than the provenance.sourceUpdateTime of the existing entity.
      *
      * @param {Lattice.Entity} request
-     * @param {Entities.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Lattice.BadRequestError}
      * @throws {@link Lattice.UnauthorizedError}
@@ -31,20 +31,22 @@ export declare class Entities {
      * @example
      *     await client.entities.publishEntity({})
      */
-    publishEntity(request: Lattice.Entity, requestOptions?: Entities.RequestOptions): core.HttpResponsePromise<Lattice.Entity>;
+    publishEntity(request: Lattice.Entity, requestOptions?: EntitiesClient.RequestOptions): core.HttpResponsePromise<Lattice.Entity>;
     private __publishEntity;
     /**
-     * @param {string} entityId - ID of the entity to return
-     * @param {Entities.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {Lattice.GetEntityRequest} request
+     * @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Lattice.BadRequestError}
      * @throws {@link Lattice.UnauthorizedError}
      * @throws {@link Lattice.NotFoundError}
      *
      * @example
-     *     await client.entities.getEntity("entityId")
+     *     await client.entities.getEntity({
+     *         entityId: "entityId"
+     *     })
      */
-    getEntity(entityId: string, requestOptions?: Entities.RequestOptions): core.HttpResponsePromise<Lattice.Entity>;
+    getEntity(request: Lattice.GetEntityRequest, requestOptions?: EntitiesClient.RequestOptions): core.HttpResponsePromise<Lattice.Entity>;
     private __getEntity;
     /**
      * Only fields marked with overridable can be overridden. Please refer to our documentation to see the comprehensive
@@ -55,35 +57,38 @@ export declare class Entities {
      * Note that overrides are applied in an eventually consistent manner. If multiple overrides are created
      * concurrently for the same field path, the last writer wins.
      *
-     * @param {string} entityId - The unique ID of the entity to override
-     * @param {string} fieldPath - fieldPath to override
      * @param {Lattice.EntityOverride} request
-     * @param {Entities.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Lattice.BadRequestError}
      * @throws {@link Lattice.UnauthorizedError}
      * @throws {@link Lattice.NotFoundError}
      *
      * @example
-     *     await client.entities.overrideEntity("entityId", "mil_view.disposition")
+     *     await client.entities.overrideEntity({
+     *         entityId: "entityId",
+     *         fieldPath: "mil_view.disposition"
+     *     })
      */
-    overrideEntity(entityId: string, fieldPath: string, request?: Lattice.EntityOverride, requestOptions?: Entities.RequestOptions): core.HttpResponsePromise<Lattice.Entity>;
+    overrideEntity(request: Lattice.EntityOverride, requestOptions?: EntitiesClient.RequestOptions): core.HttpResponsePromise<Lattice.Entity>;
     private __overrideEntity;
     /**
      * This operation clears the override value from the specified field path on the entity.
      *
-     * @param {string} entityId - The unique ID of the entity to undo an override from.
-     * @param {string} fieldPath - The fieldPath to clear overrides from.
-     * @param {Entities.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {Lattice.RemoveEntityOverrideRequest} request
+     * @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Lattice.BadRequestError}
      * @throws {@link Lattice.UnauthorizedError}
      * @throws {@link Lattice.NotFoundError}
      *
      * @example
-     *     await client.entities.removeEntityOverride("entityId", "mil_view.disposition")
+     *     await client.entities.removeEntityOverride({
+     *         entityId: "entityId",
+     *         fieldPath: "mil_view.disposition"
+     *     })
      */
-    removeEntityOverride(entityId: string, fieldPath: string, requestOptions?: Entities.RequestOptions): core.HttpResponsePromise<Lattice.Entity>;
+    removeEntityOverride(request: Lattice.RemoveEntityOverrideRequest, requestOptions?: EntitiesClient.RequestOptions): core.HttpResponsePromise<Lattice.Entity>;
     private __removeEntityOverride;
     /**
      * This is a long polling API that will first return all pre-existing data and then return all new data as
@@ -97,7 +102,7 @@ export declare class Entities {
      * In this case you must start a new session by sending a request with an empty session token.
      *
      * @param {Lattice.EntityEventRequest} request
-     * @param {Entities.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Lattice.BadRequestError}
      * @throws {@link Lattice.UnauthorizedError}
@@ -110,12 +115,29 @@ export declare class Entities {
      *         sessionToken: "sessionToken"
      *     })
      */
-    longPollEntityEvents(request: Lattice.EntityEventRequest, requestOptions?: Entities.RequestOptions): core.HttpResponsePromise<Lattice.EntityEventResponse>;
+    longPollEntityEvents(request: Lattice.EntityEventRequest, requestOptions?: EntitiesClient.RequestOptions): core.HttpResponsePromise<Lattice.EntityEventResponse>;
     private __longPollEntityEvents;
     /**
-     * Establishes a persistent connection to stream entity events as they occur.
+     * Establishes a server-sent events (SSE) connection that streams entity data in real-time.
+     * This is a one-way connection from server to client that follows the SSE protocol with text/event-stream content type.
+     *
+     * This endpoint enables clients to maintain a real-time view of the common operational picture (COP)
+     * by first streaming all pre-existing entities that match filter criteria, then continuously delivering
+     * updates as entities are created, modified, or deleted.
+     *
+     * The server first sends events with type PREEXISTING for all live entities matching the filter that existed before the stream was open,
+     * then streams CREATE events for newly created entities, UPDATE events when existing entities change, and DELETED events when entities are removed. The stream remains open
+     * indefinitely unless preExistingOnly is set to true.
+     *
+     * Heartbeat messages can be configured to maintain connection health and detect disconnects by setting the heartbeatIntervalMS
+     * parameter. These heartbeats help keep the connection alive and allow clients to verify the server is still responsive.
+     *
+     * Clients can optimize bandwidth usage by specifying which entity components they need populated using the componentsToInclude parameter.
+     * This allows receiving only relevant data instead of complete entities.
+     *
+     * The connection automatically recovers from temporary disconnections, resuming the stream where it left off. Unlike polling approaches,
+     * this provides real-time updates with minimal latency and reduced server load.
      */
-    streamEntities(request?: Lattice.EntityStreamRequest, requestOptions?: Entities.RequestOptions): core.HttpResponsePromise<core.Stream<Lattice.StreamEntitiesResponse>>;
+    streamEntities(request?: Lattice.EntityStreamRequest, requestOptions?: EntitiesClient.RequestOptions): core.HttpResponsePromise<core.Stream<Lattice.StreamEntitiesResponse>>;
     private __streamEntities;
-    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }