@paid-ai/paid-node 0.2.0 → 0.3.0

package/README.md

@@ -86,30 +86,41 @@ To enable logs, set the `PAID_LOG_LEVEL` environment variable. Available levels
 
 Example: `PAID_LOG_LEVEL=debug node your-app.js`
 
-## Cost Tracking
+## Cost Tracking via OTEL tracing
 
-It's possible to track usage costs by using Paid wrappers around you AI provider API.
-As of now, the following AI providers are supported: `OpenAI`, `Anthropic`, `Mistral` (OCR), and `Langchain`.
+You can track usage costs by using Paid wrappers around your AI provider's SDK.
+As of now, the following SDKs' APIs are wrapped:
 
-Example usage:
+```
+openai
+anthropic
+mistral
+langchain (as a callback)
+vercel (Vercel AI SDK)
+```
+
+### Using the Paid wrappers
+
+Example usage with OpenAI:
 
 ```typescript
-import { PaidClient, PaidOpenAI } from "@paid-ai/paid-node";
+import { PaidClient } 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()
+    // Initialize cost tracking
+    await client.initializeTracing();
 
-    // wrap openai in paid wrapper
-    const openaiClient = new OpenAI({ apiKey: "<your_openai_api_key" });
-    const paidOpenAiWrapper = new PaidOpenAI(openaiClient);
+    // Wrap OpenAI in paid wrapper
+    const openaiClient = new OpenAI({ apiKey: "<your_openai_api_key>" });
+    const paidOpenAI = new PaidOpenAI(openaiClient);
 
-    // trace the call
+    // Trace the call
     await client.trace("<your_external_customer_id>", async () => {
-        const response = await paidOpenAiWrapper.images.generate({
+        const response = await paidOpenAI.images.generate({
             prompt: "A beautiful sunset over the mountains",
             n: 1,
             size: "256x256"
@@ -121,54 +132,184 @@ async function main() {
 }
 ```
 
+## 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.
+
+Here's an example of how to use it:
+
+```typescript
+import { PaidClient } from "@paid-ai/paid-node";
+
+async function main() {
+    const client = new PaidClient({ token: "<your_paid_api_key>" });
+
+    // Initialize tracing
+    await client.initializeTracing();
+
+    // Trace the call
+    await client.trace("<your_external_customer_id>", async () => {
+        // ...do some work...
+        client.signal("<your_signal_name>", { /* optional data */ });
+    }, "<your_external_agent_id>"); // external_agent_id is required for signals
+}
+```
+
+### Signal-costs - Attaching cost traces to a signal
+
+If you want a signal to carry information about costs,
+then the signal should be sent from the same tracing context
+as the wrappers that recorded those costs.
+
+This will look something like this:
+
+```typescript
+import { PaidClient } 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();
+
+    const openaiClient = new OpenAI({ apiKey: "<your_openai_api_key>" });
+    const paidOpenAI = new PaidOpenAI(openaiClient);
+
+    await client.trace("<your_external_customer_id>", async () => {
+        // ... your workflow logic
+        // ... your AI calls made through Paid wrappers
+        const response = await paidOpenAI.chat.completions.create({
+            model: "gpt-4",
+            messages: [{ role: "user", content: "Hello!" }]
+        });
+
+        // Send signal with cost tracing enabled
+        client.signal(
+            "<your_signal_name>",
+            true, // enableCostTracing - set this flag to associate it with costs
+            { /* optional data */ }
+        );
+
+        // ... 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.
+
 ## Manual Cost Tracking
 
-When using `client.usage.recordUsage()` API, it's possible to create cost traces manually
-just by passing in the cost data.
+If you would prefer to not use Paid to track your costs automatically but you want to send us the costs yourself,
+then you can use manual cost tracking mechanism. Just attach the cost information in the following format to a signal payload:
 
 ```typescript
