@campfire-interactive/master-data-client 5.24.0 → 5.26.0

package/dist/scopeGate.d.ts

@@ -0,0 +1,103 @@
+import { HttpTransport } from './http';
+import type { ScopeDimension, SingleResponse } from './types';
+/**
+ * The scope gate: who may see which records, once a tenant turns gating on.
+ *
+ * ONE implementation, shared. master-data can express the gate as an RLS policy
+ * because it owns the tables; OMSF and pm cannot — they have no RLS extension,
+ * so their gate is a clause in a query builder. A clause copied into a dozen
+ * call sites is a clause that gets missed in one of them, and a missed scope
+ * clause is a data leak rather than a cosmetic bug. So it lives here, with the
+ * fetching and caching it needs, and callers spread the result.
+ *
+ * TWO RULES SHAPE EVERYTHING, and both fail OPEN by deliberate decision
+ * (nextgen ADR 2026-09-14, decisions 3 and 4):
+ *
+ *   - A user with NO assignment is unrestricted. On the day gating ships nobody
+ *     has an assignment, and failing closed would lock out every user in the
+ *     tenant at once — with the omission that caused it looking exactly like
+ *     the feature working.
+ *   - A record with NO scope is visible to everyone. Almost nothing is scoped
+ *     at first, so failing closed would hide the entire dataset until someone
+ *     hand-scoped it.
+ *
+ * The consequence, which is easy to misread as the gate being broken: gating
+ * restricts nothing until BOTH a user is assigned AND records are scoped.
+ */
+export interface UserScopeSets {
+    userId: string;
+    geographicScopeIds: string[];
+    productScopeIds: string[];
+}
+/** A Prisma-shaped `where` fragment. Deliberately a plain object: this package
+ *  has no Prisma dependency and does not want one, and every consumer speaks
+ *  this shape. Spread it into an existing `where`. */
+export type ScopeGatePredicate = Record<string, unknown>;
+export interface BuildScopeGateOptions {
+    /** Which dimensions the tenant has gating switched ON for. A dimension that
+     *  is off contributes no clause at all. */
+    gatedDimensions: ScopeDimension[];
+    /** Column names, so a consumer whose table spells them differently can say
+     *  so. Defaults match master-data and OMSF. */
+    columns?: {
+        geographic?: string;
+        product?: string;
+    };
+}
+/**
+ * Build the `where` fragment restricting a list to what this user may see.
+ *
+ * Returns an EMPTY object when the gate should not restrict — spreading `{}`
+ * into a `where` is a no-op, so a caller never has to branch on "is gating on".
+ *
+ * Per dimension, when gating is on for it AND the user has assignments:
+ *
+ *   { OR: [ { <col>: null }, { <col>: { in: [...] } } ] }
+ *
+ * The `null` branch is rule 2 — an unscoped record is visible to everyone. Drop
+ * it and the gate hides almost the whole dataset on day one.
+ *
+ * Both dimensions gated produces an AND of the two, so a user must match on
+ * each. That is intersection, not union: someone assigned to Europe and to
+ * Doors sees European Doors work, which is what "my slice" means to the person
+ * asking for this feature.
+ */
+export declare function buildScopeGate(scopes: UserScopeSets | null, options: BuildScopeGateOptions): ScopeGatePredicate;
+/** Clear everything. Exposed for tests and for a process that wants a clean
+ *  slate; ordinary revocation is handled by the TTL. */
+export declare function clearScopeCache(): void;
+export declare class UserScopeResource {
+    private readonly http;
+    private readonly ttlMs;
+    private readonly cache;
+    constructor(http: HttpTransport, ttlMs?: number);
+    /** The caller's own sets, uncached. */
+    me(): Promise<SingleResponse<UserScopeSets>>;
+    /**
+     * The caller's own sets, cached for the TTL.
+     *
+     * Returns `null` rather than throwing when master-data cannot be reached.
+     * That is deliberate and it is the fail-open rule again: a gate that throws
+     * on a network blip takes every list in the app down, which is a worse
+     * outcome than briefly not restricting a feature that restricts nothing for
+     * most tenants anyway. Callers pass the null straight to buildScopeGate.
+     */
+    mineCached(cacheKey: string): Promise<UserScopeSets | null>;
+    /** Drop a cached entry, so an admin who just changed an assignment can see it
+     *  take effect without waiting out the TTL. */
+    invalidate(cacheKey: string): void;
+    /** Admin surface: every user in the tenant WITH an assignment. Users with
+     *  none are absent — master-data does not know the tenant's roster, so the
+     *  caller joins this against identity's user list. */
+    list(): Promise<{
+        data: UserScopeSets[];
+    }>;
+    get(userId: string): Promise<SingleResponse<UserScopeSets>>;
+    /** Replace a user's sets. Omit a dimension to leave it alone; send `[]` to
+     *  clear it, which returns the user to unrestricted. */
+    set(userId: string, input: {
+        geographicScopeIds?: string[];
+        productScopeIds?: string[];
+    }, idempotencyKey?: string): Promise<SingleResponse<UserScopeSets>>;
+}
+//# sourceMappingURL=scopeGate.d.ts.map

