@paid-ai/paid-node 1.8.0 → 2.0.0

package/dist/esm/api/resources/customViewsExperimental/client/Client.mjs

@@ -323,7 +323,7 @@ export class CustomViewsExperimental {
     /**
      * ⚠️ **Experimental** — this endpoint may change or be removed without notice and is not subject to v2 backwards-compatibility guarantees. Do not build production-critical integrations against it yet.
      *
-     * Returns the view's name, status, query ids, and the author render bundle for the owning organization (DRAFT or PUBLISHED). Used by the trusted preview/embed frame to render the sandbox; the per-customer data is fetched separately via /:displayId/data.
+     * Returns the view's name, status, query ids, and the author render bundle for the owning organization. Only PUBLISHED views are returned; a DRAFT returns 404 (use getCustomViewAuthoring to read a DRAFT). Used by the trusted preview/embed frame to render the sandbox; the per-customer data is fetched separately via /:displayId/data.
      *
      * @param {Paid.GetCustomViewRequest} request
      * @param {CustomViewsExperimental.RequestOptions} requestOptions - Request-specific configuration.
@@ -393,7 +393,7 @@ export class CustomViewsExperimental {
     /**
      * ⚠️ **Experimental** — this endpoint may change or be removed without notice and is not subject to v2 backwards-compatibility guarantees. Do not build production-critical integrations against it yet.
      *
-     * Partially updates a view. Omitted fields are left unchanged. For REVISIONS, prefer the incremental fields — `bundleEdits` (exact search-and-replace on the stored render bundle) and `queryUpserts`/`queryRemovals` (per-query changes) — so you transmit only what changed instead of re-sending the whole payload. The full-replacement fields remain for rewrites: `renderBundle`, and `queries` (a FULL replacement of the query list — never drop queries the user didn't ask to remove). Replacement and incremental forms of the same aspect cannot be combined. The resulting SQL and bundle pass the same validation as createCustomView (SELECT-only, size cap, self-contained, paid:data listener). Works on DRAFT or PUBLISHED views — published embeds pick the change up on their next load.
+     * Partially updates a view. Omitted fields are left unchanged. For REVISIONS, prefer the incremental fields — `bundleEdits` (exact search-and-replace on the stored render bundle) and `queryUpserts`/`queryRemovals` (per-query changes) — so you transmit only what changed instead of re-sending the whole payload. The full-replacement fields remain for rewrites: `renderBundle`, and `queries` (a FULL replacement of the query list — never drop queries the user didn't ask to remove). Replacement and incremental forms of the same aspect cannot be combined. The resulting SQL and bundle pass the same validation as createCustomView (SELECT-only, size cap, self-contained, paid:data listener). Works on DRAFT or PUBLISHED views — published embeds pick the change up on their next load. If the queries or hierarchy setting change during validation, returns 409 CUSTOM_VIEW_UPDATE_CONFLICT; fetch the current authoring definition and reapply your changes before retrying.
      *
      * @param {Paid.UpdateCustomViewRequest} request
      * @param {CustomViewsExperimental.RequestOptions} requestOptions - Request-specific configuration.
@@ -401,6 +401,7 @@ export class CustomViewsExperimental {
      * @throws {@link Paid.BadRequestError}
      * @throws {@link Paid.ForbiddenError}
      * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.ConflictError}
      * @throws {@link Paid.InternalServerError}
      *
      * @example
@@ -439,6 +440,8 @@ export class CustomViewsExperimental {
                         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:
@@ -469,7 +472,89 @@ export class CustomViewsExperimental {
     /**
      * ⚠️ **Experimental** — this endpoint may change or be removed without notice and is not subject to v2 backwards-compatibility guarantees. Do not build production-critical integrations against it yet.
      *
-     * Runs every stored query of the view on the read-only analytics database and returns the result sets keyed by query id. For a customer-scoped view (the default), the query is scoped to the caller's organization AND the given `customerId` (both enforced as ClickHouse row filters) — `customerId` is required. For an organization-scoped view, the data is org-wide (scoped only to the caller's organization) and `customerId` is ignored. The scope is enforced by the database — it cannot be widened by the stored SQL. If the view declares filters, pass per-request values as `filter_<name>` query parameters (e.g. `filter_region=eu`); undeclared names or disallowed values are rejected with 400. Filters narrow data within the scope — never widen it.
+     * Lists active customer units for a published customer-scoped view with hierarchyEnabled set to true. Hierarchy eligibility is independent of the requested page or usage; requires credit hierarchies to be enabled for the organization.
+     *
+     * @param {Paid.GetCustomViewCustomerUnitsRequest} request
+     * @param {CustomViewsExperimental.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customViewsExperimental.getCustomViewCustomerUnits({
+     *         displayId: "displayId",
+     *         customerId: "cus_acme"
+     *     })
+     */
+    getCustomViewCustomerUnits(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getCustomViewCustomerUnits(request, requestOptions));
+    }
+    __getCustomViewCustomerUnits(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const { displayId, limit, offset, customerId } = request;
+            const _queryParams = {};
+            if (limit != null) {
+                _queryParams.limit = limit.toString();
+            }
+            if (offset != null) {
+                _queryParams.offset = offset.toString();
+            }
+            _queryParams.customerId = customerId;
+            const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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, `experimental/views/${core.url.encodePathParam(displayId)}/customer-units`),
+                method: "GET",
+                headers: _headers,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), 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 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 /experimental/views/{displayId}/customer-units.");
+                case "unknown":
+                    throw new errors.PaidError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * ⚠️ **Experimental** — this endpoint may change or be removed without notice and is not subject to v2 backwards-compatibility guarantees. Do not build production-critical integrations against it yet.
+     *
+     * Runs every stored query of the view on the read-only analytics database and returns the result sets keyed by query id. For a customer-scoped view (the default), the query is scoped to the caller's organization AND the given `customerId` (both enforced as ClickHouse row filters) — `customerId` is required. For an organization-scoped view, the data is org-wide (scoped only to the caller's organization) and `customerId` is ignored. The scope is enforced by the database — it cannot be widened by the stored SQL. If the view declares filters, pass per-request values as `filter_<name>` query parameters (e.g. `filter_region=eu`); undeclared names or disallowed values are rejected with 400. Filters narrow data within the scope — never widen it. Only PUBLISHED views are served by default; a DRAFT returns 404. To check a saved DRAFT's real data before publishing, pass `includeDraft=true`. Embeds and share links never serve a DRAFT.
      *
      * @param {Paid.GetCustomViewDataRequest} request
      * @param {CustomViewsExperimental.RequestOptions} requestOptions - Request-specific configuration.
