@paid-ai/paid-node 1.7.1 → 1.8.0

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

@@ -0,0 +1,313 @@
+"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;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Amendments = void 0;
+const headers_js_1 = require("../../../../core/headers.js");
+const core = __importStar(require("../../../../core/index.js"));
+const environments = __importStar(require("../../../../environments.js"));
+const errors = __importStar(require("../../../../errors/index.js"));
+const Paid = __importStar(require("../../../index.js"));
+class Amendments {
+    constructor(_options) {
+        this._options = _options;
+    }
+    /**
+     * Returns which amendments the order admits right now: per-attribute intents and treatment axes with choosable options, defaults, and unavailability reasons, plus the order version, currency, and effective date an amendment request needs.
+     *
+     * @param {Paid.GetOrderAmendmentOptionsRequest} request
+     * @param {Amendments.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.ConflictError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.amendments.getOrderAmendmentOptions({
+     *         orderId: "orderId"
+     *     })
+     */
+    getOrderAmendmentOptions(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getOrderAmendmentOptions(request, requestOptions));
+    }
+    __getOrderAmendmentOptions(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const { orderId } = request;
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PaidEnvironment.Default, `orders/${core.url.encodePathParam(orderId)}/amendments/options`),
+                method: "GET",
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.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 400:
+                        throw new Paid.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Paid.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Paid.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 409:
+                        throw new Paid.ConflictError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Paid.InternalServerError(_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 /orders/{orderId}/amendments/options.");
+                case "unknown":
+                    throw new errors.PaidError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * Compiles amendment intents into a plan (operations, money effects, credit effects, state diff) without executing. The returned planHash can be passed to the execute endpoint for two-phase, drift-guarded execution.
+     *
+     * @param {Paid.UnifiedAmendmentPreviewRequest} request
+     * @param {Amendments.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.ConflictError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.amendments.previewOrderAmendment({
+     *         orderId: "orderId",
+     *         orderVersion: 1,
+     *         intents: [{
+     *                 type: "updateQuantity",
+     *                 orderLineAttributeId: "orderLineAttributeId",
+     *                 newQuantity: 1
+     *             }]
+     *     })
+     */
+    previewOrderAmendment(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__previewOrderAmendment(request, requestOptions));
+    }
+    __previewOrderAmendment(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const { orderId } = request, _body = __rest(request, ["orderId"]);
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PaidEnvironment.Default, `orders/${core.url.encodePathParam(orderId)}/amendments/preview`),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: _body,
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.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 400:
+                        throw new Paid.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Paid.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Paid.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 409:
+                        throw new Paid.ConflictError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Paid.InternalServerError(_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 POST /orders/{orderId}/amendments/preview.");
+                case "unknown":
+                    throw new errors.PaidError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * Executes amendment intents against an order. One-shot by default; pass the previewed planHash to require the recomputed plan to match (409 PLAN_CONFLICT on drift).
+     *
+     * @param {Paid.UnifiedAmendmentExecuteRequest} request
+     * @param {Amendments.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.ConflictError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.amendments.executeOrderAmendment({
+     *         orderId: "orderId",
+     *         orderVersion: 1,
+     *         intents: [{
+     *                 type: "updateQuantity",
+     *                 orderLineAttributeId: "orderLineAttributeId",
+     *                 newQuantity: 1
+     *             }]
+     *     })
+     */
+    executeOrderAmendment(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__executeOrderAmendment(request, requestOptions));
+    }
+    __executeOrderAmendment(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const { orderId } = request, _body = __rest(request, ["orderId"]);
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PaidEnvironment.Default, `orders/${core.url.encodePathParam(orderId)}/amendments`),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: _body,
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.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 400:
+                        throw new Paid.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Paid.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Paid.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 409:
+                        throw new Paid.ConflictError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Paid.InternalServerError(_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 POST /orders/{orderId}/amendments.");
+                case "unknown":
+                    throw new errors.PaidError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    _getAuthorizationHeader() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return `Bearer ${yield core.Supplier.get(this._options.token)}`;
+        });
+    }
+}
+exports.Amendments = Amendments;

package/dist/cjs/api/resources/amendments/client/index.d.ts

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

package/dist/cjs/api/resources/amendments/client/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("./requests/index.js"), exports);

package/dist/cjs/api/resources/amendments/client/requests/GetOrderAmendmentOptionsRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         orderId: "orderId"
+ *     }
+ */
+export interface GetOrderAmendmentOptionsRequest {
+    /** Display id of the order (for example `ord_5rLZXDFSHNw`). Line and attribute ids in amendment bodies are UUIDs from the options response. */
+    orderId: string;
+}

