@d19n/youfibre-odin-sdk 2.0.343 → 2.0.344

package/README.md

@@ -124,7 +124,7 @@ await workOrder.completeWorkOrder({ ... });
 
 ## Entities
 
-This SDK includes **196** entities across **13** modules.
+This SDK includes **197** entities across **13** modules.
 
 ### CrmModule
 
@@ -238,6 +238,7 @@ This SDK includes **196** entities across **13** modules.
 |--------|-------------|-------|
 | **BillingAdjustment** | BillingAdjustment Entity Definition | DEFAULT |
 | **ChurnRequest** | ChurnRequest Entity Definition | DEFAULT |
+| **Commitment** | Commitment Entity Definition | DEFAULT |
 | **ContractBuyOut** | ContractBuyOut Entity Definition | DEFAULT |
 | **DeactivationApproval** | DeactivationApproval Entity Definition | DEFAULT |
 | **OneTouchSwitch** | OneTouchSwitch Entity Definition | GAINING, LOSING |

package/dist/api-sdk-v2/CommitmentApi.d.ts

@@ -0,0 +1,48 @@
+import { OauthParams } from '@d19n/odin-sdk-generator/dist/odin-sdk-types';
+import { ApiProvider } from '@d19n/odin-sdk-generator/dist/api.provider';
+import { OdinSearchV2, OdinRecordCreateDto, OdinRecordUpdateDto } from '@d19n/odin-types/dist/core';
+import { ApiRecordLinkManager } from '@d19n/odin-sdk-generator/dist/api.record.link.manager';
+import { CommitmentProperties } from '../entities-v2/Commitment';
+/**
+ * @deprecated Use OdinApiClient.
+ *
+ * Migration:
+ * - Old: new CommitmentApi(authParams).get(id)
+ * - New: new odin.commitment.get(id)
+ *
+ * The new OdinApiClient returns typed record wrappers with action methods.
+ */
+export declare class CommitmentApi extends ApiProvider {
+    protected readonly authToken?: string;
+    private readonly moduleName;
+    private readonly entityName;
+    private sourceRecord;
+    private _order?;
+    constructor(authParams?: OauthParams, authToken?: string);
+    get order(): ApiRecordLinkManager;
+    setRecord(sourceRecord: any): void;
+    schema(): Promise<import("@d19n/odin-types/dist/core").OdinSchema>;
+    search(params: Partial<OdinSearchV2>): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinSearchResponse<import("@d19n/odin-types/dist/core").OdinRecord<CommitmentProperties>>>;
+    searchAndPaginate(params: Partial<OdinSearchV2>): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinSearchResponse<import("@d19n/odin-types/dist/core").OdinRecord<CommitmentProperties>>>;
+    reIndex(body: {
+        id: string;
+        schemaId: string;
+    }[]): Promise<any>;
+    get(commitmentId: string): Promise<import("@d19n/odin-types/dist/core").OdinRecord<CommitmentProperties>>;
+    getMany(commitmentIds: string[]): Promise<import("@d19n/odin-types/dist/core").OdinRecord<CommitmentProperties>[]>;
+    upsert(upsertDto: OdinRecordCreateDto): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").IDbRecordCreateUpdateRes>;
+    upsertMany(upsertDtos: OdinRecordCreateDto[]): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").IDbRecordCreateUpdateRes[]>;
+    update(updateDto: OdinRecordUpdateDto): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").IDbRecordCreateUpdateRes>;
+    updateMany(updateDtos: OdinRecordUpdateDto[]): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").IDbRecordCreateUpdateRes[]>;
+    delete(commitmentId: string): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinDeleteResponse[]>;
+    deleteMany(commitmentIds: string[]): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinDeleteResponse[]>;
+    restore(commitmentIds: string[]): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinRestoreResponse[]>;
+    applyAction(dto: any): Promise<any[]>;
+    bulkApplyActions(dtos: any[]): Promise<any[]>;
+    getVersions(): Promise<{
+        [key: string]: Record<string, any>;
+    }>;
+    getRevisionTimeline(): Promise<{
+        [key: string]: Record<string, any>[];
+    }>;
+}

package/dist/api-sdk-v2/CommitmentApi.js

@@ -0,0 +1,155 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommitmentApi = void 0;
+const api_provider_1 = require("@d19n/odin-sdk-generator/dist/api.provider");
+const api_record_link_manager_1 = require("@d19n/odin-sdk-generator/dist/api.record.link.manager");
+/**
+ * @deprecated Use OdinApiClient.
+ *
+ * Migration:
+ * - Old: new CommitmentApi(authParams).get(id)
+ * - New: new odin.commitment.get(id)
+ *
+ * The new OdinApiClient returns typed record wrappers with action methods.
+ */
+class CommitmentApi extends api_provider_1.ApiProvider {
+    constructor(authParams, authToken) {
+        super(authParams, authToken);
+        this.authToken = authToken;
+        this.moduleName = 'OrderModule';
+        this.entityName = 'Commitment';
+        // Link managers are lazy-loaded on first access
+    }
+    // ============================================
+    // LAZY-LOADED LINK MANAGERS (Public Getters)
+    // ============================================
+    // Usage remains identical: api.address.list(recordId)
+    get order() {
+        if (!this._order) {
+            this._order = new api_record_link_manager_1.ApiRecordLinkManager(this.authParams, 'OrderModule:Commitment', 'OrderModule:Order', 'Commitment__Order');
+        }
+        return this._order;
+    }
+    // ============================================
+    // STANDARD METHODS (Unchanged API)
+    // ============================================
+    setRecord(sourceRecord) {
+        this.sourceRecord = sourceRecord;
+    }
+    schema() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.getSchema(this.moduleName, this.entityName);
+        });
+    }
+    // Use this function when you want to search and handle all pagination on your own
+    search(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._searchRecords(this.moduleName, this.entityName, params);
+        });
+    }
+    // Use this function when you want paginating through the results to be handled
+    searchAndPaginate(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._searchAllRecordsAndPaginate(this.moduleName, this.entityName, params);
+        });
+    }
+    // Use this function to re-index records in elastic search
+    reIndex(body) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._reIndexRecords(body);
+        });
+    }
+    // Use this function when you want to return a single record
+    get(commitmentId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this._getByPrimaryKey(this.moduleName, this.entityName, commitmentId);
+            if (res)
+                this.setRecord(res);
+            return res;
+        });
+    }
+    // Use this function when you want to return many records by primaryKeys
+    getMany(commitmentIds) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._getManyByPrimaryKey(this.moduleName, this.entityName, commitmentIds);
+        });
+    }
+    // Use this function when you want to upsert one record
+    upsert(upsertDto) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this._upsert(this.moduleName, this.entityName, [upsertDto]);
+            return res[0];
+        });
+    }
+    // Use this function when you want to upsert many records
+    upsertMany(upsertDtos) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._upsert(this.moduleName, this.entityName, upsertDtos);
+        });
+    }
+    // Use this function when you want to update one record
+    update(updateDto) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this._update(this.moduleName, this.entityName, [updateDto]);
+            return res[0];
+        });
+    }
+    // Use this function when you want to update many records
+    updateMany(updateDtos) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._update(this.moduleName, this.entityName, updateDtos);
+        });
+    }
+    // Use this function when you want to delete one record
+    delete(commitmentId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._delete(this.moduleName, this.entityName, [commitmentId]);
+        });
+    }
+    // Use this function when you want to delete many records
+    deleteMany(commitmentIds) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._delete(this.moduleName, this.entityName, commitmentIds);
+        });
+    }
+    // Use this function when you want to restore one or many records
+    restore(commitmentIds) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._restore(this.moduleName, this.entityName, commitmentIds);
+        });
+    }
+    // Use this function when you want to apply a single action
+    applyAction(dto) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._applyAction(this.moduleName, this.entityName, dto);
+        });
+    }
+    // Use this function when you want to bulk apply actions 
+    bulkApplyActions(dtos) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._bulkApplyActions(this.moduleName, this.entityName, dtos);
+        });
+    }
+    // Use this function when you want to return the versions for a single record
+    getVersions() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._getVersions(this.moduleName, this.entityName, this.sourceRecord.id);
+        });
+    }
+    // Use this function when you want to return the change history for a single record
+    getRevisionTimeline() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._getRevisionTimeline(this.moduleName, this.entityName, this.sourceRecord.id);
+        });
+    }
+}
+exports.CommitmentApi = CommitmentApi;

