@paid-ai/paid-node 0.5.0-alpha2 → 0.5.0

package/README.md

@@ -104,22 +104,23 @@ vercel (Vercel AI SDK)
 Example usage with OpenAI:
 
 ```typescript
-import { PaidClient } from "@paid-ai/paid-node";
+import { initializeTracing, trace } from "@paid-ai/paid-node";
 import { PaidOpenAI } from "@paid-ai/paid-node/openai";
 import OpenAI from "openai";
 
 async function main() {
-    const client = new PaidClient({ token: "<your_paid_api_key>" });
-
     // Initialize cost tracking
-    await client.initializeTracing();
+    initializeTracing("<your_paid_api_key>");
 
     // Wrap OpenAI in paid wrapper
     const openaiClient = new OpenAI({ apiKey: "<your_openai_api_key>" });
     const paidOpenAI = new PaidOpenAI(openaiClient);
 
     // Trace the call
-    await client.trace("<your_external_customer_id>", async () => {
+    await trace({
+        externalCustomerId: "<your_external_customer_id>",
+        externalProductId: "<optional_external_product_id>"
+    }, async () => {
         const response = await paidOpenAI.images.generate({
             prompt: "A beautiful sunset over the mountains",
             n: 1,
@@ -128,34 +129,99 @@ async function main() {
         if (response.data) {
             console.log("Image generation:", response.data[0].url);
         }
-    }, "<optional_external_agent_id>");
+    });
 }
 ```
 
+### Auto-Instrumentation (OpenTelemetry Instrumentors)
+
+For maximum convenience, you can use OpenTelemetry auto-instrumentation to automatically track costs without modifying your AI library calls. This approach uses official OpenTelemetry instrumentors for supported AI libraries.
+
+#### Quick start
+
+``` typescript
+// Import and call auto-instrumentation before importing instrumented libraries
+import { paidAutoInstrument } from "@paid-ai/paid-node";
+paidAutoInstrument()
+
+import openai from "openai";
+
+// All OpenAI calls will be automatically traced
+const openAIclient = new openai.OpenAI({ apiKey: "API_KEY" })
+```
+
+#### Supported libraries
+
+Auto-instrumentation supports the following AI libraries:
+
+```
+openai
+anthropic
+bedrock
+```
+
+#### Vercel AI SDK Integration
+
+If you're using Vercel's AI SDK, you can enable automatic telemetry without any wrappers by using the `experimental_telemetry` option. When enabled, it will automatically use Paid's registered tracer provider:
+
+```typescript
+import { initializeTracing, trace } from "@paid-ai/paid-node";
+import { generateText } from "ai";
+
+async function main() {
+    initializeTracing("<your_paid_api_key>");
+    
+    await trace({
+        externalCustomerId: "<your_external_customer_id>",
+        externalProductId: "<your_external_product_id>"
+    }, async () => {
+        await generateText({
+            model: "model-name",
+            prompt: "Your prompt",
+            experimental_telemetry: { isEnabled: true }, // This will use Paid's tracer automatically
+        });
+    });
+}
+```
+
+#### Manual instrumentation
+
+``` typescript
+import { paidAutoInstrument } from "@paid-ai/paid-node";
+import openai from "openai";
+
+// If your module management is too complex and the previous approach didn't work
+// you can provide libraries directly 
+paidAutoInstrument({ openai })
+```
+
+
+
 ## Signaling via OTEL tracing
 
 A more reliable and user-friendly way to send signals is to send them via OTEL tracing.
-This allows you to send signals with less arguments and boilerplate as the information is available in the tracing context `Paid.trace()`.
-The interface is `Paid.signal()`, which takes in signal name, optional data, and a flag that attaches costs from the same trace.
-`Paid.signal()` has to be called within a trace - meaning inside of a callback to `Paid.trace()`.
-In contrast to `Paid.usage.recordBulk()`, `Paid.signal()` is using OpenTelemetry to provide reliable delivery.
+This allows you to send signals with less arguments and boilerplate as the information is available in the tracing context `trace()`.
+The interface is `signal()`, which takes in signal name, optional enableCostTracing flag, and optional data.
+`signal()` has to be called within a trace - meaning inside of a callback to `trace()`.
+In contrast to `Paid.usage.recordBulk()`, `signal()` is using OpenTelemetry to provide reliable delivery.
 
 Here's an example of how to use it:
 
 ```typescript
-import { PaidClient } from "@paid-ai/paid-node";
+import { initializeTracing, trace, signal } from "@paid-ai/paid-node";
 
 async function main() {
-    const client = new PaidClient({ token: "<your_paid_api_key>" });
-
     // Initialize tracing
-    await client.initializeTracing();
+    initializeTracing("<your_paid_api_key>");
 
     // Trace the call
-    await client.trace("<your_external_customer_id>", async () => {
+    await trace({
+        externalCustomerId: "<your_external_customer_id>",
+        externalProductId: "<your_external_product_id>" // external_product_id is required for signals
+    }, async () => {
         // ...do some work...
-        client.signal("<your_signal_name>", { /* optional data */ });
-    }, "<your_external_agent_id>"); // external_agent_id is required for signals
+        signal("<your_signal_name>", false, { /* optional data */ });
+    });
 }
 ```
 
@@ -168,18 +234,20 @@ as the wrappers that recorded those costs.
 This will look something like this:
 
 ```typescript
-import { PaidClient } from "@paid-ai/paid-node";
+import { initializeTracing, trace, signal } from "@paid-ai/paid-node";
 import { PaidOpenAI } from "@paid-ai/paid-node/openai";
 import OpenAI from "openai";
 
 async function main() {
-    const client = new PaidClient({ token: "<your_paid_api_key>" });
-    await client.initializeTracing();
+    initializeTracing("<your_paid_api_key>");
 
     const openaiClient = new OpenAI({ apiKey: "<your_openai_api_key>" });
     const paidOpenAI = new PaidOpenAI(openaiClient);
 
-    await client.trace("<your_external_customer_id>", async () => {
+    await trace({
+        externalCustomerId: "<your_external_customer_id>",
+        externalProductId: "<your_external_product_id>"
+    }, async () => {
         // ... your workflow logic
         // ... your AI calls made through Paid wrappers
         const response = await paidOpenAI.chat.completions.create({
@@ -188,7 +256,7 @@ async function main() {
         });
 
         // Send signal with cost tracing enabled
-        client.signal(
+        signal(
             "<your_signal_name>",
             true, // enableCostTracing - set this flag to associate it with costs
             { /* optional data */ }
@@ -196,11 +264,11 @@ async function main() {
 
         // ... your workflow logic
         // ... your AI calls made through Paid wrappers (can be sent after the signal too)
-    }, "<your_external_agent_id>");
+    });
 }
 ```
 
-Then, all of the costs traced in `client.trace()` context are related to that signal.
+Then, all of the costs traced in `trace()` context are related to that signal.
 
 ## Manual Cost Tracking
 
@@ -235,15 +303,17 @@ await client.usage.flush(); // need to flush to send usage immediately
 Alternatively the same `costData` payload can be passed to OTLP signaling mechanism:
 
 ```typescript
-import { PaidClient } from "@paid-ai/paid-node";
+import { initializeTracing, trace, signal } from "@paid-ai/paid-node";
 
 async function main() {
-    const client = new PaidClient({ token: "<your_paid_api_key>" });
-    await client.initializeTracing();
+    initializeTracing("<your_paid_api_key>");
 
-    await client.trace("<your_external_customer_id>", async () => {
+    await trace({
+        externalCustomerId: "<your_external_customer_id>",
+        externalAgentId: "<your_external_agent_id>"
+    }, async () => {
         // ...do some work...
-        client.signal("<your_signal_name>", {
+        signal("<your_signal_name>", false, {
             costData: {
                 vendor: "<any_vendor_name>", // can be anything, traces are grouped by vendors in the UI
                 cost: {
@@ -253,7 +323,7 @@ async function main() {
                 "gen_ai.response.model": "<ai_model_name>",
             }
         });
-    }, "<your_external_agent_id>");
+    });
 }
 ```
 
