@d19n/youfibre-odin-sdk 2.0.369 → 2.0.371

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

@@ -71,14 +71,14 @@ export declare enum EquipmentReturnItemDeviceEntity {
  * Condition as inspected. Same option set as Returns.Cpe{n}Grade. Only meaningful when Returned is true
  *
  * @remarks Available options:
- * - `A`
- * - `B`
- * - `C`
+ * - `B` - Fail - Cosmetic
+ * - `C` - Fail - Technical
+ * - `A` - Pass
  */
 export declare enum EquipmentReturnItemGrade {
-    'A' = "A",
-    'B' = "B",
-    'C' = "C"
+    FAIL_COSMETIC = "B",
+    FAIL_TECHNICAL = "C",
+    PASS = "A"
 }
 /**
  * Property keys for EquipmentReturnItem

package/dist/entities-v2/EquipmentReturnItem.js

@@ -74,15 +74,15 @@ var EquipmentReturnItemDeviceEntity;
  * Condition as inspected. Same option set as Returns.Cpe{n}Grade. Only meaningful when Returned is true
  *
  * @remarks Available options:
- * - `A`
- * - `B`
- * - `C`
+ * - `B` - Fail - Cosmetic
+ * - `C` - Fail - Technical
+ * - `A` - Pass
  */
 var EquipmentReturnItemGrade;
 (function (EquipmentReturnItemGrade) {
-    EquipmentReturnItemGrade["A"] = "A";
-    EquipmentReturnItemGrade["B"] = "B";
-    EquipmentReturnItemGrade["C"] = "C";
+    EquipmentReturnItemGrade["FAIL_COSMETIC"] = "B";
+    EquipmentReturnItemGrade["FAIL_TECHNICAL"] = "C";
+    EquipmentReturnItemGrade["PASS"] = "A";
 })(EquipmentReturnItemGrade = exports.EquipmentReturnItemGrade || (exports.EquipmentReturnItemGrade = {}));
 /**
  * Property keys for EquipmentReturnItem

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

@@ -130,6 +130,19 @@ export declare enum HomeMoveNewOrderInstallTimeBlock {
     AM = "AM",
     PM = "PM"
 }
+/**
+ * Valid values for HomeMove.NewOrderPrice
+ *
+ * The price the new order is placed at. Set when the contract summary is sent; locked once the move is confirmed. Empty = Current.
+ *
+ * @remarks Available options:
+ * - `CURRENT` - Current price
+ * - `WEBSITE` - Website price (re-quoted)
+ */
+export declare enum HomeMoveNewOrderPrice {
+    CURRENT_PRICE = "CURRENT",
+    WEBSITE_PRICE_RE_QUOTED = "WEBSITE"
+}
 /**
  * Property keys for HomeMove
  * Use these constants instead of string literals for type safety
@@ -168,7 +181,9 @@ export declare enum HomeMovePropertyKeys {
     /** Which network can serve the new address. Set by the serviceability check at Created. Netomnia and Brsk are one company, so both move now; OPENREACH is a later phase. */
     ServiceableVia = "ServiceableVia",
     /** AM or PM engineer slot for a New Provide move, chosen with NewOrderInstallOrActivationDate from the install calendar. Empty on a Start Order. */
-    NewOrderInstallTimeBlock = "NewOrderInstallTimeBlock"
+    NewOrderInstallTimeBlock = "NewOrderInstallTimeBlock",
+    /** The price the new order is placed at. Set when the contract summary is sent; locked once the move is confirmed. Empty = Current. */
+    NewOrderPrice = "NewOrderPrice"
 }
 /**
  * Properties for HomeMove records
@@ -282,6 +297,13 @@ export interface HomeMoveProperties {
      * @enum {HomeMoveNewOrderInstallTimeBlock}
      */
     NewOrderInstallTimeBlock: HomeMoveNewOrderInstallTimeBlock;
