@campfire-interactive/master-data-client 5.10.2 → 5.12.0

package/dist/types.d.ts

@@ -877,7 +877,7 @@ export interface ListQuotesOptions {
     /**
      * `all` returns every status. `open` returns only the statuses still in
      * play — `OPEN_QUOTE_STATUSES`, i.e. everything but `awarded`, `lost` and
-     * `not_taken`. (5.9.0)
+     * `not_taken`. (5.10.2)
      *
      * Omitting defaults to "not closed": `lost` and `not_taken` are excluded,
      * `awarded` is not. That default is deliberately unchanged — it is what
@@ -1265,6 +1265,8 @@ export interface RateElement {
     equipmentCode: string | null;
     equipmentId: string | null;
     skillClass: string | null;
+    /** Product segment when the tenant's labor axis includes segment. */
+    segment?: string | null;
     lane: string | null;
     mode: string | null;
     container: string | null;
@@ -1287,6 +1289,7 @@ export interface CreateRateElementInput {
     equipmentCode?: string | null;
     equipmentId?: string | null;
     skillClass?: string | null;
+    segment?: string | null;
     lane?: string | null;
     mode?: string | null;
     container?: string | null;
@@ -1567,6 +1570,12 @@ export interface RekeyPlantsReport {
         equipmentIds: number;
     };
 }
+export interface RateSnapshotOptions {
+    /** ISO date the snapshot is taken as of. Defaults to now. */
+    asOf?: string;
+    /** Scope elements and legacy entries to this plant (plus the global ones). */
+    plantId?: string;
+}
 export interface RateSnapshot {
     asOf: string;
     books: Array<{
@@ -1591,6 +1600,7 @@ export interface RateSnapshot {
         equipmentCode: string | null;
         equipmentId: string | null;
         skillClass: string | null;
+        segment?: string | null;
         lane: string | null;
         mode: string | null;
         container: string | null;
@@ -1715,6 +1725,11 @@ export interface RateSnapshot {
             ratePerKg: number | null;
         }>;
     }>;
+    /** Which labor columns this tenant uses. Absent on older snapshots means skill only. */
+    laborAxes?: {
+        skill: boolean;
+        segment: boolean;
+    };
 }
 export type RateCategoryKind = 'material' | 'packaging' | 'freight' | 'labor';
 /** The active book summary (`GET /v1/rate-books/active` → `{ book }`). */
@@ -1796,6 +1811,10 @@ export interface CategoryRateRow {
         rate: number;
         origin: string;
     }>;
+    skillClass?: string | null;
+    segment?: string | null;
+    lineCode?: string | null;
+    lineLabel?: string | null;
 }
 /** A packaging-container option (`GET /v1/rate-containers` → `{ rows }`). */
 export interface RateContainer {
@@ -1851,6 +1870,7 @@ export interface AddRateElementsInput {
     lane?: string;
     mode?: string;
     skillClass?: string;
+    segment?: string;
     entries: AddRateEntry[];
 }
 export interface AddRateElementsResult {
@@ -1928,6 +1948,7 @@ export interface RateBookExportRow {
     plantCode: string | null;
     /** equipmentCode | gradeCode | container | lane (the identity dim). */
     itemCode: string;
+    segment?: string | null;
     itemLabel: string | null;
     lineCode: string | null;
     uom: string | null;
@@ -1955,6 +1976,7 @@ export interface RateBookImportRow {
     scope: 'plant' | 'global';
     plantCode?: string | null;
     itemCode: string;
+    segment?: string | null;
     lineCode?: string | null;
     /** The value UoM when creating a new element. */
     uom?: string | null;
@@ -3950,4 +3972,211 @@ export interface AiLlmConfigRows {
     valid_providers: string[];
     suggested_models: Record<string, string[]>;
 }
+export type KnownWorkStepSubjectKind = 'quote' | 'vehicle_program' | 'launch_program';
+/** OPEN union: a new kind is an additive change, so do not switch exhaustively. */
+export type WorkStepSubjectKind = KnownWorkStepSubjectKind | (string & {});
+/** Stored state. `at_risk` and `past_due` are derived at read time (see WorkStepDisplayState). */
+export type WorkStepState = 'not_started' | 'open' | 'done';
+export type KnownWorkStepDisplayState = WorkStepState | 'at_risk' | 'past_due';
+export type WorkStepDisplayState = KnownWorkStepDisplayState | (string & {});
+/**
+ * How the timing was obtained. `late` is only claimable for `measured` and
+ * `signed_off`; everything else is a record, not a measurement.
+ */
+export type KnownWorkStepCertainty = 'measured' | 'signed_off' | 'observed' | 'recorded' | 'untracked';
+export type WorkStepCertainty = KnownWorkStepCertainty | (string & {});
+/** The role a write is made on behalf of. The server checks it against the subject kind. */
+export type WorkStepCallerRole = 'omsf' | 'cpq' | 'pm' | 'admin';
+export type WorkStepStandardUnit = 'hours' | 'days';
+export type WorkStepSlaBasis = 'internal' | 'elapsed';
+export type WorkStepAnchor = 'award' | 'sop' | 'eop' | 'gap_fraction' | 'custom';
+export interface WorkStepDefinition {
+    /** null when this is the platform default and the tenant has no row. */
+    id: string | null;
+    stepCode: string;
+    subjectKind: WorkStepSubjectKind;
+    variant: string;
+    grain: 'subject' | 'child';
+    plannedBasis: 'duration' | 'anchored_date' | 'fixed_date';
+    label: string;
+    milestone: string | null;
+    sortOrder: number;
+    parentCode: string | null;
+    standardQty: number | null;
+    standardUnit: WorkStepStandardUnit;
+    slaBasis: WorkStepSlaBasis;
+    anchor: WorkStepAnchor | null;
+    anchorFraction: number | null;
+    ownerRole: string | null;
+    ownerScope: 'tenant' | 'child_team';
+    measurementSource: string;
+    active: boolean;
+    /** true when a tenant row exists; false when this is the platform default. */
+    customized: boolean;
+}
+export interface ListWorkStepDefinitionsOptions {
+    /** Omit for every kind. */
+    subjectKind?: WorkStepSubjectKind;
+    /** 'default' or 'eco' (quote steps only). */
+    variant?: string;
+    includeInactive?: boolean;
+}
+export interface WorkStepDefinitionRowInput {
+    stepCode: string;
+    /** Program kinds only; the quote graph is fixed. */
+    label?: string;
+    milestone?: string | null;
+    sortOrder?: number;
+    standardQty?: number | null;
+    standardUnit?: WorkStepStandardUnit;
+    slaBasis?: WorkStepSlaBasis;
+    anchor?: WorkStepAnchor | null;
+    anchorFraction?: number | null;
+    ownerRole?: string | null;
+    active?: boolean;
+    /** Custom (non-catalog) program steps only. */
+    plannedBasis?: 'anchored_date' | 'fixed_date';
+}
+export interface SaveWorkStepDefinitionsInput {
+    subjectKind: WorkStepSubjectKind;
+    variant?: string;
+    rows: WorkStepDefinitionRowInput[];
+    /** Deactivate this kind's custom steps absent from `rows`. */
+    archiveMissing?: boolean;
+}
+/** One execution of a step. Dates are ISO-8601 strings on the wire. */
+export interface WorkStepEpisode {
+    id: string;
+    subjectType: WorkStepSubjectKind;
+    subjectId: string;
+    /** '' for a subject-grain step. */
+    childId: string;
+    childLabel: string | null;
+    stepCode: string;
+    iteration: number;
+    plannedStart: string | null;
+    plannedEnd: string | null;
+    actualStart: string | null;
+    actualEnd: string | null;
+    state: WorkStepState;
+    certainty: WorkStepCertainty;
+    openedBy: string | null;
+    closedBy: string | null;
+    reopenReason: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface WorkStepSeriesEntry {
+    subjectType: WorkStepSubjectKind;
+    subjectId: string;
+    childId: string;
+    childLabel: string | null;
+    stepCode: string;
+    /** The latest iteration wins. */
+    latest: WorkStepEpisode;
+    iterations: number;
+    reopenCount: number;
+    derived: {
+        displayState: WorkStepDisplayState;
+        /** null when it cannot be claimed. */
+        late: boolean | null;
+    };
+}
+export interface WorkStepKeyInput {
+    subjectType: WorkStepSubjectKind;
+    subjectId: string;
+    /** Required for per-child steps. */
+    childId?: string;
+    stepCode: string;
+    callerRole: WorkStepCallerRole;
+}
+export interface OpenWorkStepInput extends WorkStepKeyInput {
+    childLabel?: string | null;
+    variant?: string;
+    /** Plant whose calendar governs an internal-days standard. */
+    calendarSourceId?: string | null;
+    actualStart?: string | null;
+    plannedStart?: string | null;
+    plannedEnd?: string | null;
+    openedBy?: string | null;
+}
+export interface CloseWorkStepInput extends WorkStepKeyInput {
+    variant?: string;
+    actualEnd?: string | null;
+    closedBy?: string | null;
+    childLabel?: string | null;
+}
+export interface ReopenWorkStepInput extends WorkStepKeyInput {
+    variant?: string;
+    calendarSourceId?: string | null;
+    reopenReason: string;
+    openedBy?: string | null;
+}
+export interface BatchWorkStepEpisodeRow {
+    subjectType: WorkStepSubjectKind;
+    subjectId: string;
+    childId?: string;
+    stepCode: string;
+    /** The caller supplies the iteration here (default 1); open/reopen assign it server-side. */
+    iteration?: number;
+    childLabel?: string | null;
+    plannedStart?: string | null;
+    plannedEnd?: string | null;
+    actualStart?: string | null;
+    actualEnd?: string | null;
+    state?: WorkStepState;
+    certainty?: WorkStepCertainty;
+    openedBy?: string | null;
+    closedBy?: string | null;
+    reopenReason?: string | null;
+}
+export interface BatchWorkStepEpisodesInput {
+    callerRole: WorkStepCallerRole;
+    /** 1 to 500. Duplicate keys within one batch are a 422. */
+    episodes: BatchWorkStepEpisodeRow[];
+}
+export interface BatchWorkStepEpisodesResult {
+    created: number;
+    updated: number;
+    unchanged: number;
+    /** A done row is never regressed by a stale replay. */
+    skipped: number;
+}
+export interface ListWorkStepEpisodesOptions {
+    /** ISO-8601; the analytics feed's watermark. */
+    updatedSince?: string;
+    subjectType?: WorkStepSubjectKind;
+    stepCode?: string;
+    /** 1 to 1000. */
+    limit?: number;
+    cursor?: string;
+}
+export interface WorkingCalendarException {
+    id: string;
+    date: string;
+    working: boolean;
+    reason: string;
+}
+export interface WorkingCalendar {
+    id: string;
+    /** master-data Plant id. */
+    productionSourceId: string;
+    sourceLabel: string | null;
+    /** UTC weekday numbers that are working days, 0 = Sunday. Never empty. */
+    workingDays: number[];
+    timeZone: string | null;
+    exceptions?: WorkingCalendarException[];
+}
+export interface UpsertWorkingCalendarInput {
+    sourceLabel?: string | null;
+    workingDays?: number[];
+    timeZone?: string | null;
+}
+export interface PutWorkingCalendarExceptionInput {
+    /** YYYY-MM-DD */
+    date: string;
+    /** Default false (a non-working day); true is a make-up working day. */
+    working?: boolean;
+    reason: string;
+}
 //# sourceMappingURL=types.d.ts.map