package/dist/cjs/api/resources/amendments/client/requests/UnifiedAmendmentExecuteRequest.d.ts

@@ -0,0 +1,35 @@
+import type * as Paid from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         orderId: "orderId",
+ *         orderVersion: 1,
+ *         intents: [{
+ *                 type: "updateQuantity",
+ *                 orderLineAttributeId: "orderLineAttributeId",
+ *                 newQuantity: 1
+ *             }]
+ *     }
+ */
+export interface UnifiedAmendmentExecuteRequest {
+    /** Display id of the order (for example `ord_5rLZXDFSHNw`). Line and attribute ids in amendment bodies are UUIDs from the options response. */
+    orderId: string;
+    /** Must match `orderVersion` from the options response. Returns 409 if the order has been amended since. */
+    orderVersion: number;
+    /** At least one intent, discriminated by type. */
+    intents: Paid.UnifiedAmendmentIntent[];
+    /** Recurring charges pick next-cycle vs settle-now. Usage price changes pick new usage only vs the whole current period. */
+    defaultTreatment?: UnifiedAmendmentExecuteRequest.DefaultTreatment;
+    /** From preview. When set, execute recomputes the plan and returns 409 `PLAN_CONFLICT` if billing state has drifted. Omit only for one-shot execute. */
+    planHash?: string;
+}
+export declare namespace UnifiedAmendmentExecuteRequest {
+    /** Recurring charges pick next-cycle vs settle-now. Usage price changes pick new usage only vs the whole current period. */
+    const DefaultTreatment: {
+        readonly None: "none";
+        readonly Prorate: "prorate";
+        readonly SignalsFromAmendment: "signalsFromAmendment";
+        readonly AllSignalsInPeriod: "allSignalsInPeriod";
+    };
+    type DefaultTreatment = (typeof DefaultTreatment)[keyof typeof DefaultTreatment];
+}

package/dist/cjs/api/resources/amendments/client/requests/UnifiedAmendmentExecuteRequest.js

@@ -0,0 +1,14 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnifiedAmendmentExecuteRequest = void 0;
+var UnifiedAmendmentExecuteRequest;
+(function (UnifiedAmendmentExecuteRequest) {
+    /** Recurring charges pick next-cycle vs settle-now. Usage price changes pick new usage only vs the whole current period. */
+    UnifiedAmendmentExecuteRequest.DefaultTreatment = {
+        None: "none",
+        Prorate: "prorate",
+        SignalsFromAmendment: "signalsFromAmendment",
+        AllSignalsInPeriod: "allSignalsInPeriod",
+    };
+})(UnifiedAmendmentExecuteRequest || (exports.UnifiedAmendmentExecuteRequest = UnifiedAmendmentExecuteRequest = {}));

package/dist/cjs/api/resources/amendments/client/requests/UnifiedAmendmentPreviewRequest.d.ts

@@ -0,0 +1,33 @@
+import type * as Paid from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         orderId: "orderId",
+ *         orderVersion: 1,
+ *         intents: [{
+ *                 type: "updateQuantity",
+ *                 orderLineAttributeId: "orderLineAttributeId",
+ *                 newQuantity: 1
+ *             }]
+ *     }
+ */
+export interface UnifiedAmendmentPreviewRequest {
+    /** Display id of the order (for example `ord_5rLZXDFSHNw`). Line and attribute ids in amendment bodies are UUIDs from the options response. */
+    orderId: string;
+    /** Must match `orderVersion` from the options response. Returns 409 if the order has been amended since. */
+    orderVersion: number;
+    /** At least one intent, discriminated by type. */
+    intents: Paid.UnifiedAmendmentIntent[];
+    /** Recurring charges pick next-cycle vs settle-now. Usage price changes pick new usage only vs the whole current period. */
+    defaultTreatment?: UnifiedAmendmentPreviewRequest.DefaultTreatment;
+}
+export declare namespace UnifiedAmendmentPreviewRequest {
+    /** Recurring charges pick next-cycle vs settle-now. Usage price changes pick new usage only vs the whole current period. */
+    const DefaultTreatment: {
+        readonly None: "none";
+        readonly Prorate: "prorate";
+        readonly SignalsFromAmendment: "signalsFromAmendment";
+        readonly AllSignalsInPeriod: "allSignalsInPeriod";
+    };
+    type DefaultTreatment = (typeof DefaultTreatment)[keyof typeof DefaultTreatment];
+}

package/dist/cjs/api/resources/amendments/client/requests/UnifiedAmendmentPreviewRequest.js