@@ -290,15 +360,17 @@ await client.usage.flush();
 Same but via OTEL signaling:
 
 ```typescript
-import { PaidClient } from "@paid-ai/paid-node";
+import { initializeTracing, trace, signal } from "@paid-ai/paid-node";
 
 async function main() {
-    const client = new PaidClient({ token: "<your_paid_api_key>" });
-    await client.initializeTracing();
+    initializeTracing("<your_paid_api_key>");
 
-    await client.trace("<your_external_customer_id>", async () => {
+    await trace({
+        externalCustomerId: "<your_external_customer_id>",
+        externalAgentId: "<your_external_agent_id>"
+    }, async () => {
         // ...do some work...
-        client.signal("<your_signal_name>", {
+        signal("<your_signal_name>", false, {
             costData: {
                 vendor: "<any_vendor_name>", // can be anything, traces are grouped by vendors in the UI
                 attributes: {
@@ -309,7 +381,7 @@ async function main() {
                 },
             }
         });
-    }, "<your_external_agent_id>");
+    });
 }
 ```
 
@@ -407,6 +479,16 @@ const client = new PaidClient({
 });
 ```
 
+### Paid OTEL Tracer Provider
+
+If you would like to use the Paid OTEL tracer provider, you can access it via the `getPaidTracerProvider` function.
+
+```typescript
+import { initializeTracing, getPaidTracerProvider } from "@paid-ai/paid-node";
+initializeTracing("<your_paid_api_key>");
+const tracerProvider = getPaidTracerProvider();
+```
+
 ## Contributing
 
 While we value open-source contributions to this SDK, this library is generated programmatically.

package/dist/cjs/Client.d.ts

@@ -5,15 +5,19 @@ import * as environments from "./environments.js";
 import * as core from "./core/index.js";
 import { Customers } from "./api/resources/customers/client/Client.js";
 import { Agents } from "./api/resources/agents/client/Client.js";
+import { Products } from "./api/resources/products/client/Client.js";
 import { Contacts } from "./api/resources/contacts/client/Client.js";
 import { Orders } from "./api/resources/orders/client/Client.js";
+import { Plans } from "./api/resources/plans/client/Client.js";
 import { Usage } from "./wrapper/BatchUsage.js";
+import { Traces } from "./api/resources/traces/client/Client.js";
+import { NodeTracerProvider } from "@opentelemetry/sdk-trace-node";
 export declare namespace PaidClient {
     interface Options {
         environment?: core.Supplier<environments.PaidEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        token: core.Supplier<core.BearerToken>;
+        token?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -32,18 +36,41 @@ export declare class PaidClient {
     protected readonly _options: PaidClient.Options;
     protected _customers: Customers | undefined;
     protected _agents: Agents | undefined;
+    protected _products: Products | undefined;
     protected _contacts: Contacts | undefined;
     protected _orders: Orders | undefined;
+    protected _plans: Plans | undefined;
     protected _usage: Usage | undefined;
-    constructor(_options: PaidClient.Options);
+    protected _traces: Traces | undefined;
+    constructor(_options?: PaidClient.Options);
     get customers(): Customers;
     get agents(): Agents;
+    get products(): Products;
     get contacts(): Contacts;
     get orders(): Orders;
+    get plans(): Plans;
     get usage(): Usage;
+    get traces(): Traces;
+    /**
+     * @deprecated use the standalone 'initializeTracing' instead
+     */
     initializeTracing(collectorEndpoint?: string): Promise<void>;
-    trace<T extends (...args: any[]) => any>(externalCustomerId: string, fn: T, externalAgentId?: string, ...args: Parameters<T>): Promise<ReturnType<T>>;
     /**
+     * @deprecated use the standalone 'trace()' instead
+     * Use this method to track actions like LLM costs and sending signals.
+     * The callback to this function is the work that you want to trace.
+     *
+     * @param externalCustomerId - The external customer ID
+     * @param fn - The callback function containing the work to be traced
+     * @param externalAgentId - @deprecated Use externalProductId instead
+     * @param externalProductId - The external product ID
+     * @param storePrompt - Whether to store the prompt (defaults to false)
+     * @param args - Arguments to pass to the callback function
+     * @returns The return value of the callback function
+     */
+    trace<T extends (...args: any[]) => any>(externalCustomerId: string, fn: T, externalAgentId?: string, externalProductId?: string, storePrompt?: boolean, ...args: Parameters<T>): Promise<ReturnType<T>>;
+    /**
+     * @deprecated use the standalone 'signal()' instead
      * Sends Paid signal. Needs to be called as part of callback to Paid.trace().
      * When enableCostTracing flag is on, signal is associated
      * with cost traces from the same Paid.trace() context.
@@ -63,4 +90,9 @@ export declare class PaidClient {
     signal(eventName: string): void;
     signal(eventName: string, data: Record<string, any>): void;
     signal(eventName: string, enableCostTracing: boolean, data?: Record<string, any>): void;
+    /**
+     * @deprecated use the standalone 'getPaidTracerProvider()' instead
+     * Export the tracer provider which user can use for his own tracing.
+     */
+    get tracerProvider(): NodeTracerProvider | undefined;
 }

package/dist/cjs/Client.js

@@ -50,18 +50,20 @@ const core = __importStar(require("./core/index.js"));
 const headers_js_1 = require("./core/headers.js");
 const Client_js_1 = require("./api/resources/customers/client/Client.js");
 const Client_js_2 = require("./api/resources/agents/client/Client.js");
-const Client_js_3 = require("./api/resources/contacts/client/Client.js");
-const Client_js_4 = require("./api/resources/orders/client/Client.js");
+const Client_js_3 = require("./api/resources/products/client/Client.js");
+const Client_js_4 = require("./api/resources/contacts/client/Client.js");
+const Client_js_5 = require("./api/resources/orders/client/Client.js");
+const Client_js_6 = require("./api/resources/plans/client/Client.js");
 const BatchUsage_js_1 = require("./wrapper/BatchUsage.js");
-const tracing_js_1 = require("./tracing/tracing.js");
+const Client_js_7 = require("./api/resources/traces/client/Client.js");
 const signal_js_1 = require("./tracing/signal.js");
+const tracing_js_1 = require("./tracing/tracing.js");
 class PaidClient {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
                 "X-Fern-Language": "JavaScript",
-                "X-Fern-SDK-Name": "@paid-ai/paid-node",
-                "X-Fern-SDK-Version": "0.5.0-alpha2",
-                "User-Agent": "@paid-ai/paid-node/0.5.0-alpha2",
+                "X-Fern-SDK-Name": "",
+                "X-Fern-SDK-Version": "0.8.0",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -74,49 +76,85 @@ class PaidClient {
         var _a;
         return ((_a = this._agents) !== null && _a !== void 0 ? _a : (this._agents = new Client_js_2.Agents(this._options)));
     }
+    get products() {
+        var _a;
+        return ((_a = this._products) !== null && _a !== void 0 ? _a : (this._products = new Client_js_3.Products(this._options)));
+    }
     get contacts() {
         var _a;
-        return ((_a = this._contacts) !== null && _a !== void 0 ? _a : (this._contacts = new Client_js_3.Contacts(this._options)));
+        return ((_a = this._contacts) !== null && _a !== void 0 ? _a : (this._contacts = new Client_js_4.Contacts(this._options)));
     }
     get orders() {
         var _a;
-        return ((_a = this._orders) !== null && _a !== void 0 ? _a : (this._orders = new Client_js_4.Orders(this._options)));
+        return ((_a = this._orders) !== null && _a !== void 0 ? _a : (this._orders = new Client_js_5.Orders(this._options)));
+    }
+    get plans() {
+        var _a;
+        return ((_a = this._plans) !== null && _a !== void 0 ? _a : (this._plans = new Client_js_6.Plans(this._options)));
     }
     get usage() {
         var _a;
         return ((_a = this._usage) !== null && _a !== void 0 ? _a : (this._usage = new BatchUsage_js_1.Usage(this._options)));
     }
-    // Need to call this method before using tracing or creating wrappers.
+    get traces() {
+        var _a;
+        return ((_a = this._traces) !== null && _a !== void 0 ? _a : (this._traces = new Client_js_7.Traces(this._options)));
+    }
+    /**
+     * @deprecated use the standalone 'initializeTracing' instead
+     */
     initializeTracing(collectorEndpoint) {
         return __awaiter(this, void 0, void 0, function* () {
             const tokenSupplier = this._options.token;
             const token = typeof tokenSupplier === "function" ? yield tokenSupplier() : tokenSupplier;
             const resolvedToken = yield Promise.resolve(token);
-            (0, tracing_js_1._initializeTracing)(resolvedToken, collectorEndpoint);
+            (0, tracing_js_1.initializeTracing)(resolvedToken, collectorEndpoint);
         });
     }
-    // Use this method to track actions like LLM costs and sending signals.
-    // The callback to this function is the work that you want to trace.
-    trace(externalCustomerId, fn, externalAgentId, ...args) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield (0, tracing_js_1._trace)(externalCustomerId, fn, externalAgentId, ...args);
+    /**
+     * @deprecated use the standalone 'trace()' instead
+     * Use this method to track actions like LLM costs and sending signals.
+     * The callback to this function is the work that you want to trace.
+     *
+     * @param externalCustomerId - The external customer ID
+     * @param fn - The callback function containing the work to be traced
+     * @param externalAgentId - @deprecated Use externalProductId instead
+     * @param externalProductId - The external product ID
+     * @param storePrompt - Whether to store the prompt (defaults to false)
+     * @param args - Arguments to pass to the callback function
+     * @returns The return value of the callback function
+     */
+    trace(externalCustomerId_1, fn_1, externalAgentId_1, externalProductId_1) {
+        return __awaiter(this, arguments, void 0, function* (externalCustomerId, fn, externalAgentId, externalProductId, storePrompt = false, ...args) {
+            // TODO: remove this after deprecation and replace externalAgentId with externalProductId everywhere
+            if (externalProductId) {
+                externalAgentId = externalProductId;
+            }
+            return yield (0, tracing_js_1.trace)({ externalCustomerId, externalProductId: externalAgentId, storePrompt }, fn, ...args);
         });
     }
     signal(eventName, enableCostTracingOrData, data) {
         let enableCostTracing = false;
         let finalData;
-        if (typeof enableCostTracingOrData === 'boolean') {
+        if (typeof enableCostTracingOrData === "boolean") {
             // Case: signal(eventName, boolean, data?)
             enableCostTracing = enableCostTracingOrData;
             finalData = data;
         }
-        else if (typeof enableCostTracingOrData === 'object') {
+        else if (typeof enableCostTracingOrData === "object") {
             // Case: signal(eventName, data)
             enableCostTracing = false;
             finalData = enableCostTracingOrData;
         }
         // Case: signal(eventName) - both remain default/undefined
-        return (0, signal_js_1._signal)(eventName, enableCostTracing, finalData);
+        return (0, signal_js_1.signal)(eventName, enableCostTracing, finalData);
+    }
+    /**
+     * @deprecated use the standalone 'getPaidTracerProvider()' instead
+     * Export the tracer provider which user can use for his own tracing.
+     */
+    get tracerProvider() {
+        return (0, tracing_js_1.getPaidTracerProvider)();
     }
 }
 exports.PaidClient = PaidClient;

package/dist/cjs/api/errors/InternalServerError.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index.js";
+import * as Paid from "../index.js";
+import * as core from "../../core/index.js";
+export declare class InternalServerError extends errors.PaidError {
+    constructor(body: Paid.Error_, rawResponse?: core.RawResponse);
+}

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

@@ -0,0 +1,52 @@
+"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.InternalServerError = void 0;
+const errors = __importStar(require("../../errors/index.js"));
+class InternalServerError extends errors.PaidError {
+    constructor(body, rawResponse) {
+        super({
+            message: "InternalServerError",
+            statusCode: 500,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, InternalServerError.prototype);
+    }
+}
+exports.InternalServerError = InternalServerError;

package/dist/cjs/api/errors/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./ForbiddenError.js";
 export * from "./BadRequestError.js";
 export * from "./NotFoundError.js";
+export * from "./InternalServerError.js";

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

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./ForbiddenError.js"), exports);
 __exportStar(require("./BadRequestError.js"), exports);
 __exportStar(require("./NotFoundError.js"), exports);
+__exportStar(require("./InternalServerError.js"), exports);

package/dist/cjs/api/index.d.ts

@@ -1,3 +1,3 @@
+export * from "./resources/index.js";
 export * from "./types/index.js";
 export * from "./errors/index.js";
-export * from "./resources/index.js";

package/dist/cjs/api/index.js

@@ -14,6 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./resources/index.js"), exports);
 __exportStar(require("./types/index.js"), exports);
 __exportStar(require("./errors/index.js"), exports);
-__exportStar(require("./resources/index.js"), exports);

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

@@ -28,6 +28,8 @@ export declare class Agents {
     protected readonly _options: Agents.Options;
     constructor(_options?: Agents.Options);
     /**
+     * DEPRECATED: Use /products instead. Agents are now products with type='agent'.
+     *
      * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -36,6 +38,8 @@ export declare class Agents {
     list(requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<Paid.Agent[]>;
     private __list;
     /**
+     * DEPRECATED: Use POST /products instead.
+     *
      * @param {Paid.AgentCreate} request
      * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -49,6 +53,8 @@ export declare class Agents {
     create(request: Paid.AgentCreate, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<Paid.Agent>;
     private __create;
     /**
+     * DEPRECATED: Use GET /products/{productId} instead.
+     *
      * @param {string} agentId
      * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -58,6 +64,8 @@ export declare class Agents {
     get(agentId: string, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<Paid.Agent>;
     private __get;
     /**
+     * DEPRECATED: Use PUT /products/{productId} instead.
+     *
      * @param {string} agentId
      * @param {Paid.AgentUpdate} request
      * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
@@ -97,6 +105,8 @@ export declare class Agents {
     update(agentId: string, request: Paid.AgentUpdate, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<Paid.Agent>;
     private __update;
     /**
+     * DEPRECATED: Use DELETE /products/{productId} instead.
+     *
      * @param {string} agentId
      * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -106,6 +116,8 @@ export declare class Agents {
     delete(agentId: string, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<void>;
     private __delete;
     /**
+     * DEPRECATED: Use GET /products/external/{externalId} instead.
+     *
      * @param {string} externalId
      * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -115,6 +127,8 @@ export declare class Agents {
     getByExternalId(externalId: string, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<Paid.Agent>;
     private __getByExternalId;
     /**
+     * DEPRECATED: Use PUT /products/external/{externalId} instead.
+     *
      * @param {string} externalId
      * @param {Paid.AgentUpdate} request
      * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
@@ -143,6 +157,8 @@ export declare class Agents {
     updateByExternalId(externalId: string, request: Paid.AgentUpdate, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<Paid.Agent>;
     private __updateByExternalId;
     /**
+     * DEPRECATED: Use DELETE /products/external/{externalId} instead.
+     *
      * @param {string} externalId
      * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
      *