@campfire-interactive/master-data-client 5.21.0 → 5.22.0

package/dist/types.d.ts

@@ -48,86 +48,6 @@ export interface Location {
     createdAt: string;
     updatedAt: string;
 }
-/** LEGACY: the old program (master-data table `programs_legacy`), in practice
- *  an OEM's vehicle program scoped to one customer. Unchanged on the wire for
- *  the apps still on it; the tenant's own program is {@link TenantProgram}
- *  (`client.tenantPrograms`). */
-export interface Program {
-    id: string;
-    tenantId: string;
-    customerCompanyId: string;
-    /** @deprecated Use customerCompanyId. Removed in the next major. Mirrors customerCompanyId during the additive-deprecate window. */
-    oemCompanyId: string;
-    name: string;
-    code: string;
-    description: string | null;
-    sopDate: string | null;
-    eopDate: string | null;
-    status: 'active' | 'archived';
-    quality: 'draft' | 'verified';
-    createdBy: string;
-    updatedBy: string;
-    createdAt: string;
-    updatedAt: string;
-    /** The scope dimensions this program belongs to. Null means NOT SET, which is
-     *  legal and is where every record starts — resolve the id through
-     *  `geographicScopes` / `productScopes`, and label the field with the
-     *  tenant's alias from `scopeDimensionSettings`, never "Region". */
-    geographicScopeId: string | null;
-    productScopeId: string | null;
-    customerCompany?: Company;
-    /** @deprecated Use customerCompany. Removed in the next major. Mirrors customerCompany. */
-    oemCompany?: Company;
-}
-export interface CreateProgramInput {
-    customerCompanyId?: string;
-    /** @deprecated Use customerCompanyId. Removed in the next major. Server rejects when both are set to differing values. */
-    oemCompanyId?: string;
-    name: string;
-    code: string;
-    description?: string;
-    sopDate?: string;
-    eopDate?: string;
-    /** Must name an ACTIVE scope in this tenant, or the server 400s naming the
-     *  field. Omit (or send null) to leave it unset. */
-    geographicScopeId?: string | null;
-    productScopeId?: string | null;
-}
-export interface UpdateProgramInput {
-    name?: string;
-    code?: string;
-    description?: string;
-    sopDate?: string | null;
-    eopDate?: string | null;
-    quality?: 'draft' | 'verified';
-    /** Set, change, or clear with null. Must name an ACTIVE scope. */
-    geographicScopeId?: string | null;
-    productScopeId?: string | null;
-}
-export interface ListProgramsOptions {
-    limit?: number;
-    cursor?: string;
-    sort?: string;
-    q?: string;
-    status?: 'active' | 'archived' | 'all';
-    quality?: 'draft' | 'verified';
-    customerCompanyId?: string;
-    /** @deprecated Use customerCompanyId. Removed in the next major. */
-    oemCompanyId?: string;
-    /** Batch-get a specific set of programs by id — returns them regardless of
-     *  status. Comma-joined server-side; cap ~100/call for URL length and chunk
-     *  larger sets. The server bumps the page size to cover the ids. */
-    ids?: string[];
-    include?: ('customerCompany' | 'oemCompany')[];
-    /** Filter to one scope, or pass `'none'` for programs with NO scope set —
-     *  the bucket every tenant starts in, and how you ask "what still needs a
-     *  scope?". */
-    geographicScopeId?: string;
-    productScopeId?: string;
-}
-export interface GetProgramOptions {
-    include?: ('customerCompany' | 'oemCompany')[];
-}
 export interface TenantProgram {
     id: string;
     tenantId: string;
@@ -151,6 +71,10 @@ export interface TenantProgram {
     createdAt: string;
     updatedAt: string;
 }
+/** A quote's program as `include=program` embeds it: the tenant program's own
+ *  fields, without the derived customers or the attribute values, which
+ *  `client.tenantPrograms.get` serves. */
+export type QuoteProgram = Pick<TenantProgram, 'id' | 'tenantId' | 'code' | 'name' | 'description' | 'status' | 'geographicScopeId' | 'productScopeId' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'>;
 export interface ListTenantProgramsOptions {
     limit?: number;
     cursor?: string;
@@ -497,7 +421,8 @@ export interface Quote {
     createdAt: string;
     updatedAt: string;
     customerCompany?: Company;
-    program?: Program;
+    /** The quote's tenant program, present when the read includes `program`. */
+    program?: QuoteProgram | null;
     /** Expanded region — present only when the read includes the relation. */
     region?: Region;
 }
@@ -1352,7 +1277,7 @@ export interface PlantMatchBatchInput {
     limit?: number;
 }
 /** Parallel arrays — `data[i]` is the matches for `queries[i]`. Failed
- *  per-query lookups surface as empty arrays (mirrors Program match batch). */
+ *  per-query lookups surface as empty arrays. */
 export interface PlantMatchBatchResponse {
     data: PlantMatch[][];
     meta: ApiMeta;
@@ -3906,51 +3831,6 @@ export interface MatchBatchResponse {
     data: Record<string, CompanyMatch[]>;
     meta: ApiMeta;
 }
-/** Discriminates the high-confidence (exact (tenantId, customerCompanyId,
- *  code) match) from the fuzzy pg_trgm-on-name match. Callers can auto-resolve
- *  `exact_code` without re-scoring; `trgm_name` typically requires operator
- *  confirmation. */
-export type ProgramMatchType = 'exact_code' | 'trgm_name';
-export interface ProgramMatch {
-    id: string;
-    name: string;
-    code: string;
-    customerCompanyId: string;
-    /** @deprecated Use customerCompanyId. Removed in the next major. Mirrors customerCompanyId. */
-    oemCompanyId?: string;
-    /** 1.0 for exact-code match; pg_trgm similarity in (threshold..1] otherwise. */
-    score: number;
-    matchType: ProgramMatchType;
-}
-export interface ProgramMatchQuery {
-    name: string;
-    customerCompanyId?: string;
-    /** @deprecated Use customerCompanyId. Removed in the next major. Server rejects when both are set to differing values. */
-    oemCompanyId?: string;
-    /** When present, an exact match on (tenantId, customerCompanyId, code) is
-     *  unioned at score=1.0 ahead of fuzzy matches. */
-    code?: string;
-}
-export interface ProgramMatchByNameInput extends ProgramMatchQuery {
-    /** Similarity floor, 0.05..0.95 (clamped server-side). Default 0.3. */
-    threshold?: number;
-    /** Max trgm matches returned, 1..25 (clamped). Default 5. An exact-code
-     *  hit is returned in addition to the trgm matches. */
-    limit?: number;
-}
-export interface ProgramMatchBatchInput {
-    /** Non-empty; max 500 queries per request. */
-    queries: ProgramMatchQuery[];
-    threshold?: number;
-    limit?: number;
-}
-/** Response shape for the batch endpoint — parallel arrays. `data[i]` is
- *  the matches for `queries[i]`. Failed queries surface as empty arrays
- *  (per-query failures don't fail the batch, mirroring Company match). */
-export interface ProgramMatchBatchResponse {
-    data: ProgramMatch[][];
-    meta: ApiMeta;
-}
 export interface ListLocationsOptions {
     type?: LocationType;
 }