@@ -478,6 +563,7 @@ export class CustomViewsExperimental {
      * @throws {@link Paid.ForbiddenError}
      * @throws {@link Paid.NotFoundError}
      * @throws {@link Paid.RequestTimeoutError}
+     * @throws {@link Paid.ConflictError}
      * @throws {@link Paid.TooManyRequestsError}
      * @throws {@link Paid.InternalServerError}
      *
@@ -492,7 +578,7 @@ export class CustomViewsExperimental {
     __getCustomViewData(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h;
-            const { displayId, customerId, periodKind, periodUnit, periodAmount, periodStart, periodEnd } = request;
+            const { displayId, customerId, periodKind, periodUnit, periodAmount, periodStart, periodEnd, includeDraft, unitMode, unitExternalId, } = request;
             const _queryParams = {};
             if (customerId != null) {
                 _queryParams.customerId = customerId;
@@ -512,6 +598,15 @@ export class CustomViewsExperimental {
             if (periodEnd != null) {
                 _queryParams.periodEnd = periodEnd;
             }
+            if (includeDraft != null) {
+                _queryParams.includeDraft = includeDraft;
+            }
+            if (unitMode != null) {
+                _queryParams.unitMode = unitMode;
+            }
+            if (unitExternalId != null) {
+                _queryParams.unitExternalId = unitExternalId;
+            }
             const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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, `experimental/views/${core.url.encodePathParam(displayId)}/data`),
@@ -535,6 +630,8 @@ export class CustomViewsExperimental {
                         throw new Paid.NotFoundError(_response.error.body, _response.rawResponse);
                     case 408:
                         throw new Paid.RequestTimeoutError(_response.error.body, _response.rawResponse);
+                    case 409:
+                        throw new Paid.ConflictError(_response.error.body, _response.rawResponse);
                     case 429:
                         throw new Paid.TooManyRequestsError(_response.error.body, _response.rawResponse);
                     case 500:

package/dist/esm/api/resources/customViewsExperimental/client/requests/CreateCustomViewRequest.d.mts

@@ -11,6 +11,10 @@ import type * as Paid from "../../../../index.mjs";
  *     }
  */
 export interface CreateCustomViewRequest {
+    /** Enable customer unit navigation for a customer-scoped view. Setting true requires customer hierarchies to be enabled for your organization, and every query must support unit selection. Existing views default to false. */
+    hierarchyEnabled?: boolean;
+    /** Send the customer's unit caps to the render bundle as `context.caps`. Needs `hierarchyEnabled` on a customer-scoped view. Turn it on only for views that draw cap usage: each load then reads cap usage from billing. Caps are spend policy, so an API key also needs `read:billing` to receive them in the data (they are left out otherwise) or to mint this view's embed token. Defaults to false. */
+    capsEnabled?: boolean;
     /** Human-readable view name (shown in preview + audit log). */
     name: string;
     /** Optional longer description of what the view shows. */

package/dist/esm/api/resources/customViewsExperimental/client/requests/GetCustomViewCustomerUnitsRequest.d.mts

@@ -0,0 +1,14 @@
+/**
+ * @example
+ *     {
+ *         displayId: "displayId",
+ *         customerId: "cus_acme"
+ *     }
+ */
+export interface GetCustomViewCustomerUnitsRequest {
+    displayId: string;
+    limit?: number;
+    offset?: number;
+    /** The customer's external ID, Paid customer ID, or internal ID. */
+    customerId: string;
+}

package/dist/esm/api/resources/customViewsExperimental/client/requests/GetCustomViewDataRequest.d.mts

@@ -19,4 +19,10 @@ export interface GetCustomViewDataRequest {
     periodStart?: string;
     /** absolute override only: inclusive end date (YYYY-MM-DD). */
     periodEnd?: string;
+    /** Pass 'true' to also serve a DRAFT view, so you can check its real data before publishing. Without it a DRAFT returns 404. End-customer embeds and share links never serve a DRAFT. */
+    includeDraft?: Paid.GetCustomViewDataRequestIncludeDraft;
+    /** Unit selection for this request. Omit both unit parameters for all customer activity. Shared links instead use their saved starting selection when omitted; pass all to reset a shared link. */
+    unitMode?: Paid.GetCustomViewDataRequestUnitMode;
+    /** The unit's external ID. Required with direct or subtree, and omitted with all. */
+    unitExternalId?: string;
 }

package/dist/esm/api/resources/customViewsExperimental/client/requests/UpdateCustomViewRequest.d.mts

@@ -7,6 +7,10 @@ import type * as Paid from "../../../../index.mjs";
  */
 export interface UpdateCustomViewRequest {
     displayId: string;
+    /** Enable customer unit navigation for a customer-scoped view. Setting true requires customer hierarchies to be enabled for your organization, and every query must support unit selection. Existing views default to false. */
+    hierarchyEnabled?: boolean;
+    /** Send the customer's unit caps to the render bundle as `context.caps`. Needs `hierarchyEnabled` on a customer-scoped view. Turn it on only for views that draw cap usage: each load then reads cap usage from billing. Caps are spend policy, so an API key also needs `read:billing` to receive them in the data (they are left out otherwise) or to mint this view's embed token. Defaults to false. */
+    capsEnabled?: boolean;
     /** New human-readable view name. */
     name?: string;
     /** New description; pass null to clear it. */

package/dist/esm/api/resources/customViewsExperimental/client/requests/index.d.mts

@@ -1,4 +1,5 @@
 export type { CreateCustomViewRequest } from "./CreateCustomViewRequest.mjs";
+export type { GetCustomViewCustomerUnitsRequest } from "./GetCustomViewCustomerUnitsRequest.mjs";
 export type { GetCustomViewDataRequest } from "./GetCustomViewDataRequest.mjs";
 export type { GetCustomViewEmbedTokenRequest } from "./GetCustomViewEmbedTokenRequest.mjs";
 export type { GetCustomViewRequest } from "./GetCustomViewRequest.mjs";

package/dist/esm/api/resources/customViewsExperimental/types/GetCustomViewDataRequestIncludeDraft.d.mts

@@ -0,0 +1,5 @@
+export declare const GetCustomViewDataRequestIncludeDraft: {
+    readonly True: "true";
+    readonly False: "false";
+};
+export type GetCustomViewDataRequestIncludeDraft = (typeof GetCustomViewDataRequestIncludeDraft)[keyof typeof GetCustomViewDataRequestIncludeDraft];

package/dist/esm/api/resources/customViewsExperimental/types/GetCustomViewDataRequestIncludeDraft.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+export const GetCustomViewDataRequestIncludeDraft = {
+    True: "true",
+    False: "false",
+};

package/dist/esm/api/resources/customViewsExperimental/types/GetCustomViewDataRequestUnitMode.d.mts

@@ -0,0 +1,6 @@
+export declare const GetCustomViewDataRequestUnitMode: {
+    readonly All: "all";
+    readonly Direct: "direct";
+    readonly Subtree: "subtree";
+};
+export type GetCustomViewDataRequestUnitMode = (typeof GetCustomViewDataRequestUnitMode)[keyof typeof GetCustomViewDataRequestUnitMode];

package/dist/esm/api/resources/customViewsExperimental/types/GetCustomViewDataRequestUnitMode.mjs

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+export const GetCustomViewDataRequestUnitMode = {
+    All: "all",
+    Direct: "direct",
+    Subtree: "subtree",
+};

package/dist/esm/api/resources/customViewsExperimental/types/index.d.mts

@@ -1,2 +1,4 @@
+export * from "./GetCustomViewDataRequestIncludeDraft.mjs";
 export * from "./GetCustomViewDataRequestPeriodKind.mjs";
 export * from "./GetCustomViewDataRequestPeriodUnit.mjs";
+export * from "./GetCustomViewDataRequestUnitMode.mjs";

package/dist/esm/api/resources/customViewsExperimental/types/index.mjs

@@ -1,2 +1,4 @@
+export * from "./GetCustomViewDataRequestIncludeDraft.mjs";
 export * from "./GetCustomViewDataRequestPeriodKind.mjs";
 export * from "./GetCustomViewDataRequestPeriodUnit.mjs";
+export * from "./GetCustomViewDataRequestUnitMode.mjs";

package/dist/esm/api/resources/customerPortals/client/Client.d.mts

@@ -11,7 +11,7 @@ export declare class CustomerPortals {
     protected readonly _options: CustomerPortals.Options;
     constructor(_options: CustomerPortals.Options);
     /**
-     * Creates a portal session for the customer. Returns a short-lived URL to the customer portal.
+     * Deprecated — the customer portal is being retired, and this endpoint will be removed in a future release. It keeps working for existing integrations meanwhile: it creates a portal session for the customer and returns a short-lived URL to the customer portal. Contact Paid before building anything new on it.
      *
      * @param {Paid.CreateCustomerPortalRequest} request
      * @param {CustomerPortals.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/api/resources/customerPortals/client/Client.mjs

@@ -18,7 +18,7 @@ export class CustomerPortals {
         this._options = _options;
     }
     /**
-     * Creates a portal session for the customer. Returns a short-lived URL to the customer portal.
+     * Deprecated — the customer portal is being retired, and this endpoint will be removed in a future release. It keeps working for existing integrations meanwhile: it creates a portal session for the customer and returns a short-lived URL to the customer portal. Contact Paid before building anything new on it.
      *
      * @param {Paid.CreateCustomerPortalRequest} request
      * @param {CustomerPortals.RequestOptions} requestOptions - Request-specific configuration.