+    /** The price the new order is placed at. Set when the contract summary is sent; locked once the move is confirmed. Empty = Current.
+     *
+     * @type {ENUM}
+     * @default
+     * @enum {HomeMoveNewOrderPrice}
+     */
+    NewOrderPrice: HomeMoveNewOrderPrice;
 }
 /**
  * HomeMove entity from OrderModule

package/dist/entities-v2/HomeMove.js

@@ -12,7 +12,7 @@
  * Generated from Odin schema definition
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ROUTING_KEY_LINK_HOME_MOVE_NOTE_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_NOTE_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_WORK_ORDER_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_WORK_ORDER_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_CASE_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_CASE_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_NEW_ADDRESS_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_NEW_ADDRESS_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_OLD_ORDER_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_OLD_ORDER_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_FILE_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_FILE_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_CONTACT_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_CONTACT_CREATED = exports.ROUTING_KEY_HOME_MOVE_DEFAULT_DELETED = exports.ROUTING_KEY_HOME_MOVE_DEFAULT_UPDATED = exports.ROUTING_KEY_HOME_MOVE_DEFAULT_CREATED = exports.ROUTING_KEY_HOME_MOVE_DELETED = exports.ROUTING_KEY_HOME_MOVE_UPDATED = exports.ROUTING_KEY_HOME_MOVE_CREATED = exports.HomeMove = exports.HomeMovePropertyKeys = exports.HomeMoveNewOrderInstallTimeBlock = exports.HomeMoveServiceableVia = exports.HomeMoveCollectionKitAddress = exports.HomeMoveRouterDeliveryAddress = exports.DefaultHomeMoveStageKeys = exports.DefaultHomeMoveStageNames = exports.HomeMoveEntityTypes = void 0;
+exports.ROUTING_KEY_LINK_HOME_MOVE_NOTE_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_NOTE_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_WORK_ORDER_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_WORK_ORDER_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_CASE_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_CASE_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_NEW_ADDRESS_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_NEW_ADDRESS_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_OLD_ORDER_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_OLD_ORDER_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_FILE_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_FILE_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_CONTACT_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_CONTACT_CREATED = exports.ROUTING_KEY_HOME_MOVE_DEFAULT_DELETED = exports.ROUTING_KEY_HOME_MOVE_DEFAULT_UPDATED = exports.ROUTING_KEY_HOME_MOVE_DEFAULT_CREATED = exports.ROUTING_KEY_HOME_MOVE_DELETED = exports.ROUTING_KEY_HOME_MOVE_UPDATED = exports.ROUTING_KEY_HOME_MOVE_CREATED = exports.HomeMove = exports.HomeMovePropertyKeys = exports.HomeMoveNewOrderPrice = exports.HomeMoveNewOrderInstallTimeBlock = exports.HomeMoveServiceableVia = exports.HomeMoveCollectionKitAddress = exports.HomeMoveRouterDeliveryAddress = exports.DefaultHomeMoveStageKeys = exports.DefaultHomeMoveStageNames = exports.HomeMoveEntityTypes = void 0;
 const core_1 = require("@d19n/odin-types/dist/core");
 /**
  * Available types for HomeMove records
@@ -133,6 +133,20 @@ var HomeMoveNewOrderInstallTimeBlock;
     HomeMoveNewOrderInstallTimeBlock["AM"] = "AM";
     HomeMoveNewOrderInstallTimeBlock["PM"] = "PM";
 })(HomeMoveNewOrderInstallTimeBlock = exports.HomeMoveNewOrderInstallTimeBlock || (exports.HomeMoveNewOrderInstallTimeBlock = {}));
+/**
+ * Valid values for HomeMove.NewOrderPrice
+ *
+ * The price the new order is placed at. Set when the contract summary is sent; locked once the move is confirmed. Empty = Current.
+ *
+ * @remarks Available options:
+ * - `CURRENT` - Current price
+ * - `WEBSITE` - Website price (re-quoted)
+ */
+var HomeMoveNewOrderPrice;
+(function (HomeMoveNewOrderPrice) {
+    HomeMoveNewOrderPrice["CURRENT_PRICE"] = "CURRENT";
+    HomeMoveNewOrderPrice["WEBSITE_PRICE_RE_QUOTED"] = "WEBSITE";
+})(HomeMoveNewOrderPrice = exports.HomeMoveNewOrderPrice || (exports.HomeMoveNewOrderPrice = {}));
 /**
  * Property keys for HomeMove
  * Use these constants instead of string literals for type safety
@@ -173,6 +187,8 @@ var HomeMovePropertyKeys;
     HomeMovePropertyKeys["ServiceableVia"] = "ServiceableVia";
     /** AM or PM engineer slot for a New Provide move, chosen with NewOrderInstallOrActivationDate from the install calendar. Empty on a Start Order. */
     HomeMovePropertyKeys["NewOrderInstallTimeBlock"] = "NewOrderInstallTimeBlock";
+    /** The price the new order is placed at. Set when the contract summary is sent; locked once the move is confirmed. Empty = Current. */
+    HomeMovePropertyKeys["NewOrderPrice"] = "NewOrderPrice";
 })(HomeMovePropertyKeys = exports.HomeMovePropertyKeys || (exports.HomeMovePropertyKeys = {}));
 /**
  * HomeMove entity from OrderModule

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

@@ -97,8 +97,6 @@ export declare enum NoteEntityTypes {
  * Use these constants instead of string literals for type safety
  */
 export declare enum NotePropertyKeys {
-    /** body of the note (Customer Service - Note) */
-    Body = "Body",
     /** Data field for Note records. Used by Customer Service team. */
     MetaData = "MetaData",
     /** JSONContent (Customer Service - Note) */
@@ -114,7 +112,11 @@ export declare enum NotePropertyKeys {
     /** The author of the note (Customer Service - Note) */
     Author = "Author",
     /** Data field for Note records. Used by Customer Service team. */
-    Case = "Case"
+    Case = "Case",
+    /** True makes the desktop case conversation feed show only the first line of this note, with Show more to open it. Empty or false shows the whole note. Set by Edgar AI on the notes it writes. */
+    Collapsed = "Collapsed",
+    /** body of the note (Customer Service - Note) */
+    Body = "Body"
 }
 /**
  * Properties for Note records
@@ -122,12 +124,6 @@ export declare enum NotePropertyKeys {
  * @see SupportModule:Note
  */
 export interface NoteProperties {
-    /** body of the note (Customer Service - Note)
-     *
-     * @type {TEXT_LONG}
-     * @placeholder body
-     */
-    Body: string;
     /** Data field for Note records. Used by Customer Service team.
      *
      * @type {JSON}
@@ -171,6 +167,19 @@ export interface NoteProperties {
      * @type {LOOKUP}
      */
     Case: string;
+    /** True makes the desktop case conversation feed show only the first line of this note, with Show more to open it. Empty or false shows the whole note. Set by Edgar AI on the notes it writes.
+     *
+     * @type {BOOLEAN}
+     * @default
+     * @hidden This field is hidden in the UI
+     */
+    Collapsed: boolean;
+    /** body of the note (Customer Service - Note)
+     *
+     * @type {TEXT_LONG}
+     * @placeholder Type here
+     */
+    Body: string;
 }
 /**
  * Note entity from SupportModule

package/dist/entities-v2/Note.js

@@ -28,8 +28,6 @@ var NoteEntityTypes;
  */
 var NotePropertyKeys;
 (function (NotePropertyKeys) {
-    /** body of the note (Customer Service - Note) */
-    NotePropertyKeys["Body"] = "Body";
     /** Data field for Note records. Used by Customer Service team. */
     NotePropertyKeys["MetaData"] = "MetaData";
     /** JSONContent (Customer Service - Note) */
@@ -46,6 +44,10 @@ var NotePropertyKeys;
     NotePropertyKeys["Author"] = "Author";
     /** Data field for Note records. Used by Customer Service team. */
     NotePropertyKeys["Case"] = "Case";
+    /** True makes the desktop case conversation feed show only the first line of this note, with Show more to open it. Empty or false shows the whole note. Set by Edgar AI on the notes it writes. */
+    NotePropertyKeys["Collapsed"] = "Collapsed";
+    /** body of the note (Customer Service - Note) */
+    NotePropertyKeys["Body"] = "Body";
 })(NotePropertyKeys = exports.NotePropertyKeys || (exports.NotePropertyKeys = {}));
 /**
  * Note entity from SupportModule

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

@@ -614,7 +614,9 @@ export declare enum OrderPropertyKeys {
     /** 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"
+    EarliestDueAt = "EarliestDueAt",
+    /** True while the customer has declined the router/mesh dispatch this recontract would otherwise raise. Written by dispatchRouterForSpeedChange on every call — true when a decline is honoured, false otherwise — so reversal is simply calling the endpoint again with no decline flag (ORD-493). */
+    RouterUpgradeDeclined = "RouterUpgradeDeclined"
 }
 /**
  * Properties for Order records
@@ -1297,6 +1299,12 @@ export interface OrderProperties {
      * @default
      */
     EarliestDueAt: string;
+    /** True while the customer has declined the router/mesh dispatch this recontract would otherwise raise. Written by dispatchRouterForSpeedChange on every call — true when a decline is honoured, false otherwise — so reversal is simply calling the endpoint again with no decline flag (ORD-493).
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    RouterUpgradeDeclined: boolean;
 }
 /**
  * Order entity from OrderModule

package/dist/entities-v2/Order.js

@@ -598,6 +598,8 @@ var OrderPropertyKeys;
     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";
+    /** True while the customer has declined the router/mesh dispatch this recontract would otherwise raise. Written by dispatchRouterForSpeedChange on every call — true when a decline is honoured, false otherwise — so reversal is simply calling the endpoint again with no decline flag (ORD-493). */
+    OrderPropertyKeys["RouterUpgradeDeclined"] = "RouterUpgradeDeclined";
 })(OrderPropertyKeys = exports.OrderPropertyKeys || (exports.OrderPropertyKeys = {}));
 /**
  * Order entity from OrderModule

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

@@ -62,7 +62,11 @@ export declare enum OutboundDialCampaignCasePropertyKeys {
     /** When this campaign last dialled this case. Per-campaign successor to Case.LastDialAt. */
     LastDialAt = "LastDialAt",
     /** Outcome of this campaign's most recent dial of this case: CONNECTED, NO_ANSWER, BUSY, MACHINE or FAILED (the dialer's LastDialOutcome union). TEXT, not ENUM: the dialer is the only writer and a schema enum would need option shepherding on every new outcome. Per-campaign successor to Case.LastDialOutcome. */
-    LastDialOutcome = "LastDialOutcome"
+    LastDialOutcome = "LastDialOutcome",
+    /** The call outcome the agent saved, e.g. "RET - Re-Contracted - Free MESH" (CASES-1993). Reporting only: LastDialOutcome is what drives retries. */
+    AgentOutcome = "AgentOutcome",
+    /** Why the agent skipped this case before dialling: ALREADY_RECONTRACTED, OTS_OTHER_PROCESS, PENDING_CANCELLATION, or "OTHER: <note>" (CASES-1993). */
+    SkipReason = "SkipReason"
 }
 /**
  * Properties for OutboundDialCampaignCase records
@@ -122,6 +126,18 @@ export interface OutboundDialCampaignCaseProperties {
      * @default
      */
     LastDialOutcome: string;
+    /** The call outcome the agent saved, e.g. "RET - Re-Contracted - Free MESH" (CASES-1993). Reporting only: LastDialOutcome is what drives retries.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    AgentOutcome: string;
+    /** Why the agent skipped this case before dialling: ALREADY_RECONTRACTED, OTS_OTHER_PROCESS, PENDING_CANCELLATION, or "OTHER: <note>" (CASES-1993).
+     *
+     * @type {TEXT}
+     * @default
+     */
+    SkipReason: string;
 }
 /**
  * OutboundDialCampaignCase entity from SupportModule

package/dist/entities-v2/OutboundDialCampaignCase.js

@@ -66,6 +66,10 @@ var OutboundDialCampaignCasePropertyKeys;
     OutboundDialCampaignCasePropertyKeys["LastDialAt"] = "LastDialAt";
     /** Outcome of this campaign's most recent dial of this case: CONNECTED, NO_ANSWER, BUSY, MACHINE or FAILED (the dialer's LastDialOutcome union). TEXT, not ENUM: the dialer is the only writer and a schema enum would need option shepherding on every new outcome. Per-campaign successor to Case.LastDialOutcome. */
     OutboundDialCampaignCasePropertyKeys["LastDialOutcome"] = "LastDialOutcome";
+    /** The call outcome the agent saved, e.g. "RET - Re-Contracted - Free MESH" (CASES-1993). Reporting only: LastDialOutcome is what drives retries. */
+    OutboundDialCampaignCasePropertyKeys["AgentOutcome"] = "AgentOutcome";
+    /** Why the agent skipped this case before dialling: ALREADY_RECONTRACTED, OTS_OTHER_PROCESS, PENDING_CANCELLATION, or "OTHER: <note>" (CASES-1993). */
+    OutboundDialCampaignCasePropertyKeys["SkipReason"] = "SkipReason";
 })(OutboundDialCampaignCasePropertyKeys = exports.OutboundDialCampaignCasePropertyKeys || (exports.OutboundDialCampaignCasePropertyKeys = {}));
 /**
  * OutboundDialCampaignCase entity from SupportModule

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

@@ -0,0 +1,235 @@
+/**
+ * QaBatch Entity Definition
+ *
+ * One bulk QA run: a share of the cases one agent closed in a period, scored in rounds. Carries who asked, the window, the counts and the state. Written only by youfibre-api-support; never edited by hand.
+ *
+ * @module SupportModule
+ * @entity QaBatch
+ * @schemaId 47cd7cfb-d4a1-4028-971b-680b3f40431f
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ * Generated from Odin schema definition
+ */
+import { OdinRecord, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/core';
+import { QaReportProperties } from './QaReport';
+/**
+ * Available types for QaBatch records
+ */
+export declare enum QaBatchEntityTypes {
+    /** This is the default record type */
+    DEFAULT = "DEFAULT"
+}
+/**
+ * Valid values for QaBatch.Status
+ *
+ * RUNNING while the runner works it; DONE when every picked case is done, failed or skipped; STOPPED when a person stopped it; FAILED when the runner gave up or went stale.
+ *
+ * @remarks Available options:
+ * - `DONE` - Done
+ * - `FAILED` - Failed
+ * - `RUNNING` - Running
+ * - `STOPPED` - Stopped
+ */
+export declare enum QaBatchStatus {
+    DONE = "DONE",
+    FAILED = "FAILED",
+    RUNNING = "RUNNING",
+    STOPPED = "STOPPED"
+}
+/**
+ * Property keys for QaBatch
+ * Use these constants instead of string literals for type safety
+ */
+export declare enum QaBatchPropertyKeys {
+    /** The agent whose closed cases the run scores: their assigned-user id, else their owner id, as the QA report attributes a case. */
+    AgentId = "AgentId",
+    /** The display name of the agent at the time of the run. */
+    AgentName = "AgentName",
+    /** Start of the period the cases were closed in (inclusive). */
+    PeriodFrom = "PeriodFrom",
+    /** End of the period the cases were closed in (exclusive). */
+    PeriodTo = "PeriodTo",
+    /** The share of the closed cases asked for: 10 or 25. */
+    Percent = "Percent",
+    /** How many cases the agent closed in the period. */
+    ClosedCount = "ClosedCount",
+    /** How many of those had something to score and no report yet when the run started. */
+    ScorableCount = "ScorableCount",
+    /** ceil(Percent x Closed), capped at 100: how many the run set out to score. */
+    TargetCount = "TargetCount",
+    /** How many cases the run picked: the lower of Target and Scorable. */
+    PickedCount = "PickedCount",
+    /** Reports written so far. */
+    DoneCount = "DoneCount",
+    /** Cases the model could not score after the retries. */
+    FailedCount = "FailedCount",
+    /** Cases refused before the model (nothing to score after all). */
+    SkippedCount = "SkippedCount",
+    /** RUNNING while the runner works it; DONE when every picked case is done, failed or skipped; STOPPED when a person stopped it; FAILED when the runner gave up or went stale. */
+    Status = "Status",
+    /** How many reports the runner kept in flight at once. */
+    Concurrency = "Concurrency",
+    /** Display name of the manager who pressed Go. */
+    RequestedBy = "RequestedBy",
+    /** When the runner took the batch. */
+    StartedAt = "StartedAt",
+    /** When the runner wrote its last count. */
+    FinishedAt = "FinishedAt",
+    /** Why the run FAILED, when it did. */
+    Error = "Error"
+}
+/**
+ * Properties for QaBatch records
+ *
+ * @see SupportModule:QaBatch
+ */
+export interface QaBatchProperties {
+    /** The agent whose closed cases the run scores: their assigned-user id, else their owner id, as the QA report attributes a case.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    AgentId: string;
+    /** The display name of the agent at the time of the run.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    AgentName: string;
+    /** Start of the period the cases were closed in (inclusive).
+     *
+     * @type {DATE_TIME}
+     * @default
+     */
+    PeriodFrom: string;
+    /** End of the period the cases were closed in (exclusive).
+     *
+     * @type {DATE_TIME}
+     * @default
+     */
+    PeriodTo: string;
+    /** The share of the closed cases asked for: 10 or 25.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    Percent: number;
+    /** How many cases the agent closed in the period.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    ClosedCount: number;
+    /** How many of those had something to score and no report yet when the run started.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    ScorableCount: number;
+    /** ceil(Percent x Closed), capped at 100: how many the run set out to score.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    TargetCount: number;
+    /** How many cases the run picked: the lower of Target and Scorable.
+     *
+     * @type {NUMBER}
+     * @default 0
+     */
+    PickedCount: number;
+    /** Reports written so far.
+     *
+     * @type {NUMBER}
+     * @default 0
+     */
+    DoneCount: number;
+    /** Cases the model could not score after the retries.
+     *
+     * @type {NUMBER}
+     * @default 0
+     */
+    FailedCount: number;
+    /** Cases refused before the model (nothing to score after all).
+     *
+     * @type {NUMBER}
+     * @default 0
+     */
+    SkippedCount: number;
+    /** RUNNING while the runner works it; DONE when every picked case is done, failed or skipped; STOPPED when a person stopped it; FAILED when the runner gave up or went stale.
+     *
+     * @type {ENUM}
+     * @default RUNNING
+     * @enum {QaBatchStatus}
+     */
+    Status: QaBatchStatus;
+    /** How many reports the runner kept in flight at once.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    Concurrency: number;
+    /** Display name of the manager who pressed Go.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    RequestedBy: string;
+    /** When the runner took the batch.
+     *
+     * @type {DATE_TIME}
+     * @default
+     */
+    StartedAt: string;
+    /** When the runner wrote its last count.
+     *
+     * @type {DATE_TIME}
+     * @default
+     */
+    FinishedAt: string;
+    /** Why the run FAILED, when it did.
+     *
+     * @type {TEXT_LONG}
+     * @default
+     */
+    Error: string;
+}
+/**
+ * QaBatch entity from SupportModule
+ *
+ * One bulk QA run: a share of the cases one agent closed in a period, scored in rounds. Carries who asked, the window, the counts and the state. Written only by youfibre-api-support; never edited by hand.
+ *
+ * @module SupportModule
+ * @entity QaBatch
+ * @schemaId 47cd7cfb-d4a1-4028-971b-680b3f40431f
+ * @recordPrefix QAB
+ * @capabilities searchable, updateable, undeletable, triggerable
+ */
+export declare class QaBatch extends OdinRecord<QaBatchProperties> {
+    entity: 'SupportModule:QaBatch';
+    type: QaBatchEntityTypes;
+    schemaId: '47cd7cfb-d4a1-4028-971b-680b3f40431f';
+    properties: QaBatchProperties;
+    /** Linked QaReport records (QaBatch__Report) */
+    QaReport: OdinLink<LinkedOdinRecord<QaReportProperties>>;
+}
+/**
+ * RabbitMQ routing keys for QaBatch events
+ */
+export declare const ROUTING_KEY_QA_BATCH_CREATED = "SupportModule.QaBatch.SubDbRecordCreated";
+export declare const ROUTING_KEY_QA_BATCH_UPDATED = "SupportModule.QaBatch.SubDbRecordUpdated";
+export declare const ROUTING_KEY_QA_BATCH_DELETED = "SupportModule.QaBatch.SubDbRecordDeleted";
+/**
+ * Type-specific routing keys for QaBatch events
+ * Subscribe to these for events on specific entity types only
+ */
+/** This is the default record type created */
+export declare const ROUTING_KEY_QA_BATCH_DEFAULT_CREATED = "SupportModule.QaBatch.DEFAULT.SubDbRecordCreated";
+/** This is the default record type updated */
+export declare const ROUTING_KEY_QA_BATCH_DEFAULT_UPDATED = "SupportModule.QaBatch.DEFAULT.SubDbRecordUpdated";
+/** This is the default record type deleted */
+export declare const ROUTING_KEY_QA_BATCH_DEFAULT_DELETED = "SupportModule.QaBatch.DEFAULT.SubDbRecordDeleted";
+/** Event: QaBatch__Report link created */
+export declare const ROUTING_KEY_LINK_QA_BATCH_REPORT_CREATED = "SupportModule.QaBatch.QaReport.SubDbRecordAssociationCreated";
+/** Event: QaBatch__Report link deleted */
+export declare const ROUTING_KEY_LINK_QA_BATCH_REPORT_DELETED = "SupportModule.QaBatch.QaReport.SubDbRecordAssociationDeleted";

package/dist/entities-v2/QaBatch.js

@@ -0,0 +1,122 @@
+"use strict";
+/**
+ * QaBatch Entity Definition
+ *
+ * One bulk QA run: a share of the cases one agent closed in a period, scored in rounds. Carries who asked, the window, the counts and the state. Written only by youfibre-api-support; never edited by hand.
+ *
+ * @module SupportModule
+ * @entity QaBatch
+ * @schemaId 47cd7cfb-d4a1-4028-971b-680b3f40431f
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ * Generated from Odin schema definition
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ROUTING_KEY_LINK_QA_BATCH_REPORT_DELETED = exports.ROUTING_KEY_LINK_QA_BATCH_REPORT_CREATED = exports.ROUTING_KEY_QA_BATCH_DEFAULT_DELETED = exports.ROUTING_KEY_QA_BATCH_DEFAULT_UPDATED = exports.ROUTING_KEY_QA_BATCH_DEFAULT_CREATED = exports.ROUTING_KEY_QA_BATCH_DELETED = exports.ROUTING_KEY_QA_BATCH_UPDATED = exports.ROUTING_KEY_QA_BATCH_CREATED = exports.QaBatch = exports.QaBatchPropertyKeys = exports.QaBatchStatus = exports.QaBatchEntityTypes = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * Available types for QaBatch records
+ */
+var QaBatchEntityTypes;
+(function (QaBatchEntityTypes) {
+    /** This is the default record type */
+    QaBatchEntityTypes["DEFAULT"] = "DEFAULT";
+})(QaBatchEntityTypes = exports.QaBatchEntityTypes || (exports.QaBatchEntityTypes = {}));
+/**
+ * Valid values for QaBatch.Status
+ *
+ * RUNNING while the runner works it; DONE when every picked case is done, failed or skipped; STOPPED when a person stopped it; FAILED when the runner gave up or went stale.
+ *
+ * @remarks Available options:
+ * - `DONE` - Done
+ * - `FAILED` - Failed
+ * - `RUNNING` - Running
+ * - `STOPPED` - Stopped
+ */
+var QaBatchStatus;
+(function (QaBatchStatus) {
+    QaBatchStatus["DONE"] = "DONE";
+    QaBatchStatus["FAILED"] = "FAILED";
+    QaBatchStatus["RUNNING"] = "RUNNING";
+    QaBatchStatus["STOPPED"] = "STOPPED";
+})(QaBatchStatus = exports.QaBatchStatus || (exports.QaBatchStatus = {}));
+/**
+ * Property keys for QaBatch
+ * Use these constants instead of string literals for type safety
+ */
+var QaBatchPropertyKeys;
+(function (QaBatchPropertyKeys) {
+    /** The agent whose closed cases the run scores: their assigned-user id, else their owner id, as the QA report attributes a case. */
+    QaBatchPropertyKeys["AgentId"] = "AgentId";
+    /** The display name of the agent at the time of the run. */
+    QaBatchPropertyKeys["AgentName"] = "AgentName";
+    /** Start of the period the cases were closed in (inclusive). */
+    QaBatchPropertyKeys["PeriodFrom"] = "PeriodFrom";
+    /** End of the period the cases were closed in (exclusive). */
+    QaBatchPropertyKeys["PeriodTo"] = "PeriodTo";
+    /** The share of the closed cases asked for: 10 or 25. */
+    QaBatchPropertyKeys["Percent"] = "Percent";
+    /** How many cases the agent closed in the period. */
+    QaBatchPropertyKeys["ClosedCount"] = "ClosedCount";
+    /** How many of those had something to score and no report yet when the run started. */
+    QaBatchPropertyKeys["ScorableCount"] = "ScorableCount";
+    /** ceil(Percent x Closed), capped at 100: how many the run set out to score. */
+    QaBatchPropertyKeys["TargetCount"] = "TargetCount";
+    /** How many cases the run picked: the lower of Target and Scorable. */
+    QaBatchPropertyKeys["PickedCount"] = "PickedCount";
+    /** Reports written so far. */
+    QaBatchPropertyKeys["DoneCount"] = "DoneCount";
+    /** Cases the model could not score after the retries. */
+    QaBatchPropertyKeys["FailedCount"] = "FailedCount";
+    /** Cases refused before the model (nothing to score after all). */
+    QaBatchPropertyKeys["SkippedCount"] = "SkippedCount";
+    /** RUNNING while the runner works it; DONE when every picked case is done, failed or skipped; STOPPED when a person stopped it; FAILED when the runner gave up or went stale. */
+    QaBatchPropertyKeys["Status"] = "Status";
+    /** How many reports the runner kept in flight at once. */
+    QaBatchPropertyKeys["Concurrency"] = "Concurrency";
+    /** Display name of the manager who pressed Go. */
+    QaBatchPropertyKeys["RequestedBy"] = "RequestedBy";
+    /** When the runner took the batch. */
+    QaBatchPropertyKeys["StartedAt"] = "StartedAt";
+    /** When the runner wrote its last count. */
+    QaBatchPropertyKeys["FinishedAt"] = "FinishedAt";
+    /** Why the run FAILED, when it did. */
+    QaBatchPropertyKeys["Error"] = "Error";
+})(QaBatchPropertyKeys = exports.QaBatchPropertyKeys || (exports.QaBatchPropertyKeys = {}));
+/**
+ * QaBatch entity from SupportModule
+ *
+ * One bulk QA run: a share of the cases one agent closed in a period, scored in rounds. Carries who asked, the window, the counts and the state. Written only by youfibre-api-support; never edited by hand.
+ *
+ * @module SupportModule
+ * @entity QaBatch
+ * @schemaId 47cd7cfb-d4a1-4028-971b-680b3f40431f
+ * @recordPrefix QAB
+ * @capabilities searchable, updateable, undeletable, triggerable
+ */
+class QaBatch extends core_1.OdinRecord {
+}
+exports.QaBatch = QaBatch;
+// ============================================
+// RABBITMQ EVENT ROUTING KEYS
+// ============================================
+/**
+ * RabbitMQ routing keys for QaBatch events
+ */
+exports.ROUTING_KEY_QA_BATCH_CREATED = 'SupportModule.QaBatch.SubDbRecordCreated';
+exports.ROUTING_KEY_QA_BATCH_UPDATED = 'SupportModule.QaBatch.SubDbRecordUpdated';
+exports.ROUTING_KEY_QA_BATCH_DELETED = 'SupportModule.QaBatch.SubDbRecordDeleted';
+/**
+ * Type-specific routing keys for QaBatch events
+ * Subscribe to these for events on specific entity types only
+ */
+/** This is the default record type created */
+exports.ROUTING_KEY_QA_BATCH_DEFAULT_CREATED = 'SupportModule.QaBatch.DEFAULT.SubDbRecordCreated';
+/** This is the default record type updated */
+exports.ROUTING_KEY_QA_BATCH_DEFAULT_UPDATED = 'SupportModule.QaBatch.DEFAULT.SubDbRecordUpdated';
+/** This is the default record type deleted */
+exports.ROUTING_KEY_QA_BATCH_DEFAULT_DELETED = 'SupportModule.QaBatch.DEFAULT.SubDbRecordDeleted';
+/** Event: QaBatch__Report link created */
+exports.ROUTING_KEY_LINK_QA_BATCH_REPORT_CREATED = 'SupportModule.QaBatch.QaReport.SubDbRecordAssociationCreated';
+/** Event: QaBatch__Report link deleted */
+exports.ROUTING_KEY_LINK_QA_BATCH_REPORT_DELETED = 'SupportModule.QaBatch.QaReport.SubDbRecordAssociationDeleted';