package/dist/scopeGate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scopeGate.d.ts","sourceRoot":"","sources":["../src/scopeGate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AACvC,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAE9D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAC7B,eAAe,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED;;sDAEsD;AACtD,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEzD,MAAM,WAAW,qBAAqB;IACpC;+CAC2C;IAC3C,eAAe,EAAE,cAAc,EAAE,CAAC;IAClC;mDAC+C;IAC/C,OAAO,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACrD;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,aAAa,GAAG,IAAI,EAC5B,OAAO,EAAE,qBAAqB,GAC7B,kBAAkB,CAyBpB;AAiCD;wDACwD;AACxD,wBAAgB,eAAe,IAAI,IAAI,CAEtC;AAED,qBAAa,iBAAiB;IAI1B,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,KAAK;IAJxB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAc;gBAGjB,IAAI,EAAE,aAAa,EACnB,KAAK,GAAE,MAAe;IAGzC,uCAAuC;IACjC,EAAE,IAAI,OAAO,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;IAOlD;;;;;;;;OAQG;IACG,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;IAejE;mDAC+C;IAC/C,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAIlC;;0DAEsD;IAChD,IAAI,IAAI,OAAO,CAAC;QAAE,IAAI,EAAE,aAAa,EAAE,CAAA;KAAE,CAAC;IAO1C,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;IAOjE;4DACwD;IAClD,GAAG,CACP,MAAM,EAAE,MAAM,EACd,KAAK,EAAE;QAAE,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,EACpE,cAAc,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;CAQ1C"}

package/dist/scopeGate.js

@@ -0,0 +1,155 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserScopeResource = void 0;
+exports.buildScopeGate = buildScopeGate;
+exports.clearScopeCache = clearScopeCache;
+/**
+ * Build the `where` fragment restricting a list to what this user may see.
+ *
+ * Returns an EMPTY object when the gate should not restrict — spreading `{}`
+ * into a `where` is a no-op, so a caller never has to branch on "is gating on".
+ *
+ * Per dimension, when gating is on for it AND the user has assignments:
+ *
+ *   { OR: [ { <col>: null }, { <col>: { in: [...] } } ] }
+ *
+ * The `null` branch is rule 2 — an unscoped record is visible to everyone. Drop
+ * it and the gate hides almost the whole dataset on day one.
+ *
+ * Both dimensions gated produces an AND of the two, so a user must match on
+ * each. That is intersection, not union: someone assigned to Europe and to
+ * Doors sees European Doors work, which is what "my slice" means to the person
+ * asking for this feature.
+ */
+function buildScopeGate(scopes, options) {
+    // No scope information at all — treat as unrestricted rather than guessing.
+    // A resolver that failed is the likely cause, and failing a read closed on a
+    // network blip would take the app down for everyone.
+    if (!scopes)
+        return {};
+    const geoColumn = options.columns?.geographic ?? 'geographicScopeId';
+    const productColumn = options.columns?.product ?? 'productScopeId';
+    const clauses = [];
+    if (options.gatedDimensions.includes('geographic') && scopes.geographicScopeIds.length > 0) {
+        clauses.push({
+            OR: [{ [geoColumn]: null }, { [geoColumn]: { in: [...scopes.geographicScopeIds] } }],
+        });
+    }
+    if (options.gatedDimensions.includes('product') && scopes.productScopeIds.length > 0) {
+        clauses.push({
+            OR: [{ [productColumn]: null }, { [productColumn]: { in: [...scopes.productScopeIds] } }],
+        });
+    }
+    if (clauses.length === 0)
+        return {};
+    if (clauses.length === 1)
+        return clauses[0];
+    return { AND: clauses };
+}
+/**
+ * The caller's own scope sets, cached briefly.
+ *
+ * The cache exists because the gate needs this on EVERY request in OMSF and pm,
+ * and a cross-service hop in front of every list query is the one place latency
+ * is most visible. master-data itself needs none of this — its tables are local.
+ *
+ * **The TTL is a revocation window.** Removing someone's scope does not take
+ * effect until their entry expires. 60 seconds is the agreed value: short
+ * enough that "I removed her access and she can still see it" never becomes a
+ * support call, long enough that a warm Lambda makes roughly one call per user
+ * per container lifetime.
+ *
+ * Keyed by tenant AND user: a container serves many callers, and the whole
+ * point of the gate is that they get different answers.
+ */
+/**
+ * MODULE-LEVEL, not per-instance, and that is not an optimization — it is the
+ * only thing that makes the cache work at all.
+ *
+ * OMSF constructs a fresh `MasterDataClient` on every call, because the auth
+ * token comes from the request context. A cache living on the resource instance
+ * would therefore be born and discarded inside a single request and never once
+ * be read, while looking entirely correct. Hoisting it to the module makes the
+ * lifetime what the design assumes: the container's.
+ *
+ * Safe to share because every key carries the tenant AND the user — two callers
+ * can never collide, which is the whole point of the gate.
+ */
+const scopeCache = new Map();
+/** Clear everything. Exposed for tests and for a process that wants a clean
+ *  slate; ordinary revocation is handled by the TTL. */
+function clearScopeCache() {
+    scopeCache.clear();
+}
+class UserScopeResource {
+    http;
+    ttlMs;
+    cache = scopeCache;
+    constructor(http, ttlMs = 60_000) {
+        this.http = http;
+        this.ttlMs = ttlMs;
+    }
+    /** The caller's own sets, uncached. */
+    async me() {
+        return this.http.request({
+            method: 'GET',
+            path: '/v1/user-scopes/me',
+        });
+    }
+    /**
+     * The caller's own sets, cached for the TTL.
+     *
+     * Returns `null` rather than throwing when master-data cannot be reached.
+     * That is deliberate and it is the fail-open rule again: a gate that throws
+     * on a network blip takes every list in the app down, which is a worse
+     * outcome than briefly not restricting a feature that restricts nothing for
+     * most tenants anyway. Callers pass the null straight to buildScopeGate.
+     */
+    async mineCached(cacheKey) {
+        const hit = this.cache.get(cacheKey);
+        if (hit && Date.now() - hit.at < this.ttlMs)
+            return hit.value;
+        try {
+            const response = await this.me();
+            this.cache.set(cacheKey, { at: Date.now(), value: response.data });
+            return response.data;
+        }
+        catch {
+            // Serve a stale entry if we have one — it is closer to the truth than
+            // nothing, and it keeps the revocation window bounded to the outage.
+            return hit ? hit.value : null;
+        }
+    }
+    /** Drop a cached entry, so an admin who just changed an assignment can see it
+     *  take effect without waiting out the TTL. */
+    invalidate(cacheKey) {
+        this.cache.delete(cacheKey);
+    }
+    /** Admin surface: every user in the tenant WITH an assignment. Users with
+     *  none are absent — master-data does not know the tenant's roster, so the
+     *  caller joins this against identity's user list. */
+    async list() {
+        return this.http.request({
+            method: 'GET',
+            path: '/v1/user-scopes',
+        });
+    }
+    async get(userId) {
+        return this.http.request({
+            method: 'GET',
+            path: `/v1/user-scopes/${encodeURIComponent(userId)}`,
+        });
+    }
+    /** Replace a user's sets. Omit a dimension to leave it alone; send `[]` to
+     *  clear it, which returns the user to unrestricted. */
+    async set(userId, input, idempotencyKey) {
+        return this.http.request({
+            method: 'PUT',
+            path: `/v1/user-scopes/${encodeURIComponent(userId)}`,
+            body: input,
+            idempotencyKey,
+        });
+    }
+}
+exports.UserScopeResource = UserScopeResource;
+//# sourceMappingURL=scopeGate.js.map

package/dist/scopeGate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scopeGate.js","sourceRoot":"","sources":["../src/scopeGate.ts"],"names":[],"mappings":";;;AAkEA,wCA4BC;AAmCD,0CAEC;AAnFD;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,cAAc,CAC5B,MAA4B,EAC5B,OAA8B;IAE9B,4EAA4E;IAC5E,6EAA6E;IAC7E,qDAAqD;IACrD,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IAEvB,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,EAAE,UAAU,IAAI,mBAAmB,CAAC;IACrE,MAAM,aAAa,GAAG,OAAO,CAAC,OAAO,EAAE,OAAO,IAAI,gBAAgB,CAAC;IAEnE,MAAM,OAAO,GAA8B,EAAE,CAAC;IAE9C,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,MAAM,CAAC,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3F,OAAO,CAAC,IAAI,CAAC;YACX,EAAE,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,kBAAkB,CAAC,EAAE,EAAE,CAAC;SACrF,CAAC,CAAC;IACL,CAAC;IACD,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,MAAM,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrF,OAAO,CAAC,IAAI,CAAC;YACX,EAAE,EAAE,CAAC,EAAE,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,eAAe,CAAC,EAAE,EAAE,CAAC;SAC1F,CAAC,CAAC;IACL,CAAC;IAED,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACpC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;IAC5C,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC;AAC1B,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,GAAG,IAAI,GAAG,EAAgD,CAAC;AAE3E;wDACwD;AACxD,SAAgB,eAAe;IAC7B,UAAU,CAAC,KAAK,EAAE,CAAC;AACrB,CAAC;AAED,MAAa,iBAAiB;IAIT;IACA;IAJF,KAAK,GAAG,UAAU,CAAC;IAEpC,YACmB,IAAmB,EACnB,QAAgB,MAAM;QADtB,SAAI,GAAJ,IAAI,CAAe;QACnB,UAAK,GAAL,KAAK,CAAiB;IACtC,CAAC;IAEJ,uCAAuC;IACvC,KAAK,CAAC,EAAE;QACN,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAgC;YACtD,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,oBAAoB;SAC3B,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,UAAU,CAAC,QAAgB;QAC/B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACrC,IAAI,GAAG,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK;YAAE,OAAO,GAAG,CAAC,KAAK,CAAC;QAE9D,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,EAAE,EAAE,CAAC;YACjC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;YACnE,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,MAAM,CAAC;YACP,sEAAsE;YACtE,qEAAqE;YACrE,OAAO,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;QAChC,CAAC;IACH,CAAC;IAED;mDAC+C;IAC/C,UAAU,CAAC,QAAgB;QACzB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC;IAED;;0DAEsD;IACtD,KAAK,CAAC,IAAI;QACR,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAA4B;YAClD,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,iBAAiB;SACxB,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,MAAc;QACtB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAgC;YACtD,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,mBAAmB,kBAAkB,CAAC,MAAM,CAAC,EAAE;SACtD,CAAC,CAAC;IACL,CAAC;IAED;4DACwD;IACxD,KAAK,CAAC,GAAG,CACP,MAAc,EACd,KAAoE,EACpE,cAAuB;QAEvB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAgC;YACtD,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,mBAAmB,kBAAkB,CAAC,MAAM,CAAC,EAAE;YACrD,IAAI,EAAE,KAAK;YACX,cAAc;SACf,CAAC,CAAC;IACL,CAAC;CACF;AA7ED,8CA6EC"}

package/dist/standardAttributes.d.ts

@@ -0,0 +1,80 @@
+import { HttpTransport } from './http';
+import type { StandardAttribute, CreateStandardAttributeInput, CreateStandardAttributeDefaultInput, UpdateStandardAttributeInput, StandardAttributeValue, SetStandardAttributeValueInput, SetStandardAttributeValueResult, StandardAttributeHistoryEntry, StandardAttributeDefault, UpdateStandardAttributeDefaultInput, SingleResponse, ListResponse } from './types';
+export declare class StandardAttributeResource {
+    private readonly http;
+    constructor(http: HttpTransport);
+    /** Add an attribute to THIS TENANT. Filled by a person — the enrichment
+     *  pass only knows the platform catalog. */
+    /** @deprecated Since 5.13.0 the server answers 410 Gone: standard attributes are default definitions, authored in `client.defaultAttributes` and switched per tenant with `attributeDefinitions.setEnabled`. */
+    create(input: CreateStandardAttributeInput, idempotencyKey?: string): Promise<SingleResponse<StandardAttribute>>;
+    /** ARCHIVE one. It stops being offered and every value already recorded
+     *  against it stays readable — so this never conflicts with what is stored,
+     *  and it is reversible. */
+    /** @deprecated Since 5.13.0 the server answers 410 Gone: standard attributes are default definitions, authored in `client.defaultAttributes` and switched per tenant with `attributeDefinitions.setEnabled`. */
+    archive(id: string): Promise<SingleResponse<StandardAttribute>>;
+    /** This tenant's attribute catalog, in display order. */
+    list(options?: {
+        enabledOnly?: boolean;
+    }): Promise<ListResponse<StandardAttribute>>;
+    /** Rename, reorder, enable or disable one attribute. `key` is immutable. */
+    update(id: string, input: UpdateStandardAttributeInput, idempotencyKey?: string): Promise<SingleResponse<StandardAttribute>>;
+    /**
+     * Quote ids whose attribute VALUES match free text.
+     *
+     * Prefer `quotes.list({ q })` — it matches these too, and it filters the page,
+     * so the count and the cursor agree with what you get. Reach for this only
+     * when you are narrowing an already-fetched list in a browser and need to know
+     * which rows matched on an attribute rather than on a visible column.
+     *
+     * Enabled, active attributes only: one switched off or archived is not offered
+     * on a quote, so a row returned because it matched one would be returned for a
+     * reason the user cannot see anywhere on screen.
+     */
+    searchQuoteIds(q: string): Promise<SingleResponse<{
+        ids: string[];
+    }>>;
+    /** Every stored value on one quote, in catalog order. */
+    listValues(quoteId: string): Promise<ListResponse<StandardAttributeValue>>;
+    /**
+     * Write values on a quote.
+     *
+     * Send the whole set in one call rather than looping: the server writes them
+     * in a single transaction, and `onlyIfBlank` on each input is what makes the
+     * enrichment pass fill blanks without ever overwriting a rep's correction.
+     */
+    setValues(quoteId: string, values: SetStandardAttributeValueInput[], idempotencyKey?: string): Promise<ListResponse<SetStandardAttributeValueResult>>;
+    /** Every stored value on one opportunity, in catalog order. */
+    listOpportunityValues(opportunityId: string): Promise<ListResponse<StandardAttributeValue>>;
+    /** Write values on an opportunity. Send the whole set in one call. */
+    setOpportunityValues(opportunityId: string, values: SetStandardAttributeValueInput[], idempotencyKey?: string): Promise<ListResponse<SetStandardAttributeValueResult>>;
+    /** One attribute's timeline on an opportunity, or the whole one's when no key. */
+    listOpportunityHistory(opportunityId: string, key?: string): Promise<ListResponse<StandardAttributeHistoryEntry>>;
+    /** One attribute's timeline on a quote, or the whole quote's when no key. */
+    listHistory(quoteId: string, key?: string): Promise<ListResponse<StandardAttributeHistoryEntry>>;
+    /** Add an attribute to the PLATFORM catalog. Seeds NEW tenants only —
+     *  tenants already provisioned keep the copy they have. */
+    /** @deprecated Since 5.13.0 the server answers 410 Gone: standard attributes are default definitions, authored in `client.defaultAttributes` and switched per tenant with `attributeDefinitions.setEnabled`. */
+    createDefault(input: CreateStandardAttributeDefaultInput, idempotencyKey?: string): Promise<SingleResponse<StandardAttributeDefault>>;
+    /** Stop seeding one into new tenants. Existing tenant copies and every value
+     *  ever recorded against the key are untouched. */
+    /** @deprecated Since 5.13.0 the server answers 410 Gone: standard attributes are default definitions, authored in `client.defaultAttributes` and switched per tenant with `attributeDefinitions.setEnabled`. */
+    removeDefault(id: string): Promise<SingleResponse<{
+        id: string;
+    }>>;
+    /**
+     * The PLATFORM-wide defaults, in display order — what a new tenant's copy is
+     * seeded from. Readable by any tenant; only the platform tenant can write.
+     */
+    listDefaults(): Promise<ListResponse<StandardAttributeDefault>>;
+    /**
+     * Rename or reorder one platform default.
+     *
+     * Changes what the NEXT tenant is seeded with. It does not reach tenants
+     * already provisioned — their copy is theirs to name.
+     *
+     * `key` is immutable — it is what every stored value references.
+     */
+    /** @deprecated Since 5.13.0 the server answers 410 Gone: standard attributes are default definitions, authored in `client.defaultAttributes` and switched per tenant with `attributeDefinitions.setEnabled`. */
+    updateDefault(id: string, input: UpdateStandardAttributeDefaultInput, idempotencyKey?: string): Promise<SingleResponse<StandardAttributeDefault>>;
+}
+//# sourceMappingURL=standardAttributes.d.ts.map

package/dist/standardAttributes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"standardAttributes.d.ts","sourceRoot":"","sources":["../src/standardAttributes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AACvC,OAAO,KAAK,EACV,iBAAiB,EACjB,4BAA4B,EAC5B,mCAAmC,EACnC,4BAA4B,EAC5B,sBAAsB,EACtB,8BAA8B,EAC9B,+BAA+B,EAC/B,6BAA6B,EAC7B,wBAAwB,EACxB,mCAAmC,EACnC,cAAc,EACd,YAAY,EACb,MAAM,SAAS,CAAC;AAUjB,qBAAa,yBAAyB;IACxB,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,aAAa;IAEhD;gDAC4C;IAC5C,gNAAgN;IAC1M,MAAM,CACV,KAAK,EAAE,4BAA4B,EACnC,cAAc,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;IAS7C;;gCAE4B;IAC5B,gNAAgN;IAC1M,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;IAOrE,yDAAyD;IACnD,IAAI,CAAC,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;IAQzF,4EAA4E;IACtE,MAAM,CACV,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,4BAA4B,EACnC,cAAc,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;IAS7C;;;;;;;;;;;OAWG;IACG,cAAc,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;QAAE,GAAG,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,CAAC;IAO3E,yDAAyD;IACnD,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,sBAAsB,CAAC,CAAC;IAOhF;;;;;;OAMG;IACG,SAAS,CACb,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,8BAA8B,EAAE,EACxC,cAAc,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,YAAY,CAAC,+BAA+B,CAAC,CAAC;IAqBzD,+DAA+D;IACzD,qBAAqB,CACzB,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,YAAY,CAAC,sBAAsB,CAAC,CAAC;IAOhD,sEAAsE;IAChE,oBAAoB,CACxB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,8BAA8B,EAAE,EACxC,cAAc,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,YAAY,CAAC,+BAA+B,CAAC,CAAC;IASzD,kFAAkF;IAC5E,sBAAsB,CAC1B,aAAa,EAAE,MAAM,EACrB,GAAG,CAAC,EAAE,MAAM,GACX,OAAO,CAAC,YAAY,CAAC,6BAA6B,CAAC,CAAC;IAQvD,6EAA6E;IACvE,WAAW,CACf,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,MAAM,GACX,OAAO,CAAC,YAAY,CAAC,6BAA6B,CAAC,CAAC;IAUvD;+DAC2D;IAC3D,gNAAgN;IAC1M,aAAa,CACjB,KAAK,EAAE,mCAAmC,EAC1C,cAAc,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,cAAc,CAAC,wBAAwB,CAAC,CAAC;IASpD;uDACmD;IACnD,gNAAgN;IAC1M,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAOxE;;;OAGG;IACG,YAAY,IAAI,OAAO,CAAC,YAAY,CAAC,wBAAwB,CAAC,CAAC;IAOrE;;;;;;;OAOG;IACH,gNAAgN;IAC1M,aAAa,CACjB,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,mCAAmC,EAC1C,cAAc,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,cAAc,CAAC,wBAAwB,CAAC,CAAC;CAQrD"}

package/dist/standardAttributes.js

@@ -0,0 +1,188 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StandardAttributeResource = void 0;
+// Standard Attributes: the platform-owned set of vehicle and program facts a
+// quote carries, each with the source it came from and a full change history.
+// See nextgen docs/decisions/2026-09-18-standard-attributes.md.
+//
+// The catalog is landlord-owned and provisioned per tenant, and a tenant can
+// add its own beside the seeded ones. Nothing is ever destroyed: a tenant
+// ARCHIVES an attribute, which stops it being offered and leaves every recorded
+// value readable. `key` is immutable throughout.
+class StandardAttributeResource {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /** Add an attribute to THIS TENANT. Filled by a person — the enrichment
+     *  pass only knows the platform catalog. */
+    /** @deprecated Since 5.13.0 the server answers 410 Gone: standard attributes are default definitions, authored in `client.defaultAttributes` and switched per tenant with `attributeDefinitions.setEnabled`. */
+    async create(input, idempotencyKey) {
+        return this.http.request({
+            method: 'POST',
+            path: '/v1/standard-attributes',
+            body: input,
+            idempotencyKey,
+        });
+    }
+    /** ARCHIVE one. It stops being offered and every value already recorded
+     *  against it stays readable — so this never conflicts with what is stored,
+     *  and it is reversible. */
+    /** @deprecated Since 5.13.0 the server answers 410 Gone: standard attributes are default definitions, authored in `client.defaultAttributes` and switched per tenant with `attributeDefinitions.setEnabled`. */
+    async archive(id) {
+        return this.http.request({
+            method: 'DELETE',
+            path: `/v1/standard-attributes/${encodeURIComponent(id)}`,
+        });
+    }
+    /** This tenant's attribute catalog, in display order. */
+    async list(options) {
+        const query = options?.enabledOnly ? '?enabledOnly=true' : '';
+        return this.http.request({
+            method: 'GET',
+            path: `/v1/standard-attributes${query}`,
+        });
+    }
+    /** Rename, reorder, enable or disable one attribute. `key` is immutable. */
+    async update(id, input, idempotencyKey) {
+        return this.http.request({
+            method: 'PATCH',
+            path: `/v1/standard-attributes/${encodeURIComponent(id)}`,
+            body: input,
+            idempotencyKey,
+        });
+    }
+    /**
+     * Quote ids whose attribute VALUES match free text.
+     *
+     * Prefer `quotes.list({ q })` — it matches these too, and it filters the page,
+     * so the count and the cursor agree with what you get. Reach for this only
+     * when you are narrowing an already-fetched list in a browser and need to know
+     * which rows matched on an attribute rather than on a visible column.
+     *
+     * Enabled, active attributes only: one switched off or archived is not offered
+     * on a quote, so a row returned because it matched one would be returned for a
+     * reason the user cannot see anywhere on screen.
+     */
+    async searchQuoteIds(q) {
+        return this.http.request({
+            method: 'GET',
+            path: `/v1/standard-attributes/search?q=${encodeURIComponent(q)}`,
+        });
+    }
+    /** Every stored value on one quote, in catalog order. */
+    async listValues(quoteId) {
+        return this.http.request({
+            method: 'GET',
+            path: `/v1/quotes/${encodeURIComponent(quoteId)}/standard-attributes`,
+        });
+    }
+    /**
+     * Write values on a quote.
+     *
+     * Send the whole set in one call rather than looping: the server writes them
+     * in a single transaction, and `onlyIfBlank` on each input is what makes the
+     * enrichment pass fill blanks without ever overwriting a rep's correction.
+     */
+    async setValues(quoteId, values, idempotencyKey) {
+        return this.http.request({
+            method: 'PUT',
+            path: `/v1/quotes/${encodeURIComponent(quoteId)}/standard-attributes`,
+            body: { values },
+            idempotencyKey,
+        });
+    }
+    // ── The same three, against an opportunity ────────────────────────────────
+    //
+    // An opportunity's Program & Vehicle values used to be resolved live and
+    // stored nowhere, so there was no home for a value somebody typed or for a
+    // migration to land. These give it the same store a quote has.
+    //
+    // The opportunity is an OMSF record; master-data holds the values against a
+    // loose id and does not check that it names anything. Values on an
+    // opportunity are independent of its quotes' — a quote copies at create via
+    // the enrichment pass and then diverges, so that an approver's figures cannot
+    // move because somebody edited the opportunity.
+    /** Every stored value on one opportunity, in catalog order. */
+    async listOpportunityValues(opportunityId) {
+        return this.http.request({
+            method: 'GET',
+            path: `/v1/opportunities/${encodeURIComponent(opportunityId)}/standard-attributes`,
+        });
+    }
+    /** Write values on an opportunity. Send the whole set in one call. */
+    async setOpportunityValues(opportunityId, values, idempotencyKey) {
+        return this.http.request({
+            method: 'PUT',
+            path: `/v1/opportunities/${encodeURIComponent(opportunityId)}/standard-attributes`,
+            body: { values },
+            idempotencyKey,
+        });
+    }
+    /** One attribute's timeline on an opportunity, or the whole one's when no key. */
+    async listOpportunityHistory(opportunityId, key) {
+        const query = key ? `?key=${encodeURIComponent(key)}` : '';
+        return this.http.request({
+            method: 'GET',
+            path: `/v1/opportunities/${encodeURIComponent(opportunityId)}/standard-attributes/history${query}`,
+        });
+    }
+    /** One attribute's timeline on a quote, or the whole quote's when no key. */
+    async listHistory(quoteId, key) {
+        const query = key ? `?key=${encodeURIComponent(key)}` : '';
+        return this.http.request({
+            method: 'GET',
+            path: `/v1/quotes/${encodeURIComponent(quoteId)}/standard-attributes/history${query}`,
+        });
+    }
+    // ── The landlord catalog ───────────────────────────────────────────────────
+    /** Add an attribute to the PLATFORM catalog. Seeds NEW tenants only —
+     *  tenants already provisioned keep the copy they have. */
+    /** @deprecated Since 5.13.0 the server answers 410 Gone: standard attributes are default definitions, authored in `client.defaultAttributes` and switched per tenant with `attributeDefinitions.setEnabled`. */
+    async createDefault(input, idempotencyKey) {
+        return this.http.request({
+            method: 'POST',
+            path: '/v1/standard-attribute-defaults',
+            body: input,
+            idempotencyKey,
+        });
+    }
+    /** Stop seeding one into new tenants. Existing tenant copies and every value
+     *  ever recorded against the key are untouched. */
+    /** @deprecated Since 5.13.0 the server answers 410 Gone: standard attributes are default definitions, authored in `client.defaultAttributes` and switched per tenant with `attributeDefinitions.setEnabled`. */
+    async removeDefault(id) {
+        return this.http.request({
+            method: 'DELETE',
+            path: `/v1/standard-attribute-defaults/${encodeURIComponent(id)}`,
+        });
+    }
+    /**
+     * The PLATFORM-wide defaults, in display order — what a new tenant's copy is
+     * seeded from. Readable by any tenant; only the platform tenant can write.
+     */
+    async listDefaults() {
+        return this.http.request({
+            method: 'GET',
+            path: '/v1/standard-attribute-defaults',
+        });
+    }
+    /**
+     * Rename or reorder one platform default.
+     *
+     * Changes what the NEXT tenant is seeded with. It does not reach tenants
+     * already provisioned — their copy is theirs to name.
+     *
+     * `key` is immutable — it is what every stored value references.
+     */
+    /** @deprecated Since 5.13.0 the server answers 410 Gone: standard attributes are default definitions, authored in `client.defaultAttributes` and switched per tenant with `attributeDefinitions.setEnabled`. */
+    async updateDefault(id, input, idempotencyKey) {
+        return this.http.request({
+            method: 'PATCH',
+            path: `/v1/standard-attribute-defaults/${encodeURIComponent(id)}`,
+            body: input,
+            idempotencyKey,
+        });
+    }
+}
+exports.StandardAttributeResource = StandardAttributeResource;
+//# sourceMappingURL=standardAttributes.js.map

package/dist/standardAttributes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"standardAttributes.js","sourceRoot":"","sources":["../src/standardAttributes.ts"],"names":[],"mappings":";;;AAgBA,6EAA6E;AAC7E,8EAA8E;AAC9E,gEAAgE;AAChE,EAAE;AACF,6EAA6E;AAC7E,0EAA0E;AAC1E,gFAAgF;AAChF,iDAAiD;AACjD,MAAa,yBAAyB;IACP;IAA7B,YAA6B,IAAmB;QAAnB,SAAI,GAAJ,IAAI,CAAe;IAAG,CAAC;IAEpD;gDAC4C;IAC5C,gNAAgN;IAChN,KAAK,CAAC,MAAM,CACV,KAAmC,EACnC,cAAuB;QAEvB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAoC;YAC1D,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,yBAAyB;YAC/B,IAAI,EAAE,KAAK;YACX,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IAED;;gCAE4B;IAC5B,gNAAgN;IAChN,KAAK,CAAC,OAAO,CAAC,EAAU;QACtB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAoC;YAC1D,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,2BAA2B,kBAAkB,CAAC,EAAE,CAAC,EAAE;SAC1D,CAAC,CAAC;IACL,CAAC;IAED,yDAAyD;IACzD,KAAK,CAAC,IAAI,CAAC,OAAmC;QAC5C,MAAM,KAAK,GAAG,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9D,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAkC;YACxD,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,0BAA0B,KAAK,EAAE;SACxC,CAAC,CAAC;IACL,CAAC;IAED,4EAA4E;IAC5E,KAAK,CAAC,MAAM,CACV,EAAU,EACV,KAAmC,EACnC,cAAuB;QAEvB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAoC;YAC1D,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,2BAA2B,kBAAkB,CAAC,EAAE,CAAC,EAAE;YACzD,IAAI,EAAE,KAAK;YACX,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,cAAc,CAAC,CAAS;QAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAoC;YAC1D,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,oCAAoC,kBAAkB,CAAC,CAAC,CAAC,EAAE;SAClE,CAAC,CAAC;IACL,CAAC;IAED,yDAAyD;IACzD,KAAK,CAAC,UAAU,CAAC,OAAe;QAC9B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAuC;YAC7D,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,cAAc,kBAAkB,CAAC,OAAO,CAAC,sBAAsB;SACtE,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,SAAS,CACb,OAAe,EACf,MAAwC,EACxC,cAAuB;QAEvB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAgD;YACtE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,cAAc,kBAAkB,CAAC,OAAO,CAAC,sBAAsB;YACrE,IAAI,EAAE,EAAE,MAAM,EAAE;YAChB,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IAED,6EAA6E;IAC7E,EAAE;IACF,yEAAyE;IACzE,2EAA2E;IAC3E,+DAA+D;IAC/D,EAAE;IACF,4EAA4E;IAC5E,mEAAmE;IACnE,4EAA4E;IAC5E,8EAA8E;IAC9E,gDAAgD;IAEhD,+DAA+D;IAC/D,KAAK,CAAC,qBAAqB,CACzB,aAAqB;QAErB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAuC;YAC7D,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,qBAAqB,kBAAkB,CAAC,aAAa,CAAC,sBAAsB;SACnF,CAAC,CAAC;IACL,CAAC;IAED,sEAAsE;IACtE,KAAK,CAAC,oBAAoB,CACxB,aAAqB,EACrB,MAAwC,EACxC,cAAuB;QAEvB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAgD;YACtE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,qBAAqB,kBAAkB,CAAC,aAAa,CAAC,sBAAsB;YAClF,IAAI,EAAE,EAAE,MAAM,EAAE;YAChB,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IAED,kFAAkF;IAClF,KAAK,CAAC,sBAAsB,CAC1B,aAAqB,EACrB,GAAY;QAEZ,MAAM,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,QAAQ,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3D,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAA8C;YACpE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,qBAAqB,kBAAkB,CAAC,aAAa,CAAC,+BAA+B,KAAK,EAAE;SACnG,CAAC,CAAC;IACL,CAAC;IAED,6EAA6E;IAC7E,KAAK,CAAC,WAAW,CACf,OAAe,EACf,GAAY;QAEZ,MAAM,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,QAAQ,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3D,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAA8C;YACpE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,cAAc,kBAAkB,CAAC,OAAO,CAAC,+BAA+B,KAAK,EAAE;SACtF,CAAC,CAAC;IACL,CAAC;IAED,8EAA8E;IAE9E;+DAC2D;IAC3D,gNAAgN;IAChN,KAAK,CAAC,aAAa,CACjB,KAA0C,EAC1C,cAAuB;QAEvB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAA2C;YACjE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,iCAAiC;YACvC,IAAI,EAAE,KAAK;YACX,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IAED;uDACmD;IACnD,gNAAgN;IAChN,KAAK,CAAC,aAAa,CAAC,EAAU;QAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAiC;YACvD,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,mCAAmC,kBAAkB,CAAC,EAAE,CAAC,EAAE;SAClE,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY;QAChB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAyC;YAC/D,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,iCAAiC;SACxC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,gNAAgN;IAChN,KAAK,CAAC,aAAa,CACjB,EAAU,EACV,KAA0C,EAC1C,cAAuB;QAEvB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAA2C;YACjE,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,mCAAmC,kBAAkB,CAAC,EAAE,CAAC,EAAE;YACjE,IAAI,EAAE,KAAK;YACX,cAAc;SACf,CAAC,CAAC;IACL,CAAC;CACF;AA1ND,8DA0NC"}

package/dist/types.d.ts

@@ -299,6 +299,16 @@ export interface Quote {
     effectiveCostBreakdown: unknown;
     /** Quote-level line-item cost detail for OEM cost-form export (4.18.0). */
     effectiveCostDetail: unknown;
+    /**
+     * "Contract in place" on an awarded quote — see `quotes.setContract`. Null
+     * until recorded. A program is Contracted once every quote behind its
+     * finished goods has one. (5.26.0)
+     */
+    contractedAt: string | null;
+    contractedBy: string | null;
+    contractReference: string | null;
+    /** The signed contract in DMS, when it was filed there. */
+    contractDocumentId: string | null;
     effectiveUnitPrice: string | null;
     effectivePriceSource: string | null;
     effectivePriceBasis: string | null;
@@ -2144,6 +2154,8 @@ export interface Equipment {
     defaultAutomationPct: number;
     defaultMachinesPerOperator: number;
     defaultSetupCrew: number;
+    /** Custom-attribute values, keyed by registry definition key (entityType 'equipment'). */
+    attributes: Record<string, unknown>;
     active: boolean;
     createdAt: string;
     updatedAt: string;
@@ -2161,6 +2173,8 @@ export interface CreateEquipmentInput {
     defaultAutomationPct?: number;
     defaultMachinesPerOperator?: number;
     defaultSetupCrew?: number;
+    /** Custom-attribute values, keyed by registry definition key (entityType 'equipment'). On update, keys merge into the stored bag and a null value clears that key. */
+    attributes?: Record<string, unknown>;
     active?: boolean;
 }
 export interface UpdateEquipmentInput {
@@ -2175,6 +2189,8 @@ export interface UpdateEquipmentInput {
     defaultAutomationPct?: number;
     defaultMachinesPerOperator?: number;
     defaultSetupCrew?: number;
+    /** Custom-attribute values, keyed by registry definition key (entityType 'equipment'). On update, keys merge into the stored bag and a null value clears that key. */
+    attributes?: Record<string, unknown>;
     active?: boolean;
 }
 /** Outcome of `equipment.batchUpsert`. A bad row is reported, not fatal — a
@@ -3667,6 +3683,23 @@ export type BatchChildItemResult = {
     code: string;
     details?: unknown[];
 };
+/** An equipment import row. `updated` means the machine already existed and the row's custom-attribute
+ *  values were merged into it (nothing else on the machine was touched). */
+export type BatchEquipmentImportItemResult = BatchChildItemResult | {
+    index: number;
+    status: 'updated';
+    data: unknown;
+};
+export interface BatchEquipmentImportResult {
+    results: BatchEquipmentImportItemResult[];
+    /** `updated` is present only when the file merged attributes into existing machines. */
+    summary: {
+        total: number;
+        created: number;
+        errors: number;
+        updated?: number;
+    };
+}
 export interface BatchCreateChildResult {
     results: BatchChildItemResult[];
     summary: {
@@ -3726,6 +3759,8 @@ export interface ImportCommitResult {
     parts?: BatchCreateMaterialsResult;
     programs?: BatchCreateChildResult;
     partCategories?: BatchCreateChildResult;
+    /** Equipment sheets: new machines created, plus existing machines whose attribute values were merged. */
+    equipment?: BatchEquipmentImportResult;
     rateLibraries?: BatchCreateChildResult;
     rateEntries?: BatchCreateChildResult;
     /** Child rows skipped because their parent failed to commit (contacts /
@@ -4334,4 +4369,11 @@ export interface PutWorkingCalendarExceptionInput {
     working?: boolean;
     reason: string;
 }
+/** Body of `quotes.setContract` (5.26.0). Both optional; omitted keeps the stored value. */
+export interface SetQuoteContractInput {
+    /** A contract number or other identifier, as the customer writes it. */
+    reference?: string | null;
+    /** The signed contract's DMS document id. */
+    documentId?: string | null;
+}
 //# sourceMappingURL=types.d.ts.map