package/dist/api-sdk-v2/OrderApi.d.ts

@@ -59,6 +59,7 @@ export declare class OrderApi extends ApiProvider {
     private _dataissue?;
     private _workorder?;
     private _email?;
+    private _commitment?;
     constructor(authParams?: OauthParams, authToken?: string);
     get note(): ApiRecordLinkManager;
     get lead(): ApiRecordLinkManager;
@@ -102,6 +103,7 @@ export declare class OrderApi extends ApiProvider {
     get dataissue(): ApiRecordLinkManager;
     get workorder(): ApiRecordLinkManager;
     get email(): ApiRecordLinkManager;
+    get commitment(): ApiRecordLinkManager;
     setRecord(sourceRecord: any): void;
     schema(): Promise<import("@d19n/odin-types/dist/core").OdinSchema>;
     search(params: Partial<OdinSearchV2>): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinSearchResponse<import("@d19n/odin-types/dist/core").OdinRecord<OrderProperties>>>;

package/dist/api-sdk-v2/OrderApi.js

@@ -285,6 +285,12 @@ class OrderApi extends api_provider_1.ApiProvider {
         }
         return this._email;
     }
+    get commitment() {
+        if (!this._commitment) {
+            this._commitment = new api_record_link_manager_1.ApiRecordLinkManager(this.authParams, 'OrderModule:Order', 'OrderModule:Commitment', 'Commitment__Order');
+        }
+        return this._commitment;
+    }
     // ============================================
     // STANDARD METHODS (Unchanged API)
     // ============================================

package/dist/db-sdk-v2/CommitmentDb.d.ts

@@ -0,0 +1,120 @@
+import { DbProvider, DbProviderOptions, DbGetQueryOptions } from '@d19n/odin-sdk-generator/dist/db.provider';
+import { OdinSearchV2, OdinRecordCreateDto, OdinRecordUpdateDto } from '@d19n/odin-types/dist/core';
+import { DbRecordLinkManager } from '@d19n/odin-sdk-generator/dist/db.record.link.manager';
+import { CommitmentProperties } from '../entities-v2/Commitment';
+/**
+ * @deprecated Use OdinDbClient.
+ *
+ * Migration:
+ * - Old: new CommitmentApi(authParams).get(id)
+ * - New: new odin.commitment.get(id)
+ *
+ * The new OdinDbClient returns typed record wrappers with action methods.
+ *
+ * Supports separate query options and provider options:
+ * - Constructor level: new CommitmentDb(principal, dbService, { omitPermissionsCheck: true })
+ * - Method level: await db.getByPrimaryKey(id, { entities: [] }, { omitPermissionsCheck: true })
+ */
+export declare class CommitmentDb extends DbProvider {
+    protected readonly principal: any;
+    protected readonly dbService: any;
+    private readonly moduleName;
+    private readonly entityName;
+    private sourceRecord;
+    private _order?;
+    constructor(principal: any, dbService: any, defaultOptions?: DbProviderOptions);
+    get order(): DbRecordLinkManager;
+    setRecord(sourceRecord: any): void;
+    /**
+     * Search records with manual pagination control
+     * @param params - Search parameters
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    searchRecords(params: Partial<OdinSearchV2>, providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core/interfaces/v2.db.interfaces").OdinSearchResponse<import("@d19n/odin-types/dist/core").OdinRecord<CommitmentProperties>>>;
+    /**
+     * Search all records with automatic pagination
+     * @param params - Search parameters
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    searchAllRecordsAndPaginate(params: Partial<OdinSearchV2>, providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core/interfaces/v2.db.interfaces").OdinSearchResponse<import("@d19n/odin-types/dist/core").OdinRecord<CommitmentProperties>>>;
+    /**
+     * Get a single record by primary key
+     * @param commitmentId - Record ID
+     * @param queryOptions - Query options (WHAT: entities to include)
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     *
+     * @example
+     * // Simple get
+     * const record = await db.getByPrimaryKey(id);
+     *
+     * // With related entities
+     * const record = await db.getByPrimaryKey(id, { entities: ['InvoiceItem', 'Transaction'] });
+     *
+     * // With permissions bypass
+     * const record = await db.getByPrimaryKey(id, {}, { omitPermissionsCheck: true });
+     *
+     * // Both options
+     * const record = await db.getByPrimaryKey(id, { entities: ['Invoice'] }, { omitPermissionsCheck: true });
+     */
+    getByPrimaryKey(commitmentId: string, queryOptions?: DbGetQueryOptions, providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core").OdinRecord<CommitmentProperties>>;
+    /**
+     * Get multiple records by primary keys
+     * @param commitmentIds - Array of record IDs
+     * @param queryOptions - Query options (WHAT: entities to include)
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    getManyByPrimaryKey(commitmentIds: string[], queryOptions?: DbGetQueryOptions, providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core").OdinRecord<CommitmentProperties>[]>;
+    /**
+     * Upsert a single record
+     * @param upsertDto - Record to upsert
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    upsert(upsertDto: OdinRecordCreateDto, providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core").IDbRecordCreateUpdateRes>;
+    /**
+     * Upsert multiple records
+     * @param upsertDtos - Records to upsert
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    upsertMany(upsertDtos: OdinRecordCreateDto[], providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core").IDbRecordCreateUpdateRes[]>;
+    /**
+     * Update a single record
+     * @param updateDto - Record to update
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    update(updateDto: OdinRecordUpdateDto, providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core").IDbRecordCreateUpdateRes>;
+    /**
+     * Update multiple records
+     * @param updateDtos - Records to update
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    updateMany(updateDtos: OdinRecordUpdateDto[], providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core").IDbRecordCreateUpdateRes[]>;
+    /**
+     * Delete one or many records
+     * @param commitmentIds - Record IDs to delete
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    delete(commitmentIds: string[], providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-sdk-generator").DbRecordDeleted[]>;
+    /**
+     * Restore one or many deleted records
+     * @param commitmentIds - Record IDs to restore
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    restore(commitmentIds: string[], providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-sdk-generator").DbRecordRestored[]>;
+    /**
+     * Apply an action to a record
+     * @param actionName - The action key
+     * @param dto - The action DTO
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    applyAction(actionName: string, dto: any, providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core").IDbRecordCreateUpdateRes[]>;
+    /**
+     * Get version history for the current source record
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    getVersions(providerOptions?: DbProviderOptions): Promise<any>;
+    /**
+     * Get revision timeline for the current source record
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    getRevisionTimeline(providerOptions?: DbProviderOptions): Promise<any>;
+}

package/dist/db-sdk-v2/CommitmentDb.js

@@ -0,0 +1,204 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommitmentDb = void 0;
+const db_provider_1 = require("@d19n/odin-sdk-generator/dist/db.provider");
+const db_record_link_manager_1 = require("@d19n/odin-sdk-generator/dist/db.record.link.manager");
+/**
+ * @deprecated Use OdinDbClient.
+ *
+ * Migration:
+ * - Old: new CommitmentApi(authParams).get(id)
+ * - New: new odin.commitment.get(id)
+ *
+ * The new OdinDbClient returns typed record wrappers with action methods.
+ *
+ * Supports separate query options and provider options:
+ * - Constructor level: new CommitmentDb(principal, dbService, { omitPermissionsCheck: true })
+ * - Method level: await db.getByPrimaryKey(id, { entities: [] }, { omitPermissionsCheck: true })
+ */
+class CommitmentDb extends db_provider_1.DbProvider {
+    constructor(principal, dbService, defaultOptions) {
+        super(principal, dbService, defaultOptions);
+        this.moduleName = 'OrderModule';
+        this.entityName = 'Commitment';
+        this.principal = principal;
+        this.dbService = dbService;
+        // Link managers are lazy-loaded on first access
+    }
+    // ============================================
+    // LAZY-LOADED LINK MANAGERS (Public Getters)
+    // ============================================
+    // Usage remains identical: db.address.list(recordId)
+    get order() {
+        if (!this._order) {
+            this._order = new db_record_link_manager_1.DbRecordLinkManager(this.principal, this.dbService, 'OrderModule:Commitment', 'OrderModule:Order', 'Commitment__Order');
+        }
+        return this._order;
+    }
+    // ============================================
+    // STANDARD METHODS
+    // ============================================
+    // Methods support separate query options and provider options for clean API
+    setRecord(sourceRecord) {
+        this.sourceRecord = sourceRecord;
+    }
+    /**
+     * Search records with manual pagination control
+     * @param params - Search parameters
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    searchRecords(params, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._searchRecords(this.moduleName, this.entityName, params, providerOptions);
+        });
+    }
+    /**
+     * Search all records with automatic pagination
+     * @param params - Search parameters
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    searchAllRecordsAndPaginate(params, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._searchAllRecordsAndPaginate(this.moduleName, this.entityName, params, 0, providerOptions);
+        });
+    }
+    /**
+     * Get a single record by primary key
+     * @param commitmentId - Record ID
+     * @param queryOptions - Query options (WHAT: entities to include)
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     *
+     * @example
+     * // Simple get
+     * const record = await db.getByPrimaryKey(id);
+     *
+     * // With related entities
+     * const record = await db.getByPrimaryKey(id, { entities: ['InvoiceItem', 'Transaction'] });
+     *
+     * // With permissions bypass
+     * const record = await db.getByPrimaryKey(id, {}, { omitPermissionsCheck: true });
+     *
+     * // Both options
+     * const record = await db.getByPrimaryKey(id, { entities: ['Invoice'] }, { omitPermissionsCheck: true });
+     */
+    getByPrimaryKey(commitmentId, queryOptions, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this._getByPrimaryKey(this.moduleName, this.entityName, commitmentId, queryOptions, providerOptions);
+            if (res)
+                this.setRecord(res);
+            return res;
+        });
+    }
+    /**
+     * Get multiple records by primary keys
+     * @param commitmentIds - Array of record IDs
+     * @param queryOptions - Query options (WHAT: entities to include)
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    getManyByPrimaryKey(commitmentIds, queryOptions, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._getManyByPrimaryKey(this.moduleName, this.entityName, commitmentIds, queryOptions, providerOptions);
+        });
+    }
+    /**
+     * Upsert a single record
+     * @param upsertDto - Record to upsert
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    upsert(upsertDto, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this._upsert(this.moduleName, this.entityName, [upsertDto], providerOptions);
+            return res[0];
+        });
+    }
+    /**
+     * Upsert multiple records
+     * @param upsertDtos - Records to upsert
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    upsertMany(upsertDtos, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._upsert(this.moduleName, this.entityName, upsertDtos, providerOptions);
+        });
+    }
+    /**
+     * Update a single record
+     * @param updateDto - Record to update
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    update(updateDto, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this._update(this.moduleName, this.entityName, [updateDto], providerOptions);
+            return res[0];
+        });
+    }
+    /**
+     * Update multiple records
+     * @param updateDtos - Records to update
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    updateMany(updateDtos, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._update(this.moduleName, this.entityName, updateDtos, providerOptions);
+        });
+    }
+    /**
+     * Delete one or many records
+     * @param commitmentIds - Record IDs to delete
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    delete(commitmentIds, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._delete(this.moduleName, this.entityName, commitmentIds, providerOptions);
+        });
+    }
+    /**
+     * Restore one or many deleted records
+     * @param commitmentIds - Record IDs to restore
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    restore(commitmentIds, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._restore(this.moduleName, this.entityName, commitmentIds, providerOptions);
+        });
+    }
+    /**
+     * Apply an action to a record
+     * @param actionName - The action key
+     * @param dto - The action DTO
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    applyAction(actionName, dto, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._applyAction(this.moduleName, this.entityName, dto, providerOptions);
+        });
+    }
+    /**
+     * Get version history for the current source record
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    getVersions(providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._getVersions(this.moduleName, this.entityName, this.sourceRecord.id, providerOptions);
+        });
+    }
+    /**
+     * Get revision timeline for the current source record
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    getRevisionTimeline(providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._getRevisionTimeline(this.moduleName, this.entityName, this.sourceRecord.id, providerOptions);
+        });
+    }
+}
+exports.CommitmentDb = CommitmentDb;

package/dist/db-sdk-v2/OrderDb.d.ts

@@ -63,6 +63,7 @@ export declare class OrderDb extends DbProvider {
     private _dataissue?;
     private _workorder?;
     private _email?;
+    private _commitment?;
     constructor(principal: any, dbService: any, defaultOptions?: DbProviderOptions);
     get note(): DbRecordLinkManager;
     get lead(): DbRecordLinkManager;
@@ -106,6 +107,7 @@ export declare class OrderDb extends DbProvider {
     get dataissue(): DbRecordLinkManager;
     get workorder(): DbRecordLinkManager;
     get email(): DbRecordLinkManager;
+    get commitment(): DbRecordLinkManager;
     setRecord(sourceRecord: any): void;
     /**
      * Search records with manual pagination control

package/dist/db-sdk-v2/OrderDb.js

@@ -290,6 +290,12 @@ class OrderDb extends db_provider_1.DbProvider {
         }
         return this._email;
     }
+    get commitment() {
+        if (!this._commitment) {
+            this._commitment = new db_record_link_manager_1.DbRecordLinkManager(this.principal, this.dbService, 'OrderModule:Order', 'OrderModule:Commitment', 'Commitment__Order');
+        }
+        return this._commitment;
+    }
     // ============================================
     // STANDARD METHODS
     // ============================================

package/dist/entities-v2/Commitment.d.ts

@@ -0,0 +1,154 @@
+/**
+ * Commitment Entity Definition
+ *
+ * One thing an order still owes, and when it falls due: the type, the deadline, what discharged it, and where it stands (Not Yet Due / Pending / Breached / Discharged / Not Required). An order is finished when it has no open commitments.
+ *
+ * @module OrderModule
+ * @entity Commitment
+ * @schemaId 6961f6fc-9d4b-4913-9677-065e0b67a1ce
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ * Generated from Odin schema definition
+ */
+import { OdinRecord, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/core';
+import { OrderProperties } from './Order';
+/**
+ * Available types for Commitment records
+ */
+export declare enum CommitmentEntityTypes {
+    /** This is the default record type */
+    DEFAULT = "DEFAULT"
+}
+/**
+ * Pipeline stage names for DEFAULT Commitment
+ * Pipeline: Commitment
+ * What an order owes, from not-yet-owed through to settled.
+ */
+export declare enum DefaultCommitmentStageNames {
+    /** The precondition has not happened, so there is no clock — not a clock still running. A Supply order before its CommittedDate sits here. (default) */
+    NotYetDue = "Not Yet Due",
+    /** Owed, and the clock is running — ExpectedBy is in the future. */
+    Pending = "Pending",
+    /** Owed, ExpectedBy has passed, nothing discharged it. Still open work — it ages. Can still be discharged late, which is how lateness gets measured. */
+    Breached = "Breached",
+    /** The thing that was owed happened. CompletedBy names the record that did it — a COMPLETED OrderKci, a switch at TRIGGER_CONFIRMED. */
+    Complete = "Complete",
+    /** Resolved as never owed, with the reason — an order with no switch to trigger. A distinct terminal state from Discharged: nothing happened, rather than the thing happening. */
+    NotRequired = "Not Required"
+}
+/**
+ * Pipeline stage keys for DEFAULT Commitment
+ * Use these keys when transitioning between stages
+ */
+export declare enum DefaultCommitmentStageKeys {
+    /** The precondition has not happened, so there is no clock — not a clock still running. A Supply order before its CommittedDate sits here. */
+    CommitmentStageNotYetDue = "CommitmentStageNotYetDue",
+    /** Owed, and the clock is running — ExpectedBy is in the future. */
+    CommitmentStagePending = "CommitmentStagePending",
+    /** Owed, ExpectedBy has passed, nothing discharged it. Still open work — it ages. Can still be discharged late, which is how lateness gets measured. */
+    CommitmentStageBreached = "CommitmentStageBreached",
+    /** The thing that was owed happened. CompletedBy names the record that did it — a COMPLETED OrderKci, a switch at TRIGGER_CONFIRMED. */
+    CommitmentStageComplete = "CommitmentStageComplete",
+    /** Resolved as never owed, with the reason — an order with no switch to trigger. A distinct terminal state from Discharged: nothing happened, rather than the thing happening. */
+    CommitmentStageNotRequired = "CommitmentStageNotRequired"
+}
+/**
+ * Property keys for Commitment
+ * Use these constants instead of string literals for type safety
+ */
+export declare enum CommitmentPropertyKeys {
+    /** orderId::type — the natural key. UNIQUE, and what upsertOnCreate hashes, so the reconciler cannot create a second commitment for something already owed. */
+    Fingerprint = "Fingerprint",
+    /** The invariant's stableId, e.g. yf/ORDER/OrderStageSupply/supply-completed-kci-must-arrive-by-committed-date. Generated into COMMITMENT-CATALOG.json from the BP, so this is an address the rest of the estate already uses rather than a new vocabulary. */
+    Type = "Type",
+    /** When it falls due. Empty only while NOT_YET_DUE — a BREACHED commitment without one would be past a deadline that does not exist, which is a fault in whatever created it. */
+    ExpectedBy = "ExpectedBy",
+    /** The record that settled it, as entity and id — e.g. OrderModule:OrderKci/<id>. Text rather than a typed association per dischargeable entity, so a new commitment type needs no schema change. */
+    CompletedBy = "CompletedBy",
+    /** When it was settled. Together with ExpectedBy this says whether it was late. */
+    CompletedAt = "CompletedAt",
+    /** Why it was never owed, when it resolves that way — e.g. NO_CURRENT_PROVIDER for an order with no switch to trigger. Without this, "not required" is indistinguishable from "nobody looked". */
+    NotRequiredReason = "NotRequiredReason"
+}
+/**
+ * Properties for Commitment records
+ *
+ * @see OrderModule:Commitment
+ */
+export interface CommitmentProperties {
+    /** orderId::type — the natural key. UNIQUE, and what upsertOnCreate hashes, so the reconciler cannot create a second commitment for something already owed.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Fingerprint: string;
+    /** The invariant's stableId, e.g. yf/ORDER/OrderStageSupply/supply-completed-kci-must-arrive-by-committed-date. Generated into COMMITMENT-CATALOG.json from the BP, so this is an address the rest of the estate already uses rather than a new vocabulary.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Type: string;
+    /** When it falls due. Empty only while NOT_YET_DUE — a BREACHED commitment without one would be past a deadline that does not exist, which is a fault in whatever created it.
+     *
+     * @type {DATE_TIME}
+     * @default
+     */
+    ExpectedBy: string;
+    /** The record that settled it, as entity and id — e.g. OrderModule:OrderKci/<id>. Text rather than a typed association per dischargeable entity, so a new commitment type needs no schema change.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    CompletedBy: string;
+    /** When it was settled. Together with ExpectedBy this says whether it was late.
+     *
+     * @type {DATE_TIME}
+     * @default
+     */
+    CompletedAt: string;
+    /** Why it was never owed, when it resolves that way — e.g. NO_CURRENT_PROVIDER for an order with no switch to trigger. Without this, "not required" is indistinguishable from "nobody looked".
+     *
+     * @type {TEXT}
+     * @default
+     */
+    NotRequiredReason: string;
+}
+/**
+ * Commitment entity from OrderModule
+ *
+ * One thing an order still owes, and when it falls due: the type, the deadline, what discharged it, and where it stands (Not Yet Due / Pending / Breached / Discharged / Not Required). An order is finished when it has no open commitments.
+ *
+ * @module OrderModule
+ * @entity Commitment
+ * @schemaId 6961f6fc-9d4b-4913-9677-065e0b67a1ce
+ * @recordPrefix CMT
+ * @capabilities searchable, updateable, undeletable, triggerable
+ */
+export declare class Commitment extends OdinRecord<CommitmentProperties> {
+    entity: 'OrderModule:Commitment';
+    type: CommitmentEntityTypes;
+    schemaId: '6961f6fc-9d4b-4913-9677-065e0b67a1ce';
+    properties: CommitmentProperties;
+    /** Linked Order records (Commitment__Order) */
+    Order: OdinLink<LinkedOdinRecord<OrderProperties>>;
+}
+/**
+ * RabbitMQ routing keys for Commitment events
+ */
+export declare const ROUTING_KEY_COMMITMENT_CREATED = "OrderModule.Commitment.SubDbRecordCreated";
+export declare const ROUTING_KEY_COMMITMENT_UPDATED = "OrderModule.Commitment.SubDbRecordUpdated";
+export declare const ROUTING_KEY_COMMITMENT_DELETED = "OrderModule.Commitment.SubDbRecordDeleted";
+/**
+ * Type-specific routing keys for Commitment events
+ * Subscribe to these for events on specific entity types only
+ */
+/** This is the default record type created */
+export declare const ROUTING_KEY_COMMITMENT_DEFAULT_CREATED = "OrderModule.Commitment.DEFAULT.SubDbRecordCreated";
+/** This is the default record type updated */
+export declare const ROUTING_KEY_COMMITMENT_DEFAULT_UPDATED = "OrderModule.Commitment.DEFAULT.SubDbRecordUpdated";
+/** This is the default record type deleted */
+export declare const ROUTING_KEY_COMMITMENT_DEFAULT_DELETED = "OrderModule.Commitment.DEFAULT.SubDbRecordDeleted";
+/** Event: Commitment__Order link created */
+export declare const ROUTING_KEY_LINK_COMMITMENT_ORDER_CREATED = "OrderModule.Commitment.Order.SubDbRecordAssociationCreated";
+/** Event: Commitment__Order link deleted */
+export declare const ROUTING_KEY_LINK_COMMITMENT_ORDER_DELETED = "OrderModule.Commitment.Order.SubDbRecordAssociationDeleted";

package/dist/entities-v2/Commitment.js

@@ -0,0 +1,115 @@
+"use strict";
+/**
+ * Commitment Entity Definition
+ *
+ * One thing an order still owes, and when it falls due: the type, the deadline, what discharged it, and where it stands (Not Yet Due / Pending / Breached / Discharged / Not Required). An order is finished when it has no open commitments.
+ *
+ * @module OrderModule
+ * @entity Commitment
+ * @schemaId 6961f6fc-9d4b-4913-9677-065e0b67a1ce
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ * Generated from Odin schema definition
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ROUTING_KEY_LINK_COMMITMENT_ORDER_DELETED = exports.ROUTING_KEY_LINK_COMMITMENT_ORDER_CREATED = exports.ROUTING_KEY_COMMITMENT_DEFAULT_DELETED = exports.ROUTING_KEY_COMMITMENT_DEFAULT_UPDATED = exports.ROUTING_KEY_COMMITMENT_DEFAULT_CREATED = exports.ROUTING_KEY_COMMITMENT_DELETED = exports.ROUTING_KEY_COMMITMENT_UPDATED = exports.ROUTING_KEY_COMMITMENT_CREATED = exports.Commitment = exports.CommitmentPropertyKeys = exports.DefaultCommitmentStageKeys = exports.DefaultCommitmentStageNames = exports.CommitmentEntityTypes = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * Available types for Commitment records
+ */
+var CommitmentEntityTypes;
+(function (CommitmentEntityTypes) {
+    /** This is the default record type */
+    CommitmentEntityTypes["DEFAULT"] = "DEFAULT";
+})(CommitmentEntityTypes = exports.CommitmentEntityTypes || (exports.CommitmentEntityTypes = {}));
+/**
+ * Pipeline stage names for DEFAULT Commitment
+ * Pipeline: Commitment
+ * What an order owes, from not-yet-owed through to settled.
+ */
+var DefaultCommitmentStageNames;
+(function (DefaultCommitmentStageNames) {
+    /** The precondition has not happened, so there is no clock — not a clock still running. A Supply order before its CommittedDate sits here. (default) */
+    DefaultCommitmentStageNames["NotYetDue"] = "Not Yet Due";
+    /** Owed, and the clock is running — ExpectedBy is in the future. */
+    DefaultCommitmentStageNames["Pending"] = "Pending";
+    /** Owed, ExpectedBy has passed, nothing discharged it. Still open work — it ages. Can still be discharged late, which is how lateness gets measured. */
+    DefaultCommitmentStageNames["Breached"] = "Breached";
+    /** The thing that was owed happened. CompletedBy names the record that did it — a COMPLETED OrderKci, a switch at TRIGGER_CONFIRMED. */
+    DefaultCommitmentStageNames["Complete"] = "Complete";
+    /** Resolved as never owed, with the reason — an order with no switch to trigger. A distinct terminal state from Discharged: nothing happened, rather than the thing happening. */
+    DefaultCommitmentStageNames["NotRequired"] = "Not Required";
+})(DefaultCommitmentStageNames = exports.DefaultCommitmentStageNames || (exports.DefaultCommitmentStageNames = {}));
+/**
+ * Pipeline stage keys for DEFAULT Commitment
+ * Use these keys when transitioning between stages
+ */
+var DefaultCommitmentStageKeys;
+(function (DefaultCommitmentStageKeys) {
+    /** The precondition has not happened, so there is no clock — not a clock still running. A Supply order before its CommittedDate sits here. */
+    DefaultCommitmentStageKeys["CommitmentStageNotYetDue"] = "CommitmentStageNotYetDue";
+    /** Owed, and the clock is running — ExpectedBy is in the future. */
+    DefaultCommitmentStageKeys["CommitmentStagePending"] = "CommitmentStagePending";
+    /** Owed, ExpectedBy has passed, nothing discharged it. Still open work — it ages. Can still be discharged late, which is how lateness gets measured. */
+    DefaultCommitmentStageKeys["CommitmentStageBreached"] = "CommitmentStageBreached";
+    /** The thing that was owed happened. CompletedBy names the record that did it — a COMPLETED OrderKci, a switch at TRIGGER_CONFIRMED. */
+    DefaultCommitmentStageKeys["CommitmentStageComplete"] = "CommitmentStageComplete";
+    /** Resolved as never owed, with the reason — an order with no switch to trigger. A distinct terminal state from Discharged: nothing happened, rather than the thing happening. */
+    DefaultCommitmentStageKeys["CommitmentStageNotRequired"] = "CommitmentStageNotRequired";
+})(DefaultCommitmentStageKeys = exports.DefaultCommitmentStageKeys || (exports.DefaultCommitmentStageKeys = {}));
+/**
+ * Property keys for Commitment
+ * Use these constants instead of string literals for type safety
+ */
+var CommitmentPropertyKeys;
+(function (CommitmentPropertyKeys) {
+    /** orderId::type — the natural key. UNIQUE, and what upsertOnCreate hashes, so the reconciler cannot create a second commitment for something already owed. */
+    CommitmentPropertyKeys["Fingerprint"] = "Fingerprint";
+    /** The invariant's stableId, e.g. yf/ORDER/OrderStageSupply/supply-completed-kci-must-arrive-by-committed-date. Generated into COMMITMENT-CATALOG.json from the BP, so this is an address the rest of the estate already uses rather than a new vocabulary. */
+    CommitmentPropertyKeys["Type"] = "Type";
+    /** When it falls due. Empty only while NOT_YET_DUE — a BREACHED commitment without one would be past a deadline that does not exist, which is a fault in whatever created it. */
+    CommitmentPropertyKeys["ExpectedBy"] = "ExpectedBy";
+    /** The record that settled it, as entity and id — e.g. OrderModule:OrderKci/<id>. Text rather than a typed association per dischargeable entity, so a new commitment type needs no schema change. */
+    CommitmentPropertyKeys["CompletedBy"] = "CompletedBy";
+    /** When it was settled. Together with ExpectedBy this says whether it was late. */
+    CommitmentPropertyKeys["CompletedAt"] = "CompletedAt";
+    /** Why it was never owed, when it resolves that way — e.g. NO_CURRENT_PROVIDER for an order with no switch to trigger. Without this, "not required" is indistinguishable from "nobody looked". */
+    CommitmentPropertyKeys["NotRequiredReason"] = "NotRequiredReason";
+})(CommitmentPropertyKeys = exports.CommitmentPropertyKeys || (exports.CommitmentPropertyKeys = {}));
+/**
+ * Commitment entity from OrderModule
+ *
+ * One thing an order still owes, and when it falls due: the type, the deadline, what discharged it, and where it stands (Not Yet Due / Pending / Breached / Discharged / Not Required). An order is finished when it has no open commitments.
+ *
+ * @module OrderModule
+ * @entity Commitment
+ * @schemaId 6961f6fc-9d4b-4913-9677-065e0b67a1ce
+ * @recordPrefix CMT
+ * @capabilities searchable, updateable, undeletable, triggerable
+ */
+class Commitment extends core_1.OdinRecord {
+}
+exports.Commitment = Commitment;
+// ============================================
+// RABBITMQ EVENT ROUTING KEYS
+// ============================================
+/**
+ * RabbitMQ routing keys for Commitment events
+ */
+exports.ROUTING_KEY_COMMITMENT_CREATED = 'OrderModule.Commitment.SubDbRecordCreated';
+exports.ROUTING_KEY_COMMITMENT_UPDATED = 'OrderModule.Commitment.SubDbRecordUpdated';
+exports.ROUTING_KEY_COMMITMENT_DELETED = 'OrderModule.Commitment.SubDbRecordDeleted';
+/**
+ * Type-specific routing keys for Commitment events
+ * Subscribe to these for events on specific entity types only
+ */
+/** This is the default record type created */
+exports.ROUTING_KEY_COMMITMENT_DEFAULT_CREATED = 'OrderModule.Commitment.DEFAULT.SubDbRecordCreated';
+/** This is the default record type updated */
+exports.ROUTING_KEY_COMMITMENT_DEFAULT_UPDATED = 'OrderModule.Commitment.DEFAULT.SubDbRecordUpdated';
+/** This is the default record type deleted */
+exports.ROUTING_KEY_COMMITMENT_DEFAULT_DELETED = 'OrderModule.Commitment.DEFAULT.SubDbRecordDeleted';
+/** Event: Commitment__Order link created */
+exports.ROUTING_KEY_LINK_COMMITMENT_ORDER_CREATED = 'OrderModule.Commitment.Order.SubDbRecordAssociationCreated';
+/** Event: Commitment__Order link deleted */
+exports.ROUTING_KEY_LINK_COMMITMENT_ORDER_DELETED = 'OrderModule.Commitment.Order.SubDbRecordAssociationDeleted';

package/dist/entities-v2/Order.d.ts

@@ -51,6 +51,7 @@ import { RecontractProperties } from './Recontract';
 import { DataIssueProperties } from './DataIssue';
 import { WorkOrderProperties } from './WorkOrder';
 import { EmailProperties } from './Email';
+import { CommitmentProperties } from './Commitment';
 /**
  * Available types for Order records
  */
@@ -377,6 +378,19 @@ export declare enum OrderBatteryBackupAnswersSource {
     CUSTOMER_APP = "CUSTOMER_APP",
     CUSTOMER_PORTAL = "CUSTOMER_PORTAL"
 }
+/**
+ * Valid values for Order.FulfillmentState
+ *
+ * Derived from the commitment set: OPEN while any commitment is Pending or Breached, SETTLED when none is. Written only by the commitment lifecycle.
+ *
+ * @remarks Available options:
+ * - `OPEN` - Open
+ * - `SETTLED` - Settled
+ */
+export declare enum OrderFulfillmentState {
+    OPEN = "OPEN",
+    SETTLED = "SETTLED"
+}
 /**
  * Property keys for Order
  * Use these constants instead of string literals for type safety
@@ -593,7 +607,13 @@ export declare enum OrderPropertyKeys {
     /** The day this order was deactivated. Cleared when the order goes back to Active, and kept when it goes on to Cancelled. Empty means the order is not deactivated. Not to be confused with DeactivateOnDate, which is a scheduled instruction and is cleared once it is acted on. */
     DeactivationDate = "DeactivationDate",
     /** Used when restarting an existing service, allows the customer to specify what date is used for the RequestedCompletionDate on the supplier-side START order. Used for when a customer is technically able to start receiving service. */
-    RequestedActivationDate = "RequestedActivationDate"
+    RequestedActivationDate = "RequestedActivationDate",
+    /** Derived from the commitment set: OPEN while any commitment is Pending or Breached, SETTLED when none is. Written only by the commitment lifecycle. */
+    FulfillmentState = "FulfillmentState",
+    /** How many commitments are Pending or Breached. Written only by the lifecycle. */
+    OpenCommitmentCount = "OpenCommitmentCount",
+    /** The next commitment to fall due. What a "what is about to breach" query sorts on, without walking every commitment. Written only by the lifecycle. */
+    EarliestDueAt = "EarliestDueAt"
 }
 /**
  * Properties for Order records
@@ -1257,6 +1277,25 @@ export interface OrderProperties {
      * @type {DATE}
      */
     RequestedActivationDate: string;
+    /** Derived from the commitment set: OPEN while any commitment is Pending or Breached, SETTLED when none is. Written only by the commitment lifecycle.
+     *
+     * @type {ENUM}
+     * @default
+     * @enum {OrderFulfillmentState}
+     */
+    FulfillmentState: OrderFulfillmentState;
+    /** How many commitments are Pending or Breached. Written only by the lifecycle.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    OpenCommitmentCount: number;
+    /** The next commitment to fall due. What a "what is about to breach" query sorts on, without walking every commitment. Written only by the lifecycle.
+     *
+     * @type {DATE_TIME}
+     * @default
+     */
+    EarliestDueAt: string;
 }
 /**
  * Order entity from OrderModule
@@ -1357,6 +1396,8 @@ export declare class Order extends OdinRecord<OrderProperties> {
     WorkOrder: OdinLink<LinkedOdinRecord<WorkOrderProperties>>;
     /** Linked Email records (Order__Email) */
     Email: OdinLink<LinkedOdinRecord<EmailProperties>>;
+    /** Linked Commitment records (Commitment__Order) */
+    Commitment: OdinLink<LinkedOdinRecord<CommitmentProperties>>;
 }
 /**
  * RabbitMQ routing keys for Order events

package/dist/entities-v2/Order.js

@@ -12,8 +12,8 @@
  * Generated from Odin schema definition
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ROUTING_KEY_LINK_ORDER_APPOINTMENT_CREATED = exports.ROUTING_KEY_LINK_ORDER_CUSTOMER_DEVICE_ROUTER_DELETED = exports.ROUTING_KEY_LINK_ORDER_CUSTOMER_DEVICE_ROUTER_CREATED = exports.ROUTING_KEY_LINK_ORDER_SMS_MESSAGE_DELETED = exports.ROUTING_KEY_LINK_ORDER_SMS_MESSAGE_CREATED = exports.ROUTING_KEY_LINK_ORDER_ORDER_DELETED = exports.ROUTING_KEY_LINK_ORDER_ORDER_CREATED = exports.ROUTING_KEY_LINK_ORDER_FILE_DELETED = exports.ROUTING_KEY_LINK_ORDER_FILE_CREATED = exports.ROUTING_KEY_LINK_ORDER_ORDER_ITEM_DELETED = exports.ROUTING_KEY_LINK_ORDER_ORDER_ITEM_CREATED = exports.ROUTING_KEY_LINK_ORDER_BILLING_ADJUSTMENT_DELETED = exports.ROUTING_KEY_LINK_ORDER_BILLING_ADJUSTMENT_CREATED = exports.ROUTING_KEY_LINK_ORDER_PUSH_NOTIFICATION_DELETED = exports.ROUTING_KEY_LINK_ORDER_PUSH_NOTIFICATION_CREATED = exports.ROUTING_KEY_LINK_ORDER_DISCOUNT_DELETED = exports.ROUTING_KEY_LINK_ORDER_DISCOUNT_CREATED = exports.ROUTING_KEY_LINK_ORDER_ADDRESS_DELETED = exports.ROUTING_KEY_LINK_ORDER_ADDRESS_CREATED = exports.ROUTING_KEY_LINK_ORDER_PHONE_NUMBER_DELETED = exports.ROUTING_KEY_LINK_ORDER_PHONE_NUMBER_CREATED = exports.ROUTING_KEY_LINK_ORDER_NOTE_DELETED = exports.ROUTING_KEY_LINK_ORDER_NOTE_CREATED = exports.ROUTING_KEY_ORDER_DEFAULT_DELETED = exports.ROUTING_KEY_ORDER_DEFAULT_UPDATED = exports.ROUTING_KEY_ORDER_DEFAULT_CREATED = exports.ROUTING_KEY_ORDER_DELETED = exports.ROUTING_KEY_ORDER_UPDATED = exports.ROUTING_KEY_ORDER_CREATED = exports.Order = exports.OrderPropertyKeys = exports.OrderBatteryBackupAnswersSource = exports.OrderActivationStatus = exports.OrderSupplierOrderType = exports.OrderOtsNotRequiredReason = exports.OrderBatteryPackRequired = exports.OrderMobileCoverage = exports.OrderAltContactMethod = exports.OrderProvider = exports.OrderBillingTerms = exports.OrderDeactivationReason = exports.OrderDiscountType = exports.OrderWithholdCommissionReason = exports.OrderDiscountUnit = exports.OrderTrialUnit = exports.OrderContractType = exports.OrderCurrencyCode = exports.DefaultOrderStageKeys = exports.DefaultOrderStageNames = exports.OrderEntityTypes = void 0;
-exports.ROUTING_KEY_LINK_ORDER_EMAIL_DELETED = exports.ROUTING_KEY_LINK_ORDER_EMAIL_CREATED = exports.ROUTING_KEY_LINK_ORDER_WORK_ORDER_DELETED = exports.ROUTING_KEY_LINK_ORDER_WORK_ORDER_CREATED = exports.ROUTING_KEY_LINK_ORDER_CONTACT_DELETED = exports.ROUTING_KEY_LINK_ORDER_CONTACT_CREATED = exports.ROUTING_KEY_LINK_ORDER_INVOICE_DELETED = exports.ROUTING_KEY_LINK_ORDER_INVOICE_CREATED = exports.ROUTING_KEY_LINK_ORDER_ACTIVITY_LOG_DELETED = exports.ROUTING_KEY_LINK_ORDER_ACTIVITY_LOG_CREATED = exports.ROUTING_KEY_LINK_ORDER_ACTIVITY_DELETED = exports.ROUTING_KEY_LINK_ORDER_ACTIVITY_CREATED = exports.ROUTING_KEY_LINK_ORDER_ORDER_CHECK_DELETED = exports.ROUTING_KEY_LINK_ORDER_ORDER_CHECK_CREATED = exports.ROUTING_KEY_LINK_ORDER_CUSTOMER_DEVICE_ONT_DELETED = exports.ROUTING_KEY_LINK_ORDER_CUSTOMER_DEVICE_ONT_CREATED = exports.ROUTING_KEY_LINK_ORDER_VISIT_DELETED = exports.ROUTING_KEY_LINK_ORDER_VISIT_CREATED = exports.ROUTING_KEY_LINK_ORDER_COMMISSION_DELETED = exports.ROUTING_KEY_LINK_ORDER_COMMISSION_CREATED = exports.ROUTING_KEY_LINK_ORDER_ORDER_KCI_DELETED = exports.ROUTING_KEY_LINK_ORDER_ORDER_KCI_CREATED = exports.ROUTING_KEY_LINK_ORDER_REFERRAL_DELETED = exports.ROUTING_KEY_LINK_ORDER_REFERRAL_CREATED = exports.ROUTING_KEY_LINK_ORDER_CONTRACT_BUY_OUT_DELETED = exports.ROUTING_KEY_LINK_ORDER_CONTRACT_BUY_OUT_CREATED = exports.ROUTING_KEY_LINK_ORDER_CONTACT_IDENTITY_DELETED = exports.ROUTING_KEY_LINK_ORDER_CONTACT_IDENTITY_CREATED = exports.ROUTING_KEY_LINK_ORDER_APPOINTMENT_DELETED = void 0;
+exports.ROUTING_KEY_LINK_ORDER_CUSTOMER_DEVICE_ROUTER_DELETED = exports.ROUTING_KEY_LINK_ORDER_CUSTOMER_DEVICE_ROUTER_CREATED = exports.ROUTING_KEY_LINK_ORDER_SMS_MESSAGE_DELETED = exports.ROUTING_KEY_LINK_ORDER_SMS_MESSAGE_CREATED = exports.ROUTING_KEY_LINK_ORDER_ORDER_DELETED = exports.ROUTING_KEY_LINK_ORDER_ORDER_CREATED = exports.ROUTING_KEY_LINK_ORDER_FILE_DELETED = exports.ROUTING_KEY_LINK_ORDER_FILE_CREATED = exports.ROUTING_KEY_LINK_ORDER_ORDER_ITEM_DELETED = exports.ROUTING_KEY_LINK_ORDER_ORDER_ITEM_CREATED = exports.ROUTING_KEY_LINK_ORDER_BILLING_ADJUSTMENT_DELETED = exports.ROUTING_KEY_LINK_ORDER_BILLING_ADJUSTMENT_CREATED = exports.ROUTING_KEY_LINK_ORDER_PUSH_NOTIFICATION_DELETED = exports.ROUTING_KEY_LINK_ORDER_PUSH_NOTIFICATION_CREATED = exports.ROUTING_KEY_LINK_ORDER_DISCOUNT_DELETED = exports.ROUTING_KEY_LINK_ORDER_DISCOUNT_CREATED = exports.ROUTING_KEY_LINK_ORDER_ADDRESS_DELETED = exports.ROUTING_KEY_LINK_ORDER_ADDRESS_CREATED = exports.ROUTING_KEY_LINK_ORDER_PHONE_NUMBER_DELETED = exports.ROUTING_KEY_LINK_ORDER_PHONE_NUMBER_CREATED = exports.ROUTING_KEY_LINK_ORDER_NOTE_DELETED = exports.ROUTING_KEY_LINK_ORDER_NOTE_CREATED = exports.ROUTING_KEY_ORDER_DEFAULT_DELETED = exports.ROUTING_KEY_ORDER_DEFAULT_UPDATED = exports.ROUTING_KEY_ORDER_DEFAULT_CREATED = exports.ROUTING_KEY_ORDER_DELETED = exports.ROUTING_KEY_ORDER_UPDATED = exports.ROUTING_KEY_ORDER_CREATED = exports.Order = exports.OrderPropertyKeys = exports.OrderFulfillmentState = exports.OrderBatteryBackupAnswersSource = exports.OrderActivationStatus = exports.OrderSupplierOrderType = exports.OrderOtsNotRequiredReason = exports.OrderBatteryPackRequired = exports.OrderMobileCoverage = exports.OrderAltContactMethod = exports.OrderProvider = exports.OrderBillingTerms = exports.OrderDeactivationReason = exports.OrderDiscountType = exports.OrderWithholdCommissionReason = exports.OrderDiscountUnit = exports.OrderTrialUnit = exports.OrderContractType = exports.OrderCurrencyCode = exports.DefaultOrderStageKeys = exports.DefaultOrderStageNames = exports.OrderEntityTypes = void 0;
+exports.ROUTING_KEY_LINK_ORDER_EMAIL_DELETED = exports.ROUTING_KEY_LINK_ORDER_EMAIL_CREATED = exports.ROUTING_KEY_LINK_ORDER_WORK_ORDER_DELETED = exports.ROUTING_KEY_LINK_ORDER_WORK_ORDER_CREATED = exports.ROUTING_KEY_LINK_ORDER_CONTACT_DELETED = exports.ROUTING_KEY_LINK_ORDER_CONTACT_CREATED = exports.ROUTING_KEY_LINK_ORDER_INVOICE_DELETED = exports.ROUTING_KEY_LINK_ORDER_INVOICE_CREATED = exports.ROUTING_KEY_LINK_ORDER_ACTIVITY_LOG_DELETED = exports.ROUTING_KEY_LINK_ORDER_ACTIVITY_LOG_CREATED = exports.ROUTING_KEY_LINK_ORDER_ACTIVITY_DELETED = exports.ROUTING_KEY_LINK_ORDER_ACTIVITY_CREATED = exports.ROUTING_KEY_LINK_ORDER_ORDER_CHECK_DELETED = exports.ROUTING_KEY_LINK_ORDER_ORDER_CHECK_CREATED = exports.ROUTING_KEY_LINK_ORDER_CUSTOMER_DEVICE_ONT_DELETED = exports.ROUTING_KEY_LINK_ORDER_CUSTOMER_DEVICE_ONT_CREATED = exports.ROUTING_KEY_LINK_ORDER_VISIT_DELETED = exports.ROUTING_KEY_LINK_ORDER_VISIT_CREATED = exports.ROUTING_KEY_LINK_ORDER_COMMISSION_DELETED = exports.ROUTING_KEY_LINK_ORDER_COMMISSION_CREATED = exports.ROUTING_KEY_LINK_ORDER_ORDER_KCI_DELETED = exports.ROUTING_KEY_LINK_ORDER_ORDER_KCI_CREATED = exports.ROUTING_KEY_LINK_ORDER_REFERRAL_DELETED = exports.ROUTING_KEY_LINK_ORDER_REFERRAL_CREATED = exports.ROUTING_KEY_LINK_ORDER_CONTRACT_BUY_OUT_DELETED = exports.ROUTING_KEY_LINK_ORDER_CONTRACT_BUY_OUT_CREATED = exports.ROUTING_KEY_LINK_ORDER_CONTACT_IDENTITY_DELETED = exports.ROUTING_KEY_LINK_ORDER_CONTACT_IDENTITY_CREATED = exports.ROUTING_KEY_LINK_ORDER_APPOINTMENT_DELETED = exports.ROUTING_KEY_LINK_ORDER_APPOINTMENT_CREATED = void 0;
 const core_1 = require("@d19n/odin-types/dist/core");
 /**
  * Available types for Order records
@@ -360,6 +360,20 @@ var OrderBatteryBackupAnswersSource;
     OrderBatteryBackupAnswersSource["CUSTOMER_APP"] = "CUSTOMER_APP";
     OrderBatteryBackupAnswersSource["CUSTOMER_PORTAL"] = "CUSTOMER_PORTAL";
 })(OrderBatteryBackupAnswersSource = exports.OrderBatteryBackupAnswersSource || (exports.OrderBatteryBackupAnswersSource = {}));
+/**
+ * Valid values for Order.FulfillmentState
+ *
+ * Derived from the commitment set: OPEN while any commitment is Pending or Breached, SETTLED when none is. Written only by the commitment lifecycle.
+ *
+ * @remarks Available options:
+ * - `OPEN` - Open
+ * - `SETTLED` - Settled
+ */
+var OrderFulfillmentState;
+(function (OrderFulfillmentState) {
+    OrderFulfillmentState["OPEN"] = "OPEN";
+    OrderFulfillmentState["SETTLED"] = "SETTLED";
+})(OrderFulfillmentState = exports.OrderFulfillmentState || (exports.OrderFulfillmentState = {}));
 /**
  * Property keys for Order
  * Use these constants instead of string literals for type safety
@@ -578,6 +592,12 @@ var OrderPropertyKeys;
     OrderPropertyKeys["DeactivationDate"] = "DeactivationDate";
     /** Used when restarting an existing service, allows the customer to specify what date is used for the RequestedCompletionDate on the supplier-side START order. Used for when a customer is technically able to start receiving service. */
     OrderPropertyKeys["RequestedActivationDate"] = "RequestedActivationDate";
+    /** Derived from the commitment set: OPEN while any commitment is Pending or Breached, SETTLED when none is. Written only by the commitment lifecycle. */
+    OrderPropertyKeys["FulfillmentState"] = "FulfillmentState";
+    /** How many commitments are Pending or Breached. Written only by the lifecycle. */
+    OrderPropertyKeys["OpenCommitmentCount"] = "OpenCommitmentCount";
+    /** The next commitment to fall due. What a "what is about to breach" query sorts on, without walking every commitment. Written only by the lifecycle. */
+    OrderPropertyKeys["EarliestDueAt"] = "EarliestDueAt";
 })(OrderPropertyKeys = exports.OrderPropertyKeys || (exports.OrderPropertyKeys = {}));
 /**
  * Order entity from OrderModule

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@d19n/youfibre-odin-sdk",
-  "version": "2.0.343",
+  "version": "2.0.344",
   "description": "",
   "author": "@d19n",
   "license": "UNLICENSED",