-const additionalData = {
-    costData: {
-        vendor: "<vendor_name>", // can be anything
-        cost : {
-            amount: 0.0001,
-            currency: "USD"
+import { PaidClient, Paid } from "@paid-ai/paid-node";
+
+const client = new PaidClient({ token: "<your_paid_api_key>" });
+
+const signal: Paid.Signal = {
+    event_name: "<your_signal_name>",
+    agent_id: "<your_agent_id>",
+    customer_id: "<your_external_customer_id>",
+    data: {
+        costData: {
+            vendor: "<any_vendor_name>", // can be anything, traces are grouped by vendors in the UI
+            cost: {
+                amount: 0.002,
+                currency: "USD"
+            },
+            "gen_ai.response.model": "<ai_model_name>",
         }
     }
 };
-await client.usage.recordBulk({
-    signals: [{
-        agent_id: "<your_agent_id>",
-        event_name: "<your_signal_name>",
-        customer_id: "<your_customer_id>",
-        data: additionalData,
-    }]
-})
 
+await client.usage.recordBulk({ signals: [signal] });
 await client.usage.flush(); // need to flush to send usage immediately
 ```
 
-## Send signals over OTLP
+Alternatively the same `costData` payload can be passed to OTLP signaling mechanism:
+
+```typescript
+import { PaidClient } from "@paid-ai/paid-node";
+
+async function main() {
+    const client = new PaidClient({ token: "<your_paid_api_key>" });
+    await client.initializeTracing();
+
+    await client.trace("<your_external_customer_id>", async () => {
+        // ...do some work...
+        client.signal("<your_signal_name>", {
+            costData: {
+                vendor: "<any_vendor_name>", // can be anything, traces are grouped by vendors in the UI
+                cost: {
+                    amount: 0.002,
+                    currency: "USD"
+                },
+                "gen_ai.response.model": "<ai_model_name>",
+            }
+        });
+    }, "<your_external_agent_id>");
+}
+```
+
+### Manual Usage Tracking
 
-Besides sending signals over REST, it's also possible to send signals as part or tracing
-context, just like with cost tracking.
+If you would prefer to send us raw usage manually (without wrappers) and have us compute the cost, you can attach usage data in the following format:
 
-Example usage:
+```typescript
+import { PaidClient, Paid } from "@paid-ai/paid-node";
+
+const client = new PaidClient({ token: "<your_paid_api_key>" });
+
+const signal: Paid.Signal = {
+    event_name: "<your_signal_name>",
+    agent_id: "<your_agent_id>",
+    customer_id: "<your_external_customer_id>",
+    data: {
+        costData: {
+            vendor: "<any_vendor_name>", // can be anything, traces are grouped by vendors in the UI
+            attributes: {
+                "gen_ai.response.model": "gpt-4-turbo",
+                "gen_ai.usage.input_tokens": 100,
+                "gen_ai.usage.output_tokens": 300,
+                "gen_ai.usage.cached_input_tokens": 600,
+            },
+        }
+    }
+};
+
+await client.usage.recordBulk({ signals: [signal] });
+await client.usage.flush();
+```
+
+Same but via OTEL signaling:
 
 ```typescript
 import { PaidClient } from "@paid-ai/paid-node";
 
 async function main() {
     const client = new PaidClient({ token: "<your_paid_api_key>" });
+    await client.initializeTracing();
 
-    // initialize cost tracking
-    await client.initializeTracing()
-
-    // trace the call
     await client.trace("<your_external_customer_id>", async () => {
-        // ... your app logic, cost tracking LLM wrapper calls
-        client.signal("signal_name", { "data": { // ... additional data, e.g. costs } });
-    }, "<optional_external_agent_id>");
+        // ...do some work...
+        client.signal("<your_signal_name>", {
+            costData: {
+                vendor: "<any_vendor_name>", // can be anything, traces are grouped by vendors in the UI
+                attributes: {
+                    "gen_ai.response.model": "gpt-4-turbo",
+                    "gen_ai.usage.input_tokens": 100,
+                    "gen_ai.usage.output_tokens": 300,
+                    "gen_ai.usage.cached_input_tokens": 600,
+                },
+            }
+        });
+    }, "<your_external_agent_id>");
 }
 ```
 

package/dist/cjs/Client.js

@@ -60,8 +60,8 @@ class PaidClient {
         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.2.0",
-                "User-Agent": "@paid-ai/paid-node/0.2.0",
+                "X-Fern-SDK-Version": "0.3.0",
+                "User-Agent": "@paid-ai/paid-node/0.3.0",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/cjs/api/errors/ForbiddenError.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 ForbiddenError extends errors.PaidError {
+    constructor(body: Paid.Error_, rawResponse?: core.RawResponse);
+}

package/dist/cjs/api/errors/ForbiddenError.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.ForbiddenError = void 0;
+const errors = __importStar(require("../../errors/index.js"));
+class ForbiddenError extends errors.PaidError {
+    constructor(body, rawResponse) {
+        super({
+            message: "ForbiddenError",
+            statusCode: 403,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, ForbiddenError.prototype);
+    }
+}
+exports.ForbiddenError = ForbiddenError;

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

@@ -0,0 +1 @@
+export * from "./ForbiddenError.js";

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

@@ -0,0 +1,17 @@
+"use strict";
+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 __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("./ForbiddenError.js"), exports);

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

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

package/dist/cjs/api/index.js

@@ -15,4 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __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

@@ -9,7 +9,7 @@ export declare namespace Agents {
         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>;
     }
@@ -26,7 +26,7 @@ export declare namespace Agents {
 }
 export declare class Agents {
     protected readonly _options: Agents.Options;
-    constructor(_options: Agents.Options);
+    constructor(_options?: Agents.Options);
     /**
      * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -151,5 +151,5 @@ export declare class Agents {
      */
     deleteByExternalId(externalId: string, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteByExternalId;
-    protected _getAuthorizationHeader(): Promise<string>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/dist/cjs/api/resources/agents/client/Client.js

@@ -55,7 +55,7 @@ const headers_js_1 = require("../../../../core/headers.js");
 const url_join_1 = __importDefault(require("url-join"));
 const errors = __importStar(require("../../../../errors/index.js"));
 class Agents {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -505,7 +505,11 @@ class Agents {
     }
     _getAuthorizationHeader() {
         return __awaiter(this, void 0, void 0, function* () {
-            return `Bearer ${yield core.Supplier.get(this._options.token)}`;
+            const bearer = yield core.Supplier.get(this._options.token);
+            if (bearer != null) {
+                return `Bearer ${bearer}`;
+            }
+            return undefined;
         });
     }
 }

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

@@ -9,7 +9,7 @@ export declare namespace Contacts {
         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>;
     }
@@ -26,7 +26,7 @@ export declare namespace Contacts {
 }
 export declare class Contacts {
     protected readonly _options: Contacts.Options;
-    constructor(_options: Contacts.Options);
+    constructor(_options?: Contacts.Options);
     /**
      * @param {Contacts.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -86,5 +86,5 @@ export declare class Contacts {
      */
     deleteByExternalId(externalId: string, requestOptions?: Contacts.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteByExternalId;
-    protected _getAuthorizationHeader(): Promise<string>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/dist/cjs/api/resources/contacts/client/Client.js

@@ -55,7 +55,7 @@ const headers_js_1 = require("../../../../core/headers.js");
 const url_join_1 = __importDefault(require("url-join"));
 const errors = __importStar(require("../../../../errors/index.js"));
 class Contacts {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -356,7 +356,11 @@ class Contacts {
     }
     _getAuthorizationHeader() {
         return __awaiter(this, void 0, void 0, function* () {
-            return `Bearer ${yield core.Supplier.get(this._options.token)}`;
+            const bearer = yield core.Supplier.get(this._options.token);
+            if (bearer != null) {
+                return `Bearer ${bearer}`;
+            }
+            return undefined;
         });
     }
 }

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

@@ -9,7 +9,7 @@ export declare namespace Customers {
         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>;
     }
@@ -26,7 +26,7 @@ export declare namespace Customers {
 }
 export declare class Customers {
     protected readonly _options: Customers.Options;
-    constructor(_options: Customers.Options);
+    constructor(_options?: Customers.Options);
     /**
      * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -80,6 +80,17 @@ export declare class Customers {
      */
     delete(customerId: string, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<void>;
     private __delete;
+    /**
+     * @param {string} customerId - The customer ID
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.ForbiddenError}
+     *
+     * @example
+     *     await client.customers.getEntitlements("customerId")
+     */
+    getEntitlements(customerId: string, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.EntitlementUsage[]>;
+    private __getEntitlements;
     /**
      * @param {string} externalId
      * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
@@ -108,5 +119,5 @@ export declare class Customers {
      */
     deleteByExternalId(externalId: string, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteByExternalId;
-    protected _getAuthorizationHeader(): Promise<string>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/dist/cjs/api/resources/customers/client/Client.js

@@ -51,11 +51,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Customers = void 0;
 const environments = __importStar(require("../../../../environments.js"));
 const core = __importStar(require("../../../../core/index.js"));
+const Paid = __importStar(require("../../../index.js"));
 const headers_js_1 = require("../../../../core/headers.js");
 const url_join_1 = __importDefault(require("url-join"));
 const errors = __importStar(require("../../../../errors/index.js"));
 class Customers {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -312,6 +313,61 @@ class Customers {
             }
         });
     }
+    /**
+     * @param {string} customerId - The customer ID
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.ForbiddenError}
+     *
+     * @example
+     *     await client.customers.getEntitlements("customerId")
+     */
+    getEntitlements(customerId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getEntitlements(customerId, requestOptions));
+    }
+    __getEntitlements(customerId, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            const _response = yield core.fetcher({
+                url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.PaidEnvironment.Production, `customers/${encodeURIComponent(customerId)}/credit-bundles`),
+                method: "GET",
+                headers: (0, headers_js_1.mergeHeaders)((_c = this._options) === null || _c === void 0 ? void 0 : _c.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 403:
+                        throw new Paid.ForbiddenError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PaidError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.PaidError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.PaidTimeoutError("Timeout exceeded when calling GET /customers/{customerId}/credit-bundles.");
+                case "unknown":
+                    throw new errors.PaidError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * @param {string} externalId
      * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
@@ -462,7 +518,11 @@ class Customers {
     }
     _getAuthorizationHeader() {
         return __awaiter(this, void 0, void 0, function* () {
-            return `Bearer ${yield core.Supplier.get(this._options.token)}`;
+            const bearer = yield core.Supplier.get(this._options.token);
+            if (bearer != null) {
+                return `Bearer ${bearer}`;
+            }
+            return undefined;
         });
     }
 }

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

@@ -10,7 +10,7 @@ export declare namespace Orders {
         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>;
     }
@@ -28,7 +28,7 @@ export declare namespace Orders {
 export declare class Orders {
     protected readonly _options: Orders.Options;
     protected _lines: Lines | undefined;
-    constructor(_options: Orders.Options);
+    constructor(_options?: Orders.Options);
     get lines(): Lines;
     /**
      * @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
@@ -51,6 +51,16 @@ export declare class Orders {
      *         endDate: "2026-01-01",
      *         currency: "USD"
      *     })
+     *
+     * @example
+     *     await client.orders.create({
+     *         customerExternalId: "acme-inc",
+     *         name: "Acme Order with Custom Pricing",
+     *         description: "Order with customized attribute pricing",
+     *         startDate: "2025-01-01",
+     *         endDate: "2026-01-01",
+     *         currency: "USD"
+     *     })
      */
     create(request: Paid.OrderCreate, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<Paid.Order>;
     private __create;
@@ -81,5 +91,5 @@ export declare class Orders {
      */
     activate(orderId: string, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<Paid.Order>;
     private __activate;
-    protected _getAuthorizationHeader(): Promise<string>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }