@campfire-interactive/master-data-client 5.29.0 → 5.30.0

package/dist/types.d.ts

@@ -239,10 +239,15 @@ export interface Quote {
     customerCompanyId: string;
     programId: string | null;
     /**
-     * The OEM request this quote is one competing answer to — see {@link QuoteAsk}.
+     * The RFQ this quote is one competing answer to — see {@link Rfq}.
      * Null means it competes with nothing and is awardable on its own, which is a
      * legitimate state, not missing data.
      */
+    rfqId: string | null;
+    /**
+     * @deprecated The old spelling of {@link Quote.rfqId}, carrying the SAME
+     * value. Both are returned during the deprecation window; read `rfqId`.
+     */
     askId: string | null;
     /**
      * @deprecated A DERIVED MIRROR of the quote's lines — read `quoteLines.list()`
@@ -530,7 +535,156 @@ export interface SetEffectivePriceInput {
     /** Which app is writing — gated to 'omsf' | 'cpq' | 'admin' server-side. */
     callerRole: 'omsf' | 'cpq' | 'admin';
 }
+/**
+ * Five states, where the old `QuoteAskStatus` had three.
+ *
+ * `won` and `lost` split the old `resolved`, which could not say whether
+ * anybody had actually won — a resolved ask with no `resolvedByQuoteId` was a
+ * legal row and both consumer UIs papered over it. On this table the split is
+ * enforced by a CHECK: `won` implies a winner and nothing else may carry one.
+ *
+ * `merged` is new. It names the absorbed half of a duplicate and implies
+ * `mergedIntoRfqId`, also by CHECK.
+ */
+export type RfqStatus = 'open' | 'won' | 'lost' | 'cancelled' | 'merged';
+/**
+ * What made this RFQ. Never null and with no `unknown` member, deliberately:
+ * "did a machine mint this?" has to stay answerable, and a nullable column
+ * would answer it with a shrug.
+ */
+export type RfqSource = 'email' | 'manual' | 'cpq_fallback' | 'import';
+export interface Rfq {
+    id: string;
+    tenantId: string;
+    /** `RFQ-YYYY-NNN`, minted server-side from an atomic per-(tenant, year)
+     *  counter. Three digits is a MINIMUM width, not a maximum. */
+    rfqNumber: string;
+    customerCompanyId: string;
+    name: string | null;
+    /** The OEM's OWN number for this request — `GM-2026-4471`. Theirs, not ours,
+     *  so it is free text and not unique. */
+    customerReference: string | null;
+    /** When the REQUEST arrived — not when it was recorded. A separate fact from
+     *  `createdAt`, which is a job's timestamp once RFQs are minted
+     *  automatically. This is the denominator of every response-time question. */
+    receivedAt: string | null;
+    dueDate: string | null;
+    /**
+     * WHAT THE CUSTOMER ASKED FOR — not what we offered.
+     *
+     * {@link Quote.sopDate} is our answer and may legitimately differ, because we
+     * cannot always hit their date. This holds what the request said, unchanged.
+     * Two answers to two different questions, which is why both exist; the
+     * `requested` prefix says whose claim this one is.
+     *
+     * `YYYY-MM-DD`, or null when the request never stated it.
+     */
+    requestedSopDate: string | null;
+    /**
+     * How much of {@link Rfq.requestedSopDate} to believe. An extraction that
+     * read "SOP mid-2027" says `year`; one that read `2027-04` says `month`.
+     * Rendering the bare date without consulting this invents a precision the
+     * customer never gave.
+     */
+    requestedSopPrecision: SopEopPrecision | null;
+    requestedEopDate: string | null;
+    /** See {@link Rfq.requestedSopPrecision}. */
+    requestedEopPrecision: SopEopPrecision | null;
+    source: RfqSource;
+    /** Opaque provenance for whatever minted this — an OMSF inbound-RFQ id, an
+     *  import batch. Untyped and unvalidated on purpose: it crosses a service
+     *  boundary. */
+    sourceRef: string | null;
+    status: RfqStatus;
+    /** Which quote won. Present exactly when `status` is `won`. A recorded fact
+     *  — closing the siblings is a later phase. */
+    wonByQuoteId: string | null;
+    /** What absorbed this RFQ. Present exactly when `status` is `merged`. */
+    mergedIntoRfqId: string | null;
+    /** When the RFQ stopped being open. Set for every non-open status,
+     *  `cancelled` and `merged` included; null while open. */
+    closedAt: string | null;
+    /** Reporting only — NEVER used to decide competition. An opportunity spans
+     *  rounds; an RFQ is one round. */
+    opportunityId: string | null;
+    createdBy: string;
+    updatedBy: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface RfqSummary extends Rfq {
+    /** How many quotes compete in this RFQ. Deliberately not a value aggregate. */
+    quoteCount: number;
+}
+/**
+ * A RANGE across the RFQ's quotes — deliberately not a total.
+ *
+ * The quotes are ALTERNATIVES: three of four lose on every multi-scenario RFQ
+ * by construction, so adding them multiply-counts the same business.
+ */
+export interface RfqRange {
+    quoteCount: number;
+    minValue: number | null;
+    maxValue: number | null;
+    minBlendedMarginPct: number | null;
+    maxBlendedMarginPct: number | null;
+}
+export interface RfqCompetingQuote {
+    id: string;
+    quoteNumber: string;
+    name: string | null;
+    status: QuoteStatus;
+    lines: QuoteLine[];
+    rollUp: QuoteLineRollUp;
+}
+export interface RfqDetail extends Rfq {
+    quotes: RfqCompetingQuote[];
+    range: RfqRange;
+}
+export interface CreateRfqInput {
+    customerCompanyId: string;
+    name?: string | null;
+    customerReference?: string | null;
+    /** When the request arrived. Send it when you know it — see {@link Rfq}. */
+    receivedAt?: string | null;
+    dueDate?: string | null;
+    /** What the customer asked for, not what you will offer — see {@link Rfq}. */
+    requestedSopDate?: string | null;
+    /** Send this whenever the source was coarser than a day. */
+    requestedSopPrecision?: SopEopPrecision | null;
+    requestedEopDate?: string | null;
+    requestedEopPrecision?: SopEopPrecision | null;
+    /** Defaults to `manual`. */
+    source?: RfqSource;
+    sourceRef?: string | null;
+    opportunityId?: string | null;
+}
+export interface UpdateRfqInput {
+    name?: string | null;
+    customerReference?: string | null;
+    receivedAt?: string | null;
+    dueDate?: string | null;
+    requestedSopDate?: string | null;
+    requestedSopPrecision?: SopEopPrecision | null;
+    requestedEopDate?: string | null;
+    requestedEopPrecision?: SopEopPrecision | null;
+    sourceRef?: string | null;
+    opportunityId?: string | null;
+    status?: RfqStatus;
+    /** Required when `status` is `won`; must be one of this RFQ's own quotes. */
+    wonByQuoteId?: string | null;
+    /** Required when `status` is `merged`. Prefer `rfqs.merge(id, target)`. */
+    mergedIntoRfqId?: string | null;
+}
+export interface ListRfqsOptions {
+    status?: RfqStatus;
+    source?: RfqSource;
+    customerCompanyId?: string;
+    opportunityId?: string;
+}
+/** @deprecated Use {@link RfqStatus}. `resolved` splits into `won` / `lost`. */
 export type QuoteAskStatus = 'open' | 'resolved' | 'cancelled';
+/** @deprecated Use {@link Rfq}. Same row, same id. */
 export interface QuoteAsk {
     id: string;
     tenantId: string;
@@ -551,6 +705,7 @@ export interface QuoteAsk {
     createdAt: string;
     updatedAt: string;
 }
+/** @deprecated Use {@link RfqSummary}. */
 export interface QuoteAskSummary extends QuoteAsk {
     /** How many quotes compete in this ask. Deliberately not a value aggregate. */
     quoteCount: number;
@@ -561,6 +716,7 @@ export interface QuoteAskSummary extends QuoteAsk {
  * The quotes are ALTERNATIVES: three of four lose on every multi-scenario RFQ by
  * construction, so adding them multiply-counts the same business.
  */
+/** @deprecated Use {@link RfqRange}. Identical shape. */
 export interface QuoteAskRange {
     quoteCount: number;
     minValue: number | null;
@@ -568,6 +724,7 @@ export interface QuoteAskRange {
     minBlendedMarginPct: number | null;
     maxBlendedMarginPct: number | null;
 }
+/** @deprecated Use {@link RfqCompetingQuote}. */
 export interface QuoteAskCompetingQuote {
     id: string;
     quoteNumber: string;
@@ -576,16 +733,19 @@ export interface QuoteAskCompetingQuote {
     lines: QuoteLine[];
     rollUp: QuoteLineRollUp;
 }
+/** @deprecated Use {@link RfqDetail}. */
 export interface QuoteAskDetail extends QuoteAsk {
     quotes: QuoteAskCompetingQuote[];
     range: QuoteAskRange;
 }
+/** @deprecated Use {@link CreateRfqInput}. Creates with `source: 'manual'`. */
 export interface CreateQuoteAskInput {
     customerCompanyId: string;
     name?: string | null;
     opportunityId?: string | null;
     dueDate?: string | null;
 }
+/** @deprecated Use {@link UpdateRfqInput}. */
 export interface UpdateQuoteAskInput {
     name?: string | null;
     dueDate?: string | null;
@@ -594,6 +754,7 @@ export interface UpdateQuoteAskInput {
     /** Required when resolving; must be one of this ask's own quotes. */
     resolvedByQuoteId?: string | null;
 }
+/** @deprecated Use {@link ListRfqsOptions}. */
 export interface ListQuoteAsksOptions {
     status?: QuoteAskStatus;
     customerCompanyId?: string;
@@ -865,9 +1026,12 @@ export interface CreateQuoteInput {
     name?: string;
     customerCompanyId: string;
     programId?: string;
-    /** Join the quote to an OEM request ({@link QuoteAsk}). Optional — a quote with
-     *  no ask competes with nothing and is awardable on its own. Validated to exist
+    /** Join the quote to an RFQ ({@link Rfq}). Optional — a quote with no RFQ
+     *  competes with nothing and is awardable on its own. Validated to exist
      *  in-tenant AND to belong to the same customer as the quote. */
+    rfqId?: string | null;
+    /** @deprecated The old spelling of `rfqId`. Still accepted; when both are
+     *  sent, `rfqId` wins. */
     askId?: string | null;
     partId?: string;
     /** Historical/parent quote this one was copied from. Validated to exist
@@ -933,8 +1097,11 @@ export interface UpdateQuoteInput {
     quoteNumber?: string;
     name?: string | null;
     programId?: string | null;
-    /** Join the quote to an OEM request ({@link QuoteAsk}), or `null` to detach it
-     *  (it then competes with nothing). Validated to match the quote's customer. */
+    /** Join the quote to an RFQ ({@link Rfq}), or `null` to detach it (it then
+     *  competes with nothing). Validated to match the quote's customer. */
+    rfqId?: string | null;
+    /** @deprecated The old spelling of `rfqId`. Still accepted; when both are
+     *  sent, `rfqId` wins. Detaching through either clears both. */
     askId?: string | null;
     partId?: string | null;
     /** Set to a quote id to record provenance, or `null` to clear it. */