@@ -0,0 +1,14 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnifiedAmendmentPreviewRequest = void 0;
+var UnifiedAmendmentPreviewRequest;
+(function (UnifiedAmendmentPreviewRequest) {
+    /** Recurring charges pick next-cycle vs settle-now. Usage price changes pick new usage only vs the whole current period. */
+    UnifiedAmendmentPreviewRequest.DefaultTreatment = {
+        None: "none",
+        Prorate: "prorate",
+        SignalsFromAmendment: "signalsFromAmendment",
+        AllSignalsInPeriod: "allSignalsInPeriod",
+    };
+})(UnifiedAmendmentPreviewRequest || (exports.UnifiedAmendmentPreviewRequest = UnifiedAmendmentPreviewRequest = {}));

package/dist/cjs/api/resources/amendments/client/requests/index.d.ts

@@ -0,0 +1,3 @@
+export type { GetOrderAmendmentOptionsRequest } from "./GetOrderAmendmentOptionsRequest.js";
+export type { UnifiedAmendmentExecuteRequest } from "./UnifiedAmendmentExecuteRequest.js";
+export type { UnifiedAmendmentPreviewRequest } from "./UnifiedAmendmentPreviewRequest.js";

package/dist/cjs/api/resources/amendments/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

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

package/dist/cjs/api/resources/amendments/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("./client/index.js"), exports);

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

@@ -0,0 +1,63 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as Paid from "../../../index.js";
+export declare namespace Analytics {
+    interface Options extends BaseClientOptions {
+    }
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class Analytics {
+    protected readonly _options: Analytics.Options;
+    constructor(_options: Analytics.Options);
+    /**
+     * Runs a single ClickHouse SELECT (or WITH … SELECT) against your organization's analytics views. Before writing a query, call `getAnalyticsSchema` (GET /schema) for the available views and columns, and `getSignalsMetadata` (GET /signals/metadata) for the JSON paths inside `fact_signal.data`. Results are automatically scoped to your organization — no org filter is needed or possible. Only SELECT/WITH statements are accepted.
+     *
+     * Conventions: monetary amounts are minor units (cents — divide by 100 for the major unit); most are integers, but `fact_cost.cost_amount` is fractional cents (Decimal) since a single AI call usually costs less than a cent; 64-bit integers (counts, ids, amounts) are returned as JSON strings to preserve precision, so parse them client-side; Decimal columns (fractional cents, and credit amounts, which are counts of credits rather than cents and are never divided by 100) come back as JSON numbers instead, so a value beyond 2^53 is already rounded — select toString(col) when you need its exact digits. Query signal payloads via JSON paths, e.g. `SELECT data.country::String AS country, count() FROM fact_signal GROUP BY country`.
+     *
+     * Limits: 30 seconds of execution time and 10,000 result rows (truncation is flagged via `meta.truncated`). Prefer aggregates and a `created_at` date filter on large tables — this endpoint is for interactive analytics, not bulk export.
+     *
+     * @param {Paid.AnalyticsQueryRequest} request
+     * @param {Analytics.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.RequestTimeoutError}
+     * @throws {@link Paid.TooManyRequestsError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.analytics.executeAnalyticsQuery({
+     *         query: "SELECT signal_name, count() AS signals FROM fact_signal WHERE created_at > now() - INTERVAL 30 DAY GROUP BY signal_name ORDER BY signals DESC"
+     *     })
+     */
+    executeAnalyticsQuery(request: Paid.AnalyticsQueryRequest, requestOptions?: Analytics.RequestOptions): core.HttpResponsePromise<Paid.AnalyticsQueryResponse>;
+    private __executeAnalyticsQuery;
+    /**
+     * Returns the analytics views available to POST /query, with column names, ClickHouse types, and descriptions. Dimensions (`dim_*`) describe entities; facts (`fact_*`) are event/transaction tables that join to dimensions via the `*_id` columns described in each comment.
+     *
+     * @param {Analytics.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.analytics.getAnalyticsSchema()
+     */
+    getAnalyticsSchema(requestOptions?: Analytics.RequestOptions): core.HttpResponsePromise<Paid.AnalyticsSchemaResponse>;
+    private __getAnalyticsSchema;
+    /**
+     * Lists the JSON paths (and their observed types) present in the `data` payload of your signals within a time window (default: last 30 days), grouped by signal name. Use the returned paths in queries against `fact_signal`, e.g. `WHERE data.<path>::String = '...'`.
+     *
+     * @param {Paid.GetSignalsMetadataRequest} request
+     * @param {Analytics.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.analytics.getSignalsMetadata()
+     */
+    getSignalsMetadata(request?: Paid.GetSignalsMetadataRequest, requestOptions?: Analytics.RequestOptions): core.HttpResponsePromise<Paid.SignalsMetadataResponse>;
+    private __getSignalsMetadata;
+    protected _getAuthorizationHeader(): Promise<string>;
+}