@d19n/youfibre-odin-sdk 2.0.320 → 2.0.322

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

@@ -0,0 +1,247 @@
+/**
+ * CoachingSession Entity Definition
+ *
+ * One coaching conversation with one agent, normally created from a submitted QA evaluation. Tracked to completion, acknowledged by the agent, and measured by the change in their QA scores either side.
+ *
+ * @module SupportModule
+ * @entity CoachingSession
+ * @schemaId d1cf0d88-2b19-4ae1-b565-8d1b04e50522
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ * Generated from Odin schema definition
+ */
+import { OdinRecord, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/core';
+import { QaEvaluationProperties } from './QaEvaluation';
+import { CaseProperties } from './Case';
+/**
+ * Available types for CoachingSession records
+ */
+export declare enum CoachingSessionEntityTypes {
+    /** This is the default record type */
+    DEFAULT = "DEFAULT"
+}
+/**
+ * Pipeline stage names for DEFAULT CoachingSession
+ * Pipeline: Coaching Session Pipeline
+ * Scheduled → Completed → Acknowledged, with Cancelled reachable from either live stage. Overdue is NOT a stage: it is Scheduled with DueAt in the past, derived at read time.
+ */
+export declare enum DefaultCoachingSessionStageNames {
+    /** Booked, not yet held. Reads as overdue wherever DueAt has passed. (default) */
+    Scheduled = "Scheduled",
+    /** The conversation happened and the coach recorded what was agreed. Not terminal — the agent has not yet confirmed understanding. */
+    Completed = "Completed",
+    /** The coached agent confirmed understanding. The success state, and the only one that shows the process actually worked. (success) */
+    Acknowledged = "Acknowledged",
+    /** The session will not happen. Excluded from the completion-rate denominator, so cancelling is never a way to improve the number. (fail) */
+    Cancelled = "Cancelled"
+}
+/**
+ * Pipeline stage keys for DEFAULT CoachingSession
+ * Use these keys when transitioning between stages
+ */
+export declare enum DefaultCoachingSessionStageKeys {
+    /** Booked, not yet held. Reads as overdue wherever DueAt has passed. */
+    CoachingSessionStageScheduled = "CoachingSessionStageScheduled",
+    /** The conversation happened and the coach recorded what was agreed. Not terminal — the agent has not yet confirmed understanding. */
+    CoachingSessionStageCompleted = "CoachingSessionStageCompleted",
+    /** The coached agent confirmed understanding. The success state, and the only one that shows the process actually worked. */
+    CoachingSessionStageAcknowledged = "CoachingSessionStageAcknowledged",
+    /** The session will not happen. Excluded from the completion-rate denominator, so cancelling is never a way to improve the number. */
+    CoachingSessionStageCancelled = "CoachingSessionStageCancelled"
+}
+/**
+ * Valid values for CoachingSession.FocusArea
+ *
+ * What the session is about, for reporting across a team.
+ *
+ * @remarks Available options:
+ * - `COMPLIANCE` - Compliance
+ * - `PROCESS` - Process
+ * - `SKILLS` - Skills
+ * - `SOFT_SKILLS` - Soft skills
+ */
+export declare enum CoachingSessionFocusArea {
+    COMPLIANCE = "COMPLIANCE",
+    PROCESS = "PROCESS",
+    SKILLS = "SKILLS",
+    SOFT_SKILLS = "SOFT_SKILLS"
+}
+/**
+ * Property keys for CoachingSession
+ * Use these constants instead of string literals for type safety
+ */
+export declare enum CoachingSessionPropertyKeys {
+    /** Point-in-time name of the coached agent. */
+    AgentName = "AgentName",
+    /** Who is running the session — the principal that created it. */
+    CoachId = "CoachId",
+    /** What the session is about, for reporting across a team. */
+    FocusArea = "FocusArea",
+    /** The coach’s commitment. A Scheduled session past this date reads as overdue — derived at read time, never stored as a stage. */
+    DueAt = "DueAt",
+    /** When the agent confirmed understanding. Only the coached agent can set it; a coach cannot acknowledge on their behalf. */
+    AgentAcknowledgedAt = "AgentAcknowledgedAt",
+    /** The evaluation that triggered the session, if any. Coaching can also be raised directly against a Case. */
+    SourceQaEvaluationId = "SourceQaEvaluationId",
+    /** Point-in-time name of the coach. */
+    CoachName = "CoachName",
+    /** The agent’s team when the session was created. */
+    TeamId = "TeamId",
+    /** Scorecard question ids that triggered the session, e.g. ["EMAIL.BEHAV.12"]. Ids rather than prose so recurring themes and repeat failures are countable across a team. */
+    Themes = "Themes",
+    /** When the conversation happened. The anchor for the effectiveness windows — the agent’s scores 30 days either side of this. */
+    CompletedAt = "CompletedAt",
+    /** The coached agent. Only this user may acknowledge the session. */
+    AgentId = "AgentId",
+    /** Why the session was raised, in the coach’s words. */
+    Reason = "Reason",
+    /** What the agent agreed to do differently. */
+    ActionItems = "ActionItems",
+    /** What good looks like next time — what the follow-up will be measured against. */
+    ExpectedOutcome = "ExpectedOutcome",
+    /** When the session is booked for. */
+    ScheduledAt = "ScheduledAt",
+    /** The previous session this one follows up, so a reassessment chain can be read end to end. */
+    FollowUpOfId = "FollowUpOfId"
+}
+/**
+ * Properties for CoachingSession records
+ *
+ * @see SupportModule:CoachingSession
+ */
+export interface CoachingSessionProperties {
+    /** Point-in-time name of the coached agent.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    AgentName: string;
+    /** Who is running the session — the principal that created it.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    CoachId: string;
+    /** What the session is about, for reporting across a team.
+     *
+     * @type {ENUM}
+     * @default
+     * @enum {CoachingSessionFocusArea}
+     */
+    FocusArea: CoachingSessionFocusArea;
+    /** The coach’s commitment. A Scheduled session past this date reads as overdue — derived at read time, never stored as a stage.
+     *
+     * @type {DATE_TIME}
+     * @default
+     */
+    DueAt: string;
+    /** When the agent confirmed understanding. Only the coached agent can set it; a coach cannot acknowledge on their behalf.
+     *
+     * @type {DATE_TIME}
+     * @default
+     */
+    AgentAcknowledgedAt: string;
+    /** The evaluation that triggered the session, if any. Coaching can also be raised directly against a Case.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    SourceQaEvaluationId: string;
+    /** Point-in-time name of the coach.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    CoachName: string;
+    /** The agent’s team when the session was created.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    TeamId: string;
+    /** Scorecard question ids that triggered the session, e.g. ["EMAIL.BEHAV.12"]. Ids rather than prose so recurring themes and repeat failures are countable across a team.
+     *
+     * @type {JSON}
+     * @default
+     */
+    Themes: string;
+    /** When the conversation happened. The anchor for the effectiveness windows — the agent’s scores 30 days either side of this.
+     *
+     * @type {DATE_TIME}
+     * @default
+     */
+    CompletedAt: string;
+    /** The coached agent. Only this user may acknowledge the session.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    AgentId: string;
+    /** Why the session was raised, in the coach’s words.
+     *
+     * @type {TEXT_LONG}
+     * @default
+     */
+    Reason: string;
+    /** What the agent agreed to do differently.
+     *
+     * @type {TEXT_LONG}
+     * @default
+     */
+    ActionItems: string;
+    /** What good looks like next time — what the follow-up will be measured against.
+     *
+     * @type {TEXT_LONG}
+     * @default
+     */
+    ExpectedOutcome: string;
+    /** When the session is booked for.
+     *
+     * @type {DATE_TIME}
+     * @default
+     */
+    ScheduledAt: string;
+    /** The previous session this one follows up, so a reassessment chain can be read end to end.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    FollowUpOfId: string;
+}
+/**
+ * CoachingSession entity from SupportModule
+ *
+ * One coaching conversation with one agent, normally created from a submitted QA evaluation. Tracked to completion, acknowledged by the agent, and measured by the change in their QA scores either side.
+ *
+ * @module SupportModule
+ * @entity CoachingSession
+ * @schemaId d1cf0d88-2b19-4ae1-b565-8d1b04e50522
+ * @recordPrefix COACH
+ * @capabilities searchable, updateable, undeletable, triggerable
+ */
+export declare class CoachingSession extends OdinRecord<CoachingSessionProperties> {
+    entity: 'SupportModule:CoachingSession';
+    type: CoachingSessionEntityTypes;
+    schemaId: 'd1cf0d88-2b19-4ae1-b565-8d1b04e50522';
+    properties: CoachingSessionProperties;
+    /** Linked QaEvaluation records (QaEvaluation__CoachingSession) */
+    QaEvaluation: OdinLink<LinkedOdinRecord<QaEvaluationProperties>>;
+    /** Linked Case records (Case__CoachingSession) */
+    Case: OdinLink<LinkedOdinRecord<CaseProperties>>;
+}
+/**
+ * RabbitMQ routing keys for CoachingSession events
+ */
+export declare const ROUTING_KEY_COACHING_SESSION_CREATED = "SupportModule.CoachingSession.SubDbRecordCreated";
+export declare const ROUTING_KEY_COACHING_SESSION_UPDATED = "SupportModule.CoachingSession.SubDbRecordUpdated";
+export declare const ROUTING_KEY_COACHING_SESSION_DELETED = "SupportModule.CoachingSession.SubDbRecordDeleted";
+/**
+ * Type-specific routing keys for CoachingSession events
+ * Subscribe to these for events on specific entity types only
+ */
+/** This is the default record type created */
+export declare const ROUTING_KEY_COACHING_SESSION_DEFAULT_CREATED = "SupportModule.CoachingSession.DEFAULT.SubDbRecordCreated";
+/** This is the default record type updated */
+export declare const ROUTING_KEY_COACHING_SESSION_DEFAULT_UPDATED = "SupportModule.CoachingSession.DEFAULT.SubDbRecordUpdated";
+/** This is the default record type deleted */
+export declare const ROUTING_KEY_COACHING_SESSION_DEFAULT_DELETED = "SupportModule.CoachingSession.DEFAULT.SubDbRecordDeleted";

package/dist/entities-v2/CoachingSession.js

@@ -0,0 +1,145 @@
+"use strict";
+/**
+ * CoachingSession Entity Definition
+ *
+ * One coaching conversation with one agent, normally created from a submitted QA evaluation. Tracked to completion, acknowledged by the agent, and measured by the change in their QA scores either side.
+ *
+ * @module SupportModule
+ * @entity CoachingSession
+ * @schemaId d1cf0d88-2b19-4ae1-b565-8d1b04e50522
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ * Generated from Odin schema definition
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ROUTING_KEY_COACHING_SESSION_DEFAULT_DELETED = exports.ROUTING_KEY_COACHING_SESSION_DEFAULT_UPDATED = exports.ROUTING_KEY_COACHING_SESSION_DEFAULT_CREATED = exports.ROUTING_KEY_COACHING_SESSION_DELETED = exports.ROUTING_KEY_COACHING_SESSION_UPDATED = exports.ROUTING_KEY_COACHING_SESSION_CREATED = exports.CoachingSession = exports.CoachingSessionPropertyKeys = exports.CoachingSessionFocusArea = exports.DefaultCoachingSessionStageKeys = exports.DefaultCoachingSessionStageNames = exports.CoachingSessionEntityTypes = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * Available types for CoachingSession records
+ */
+var CoachingSessionEntityTypes;
+(function (CoachingSessionEntityTypes) {
+    /** This is the default record type */
+    CoachingSessionEntityTypes["DEFAULT"] = "DEFAULT";
+})(CoachingSessionEntityTypes = exports.CoachingSessionEntityTypes || (exports.CoachingSessionEntityTypes = {}));
+/**
+ * Pipeline stage names for DEFAULT CoachingSession
+ * Pipeline: Coaching Session Pipeline
+ * Scheduled → Completed → Acknowledged, with Cancelled reachable from either live stage. Overdue is NOT a stage: it is Scheduled with DueAt in the past, derived at read time.
+ */
+var DefaultCoachingSessionStageNames;
+(function (DefaultCoachingSessionStageNames) {
+    /** Booked, not yet held. Reads as overdue wherever DueAt has passed. (default) */
+    DefaultCoachingSessionStageNames["Scheduled"] = "Scheduled";
+    /** The conversation happened and the coach recorded what was agreed. Not terminal — the agent has not yet confirmed understanding. */
+    DefaultCoachingSessionStageNames["Completed"] = "Completed";
+    /** The coached agent confirmed understanding. The success state, and the only one that shows the process actually worked. (success) */
+    DefaultCoachingSessionStageNames["Acknowledged"] = "Acknowledged";
+    /** The session will not happen. Excluded from the completion-rate denominator, so cancelling is never a way to improve the number. (fail) */
+    DefaultCoachingSessionStageNames["Cancelled"] = "Cancelled";
+})(DefaultCoachingSessionStageNames = exports.DefaultCoachingSessionStageNames || (exports.DefaultCoachingSessionStageNames = {}));
+/**
+ * Pipeline stage keys for DEFAULT CoachingSession
+ * Use these keys when transitioning between stages
+ */
+var DefaultCoachingSessionStageKeys;
+(function (DefaultCoachingSessionStageKeys) {
+    /** Booked, not yet held. Reads as overdue wherever DueAt has passed. */
+    DefaultCoachingSessionStageKeys["CoachingSessionStageScheduled"] = "CoachingSessionStageScheduled";
+    /** The conversation happened and the coach recorded what was agreed. Not terminal — the agent has not yet confirmed understanding. */
+    DefaultCoachingSessionStageKeys["CoachingSessionStageCompleted"] = "CoachingSessionStageCompleted";
+    /** The coached agent confirmed understanding. The success state, and the only one that shows the process actually worked. */
+    DefaultCoachingSessionStageKeys["CoachingSessionStageAcknowledged"] = "CoachingSessionStageAcknowledged";
+    /** The session will not happen. Excluded from the completion-rate denominator, so cancelling is never a way to improve the number. */
+    DefaultCoachingSessionStageKeys["CoachingSessionStageCancelled"] = "CoachingSessionStageCancelled";
+})(DefaultCoachingSessionStageKeys = exports.DefaultCoachingSessionStageKeys || (exports.DefaultCoachingSessionStageKeys = {}));
+/**
+ * Valid values for CoachingSession.FocusArea
+ *
+ * What the session is about, for reporting across a team.
+ *
+ * @remarks Available options:
+ * - `COMPLIANCE` - Compliance
+ * - `PROCESS` - Process
+ * - `SKILLS` - Skills
+ * - `SOFT_SKILLS` - Soft skills
+ */
+var CoachingSessionFocusArea;
+(function (CoachingSessionFocusArea) {
+    CoachingSessionFocusArea["COMPLIANCE"] = "COMPLIANCE";
+    CoachingSessionFocusArea["PROCESS"] = "PROCESS";
+    CoachingSessionFocusArea["SKILLS"] = "SKILLS";
+    CoachingSessionFocusArea["SOFT_SKILLS"] = "SOFT_SKILLS";
+})(CoachingSessionFocusArea = exports.CoachingSessionFocusArea || (exports.CoachingSessionFocusArea = {}));
+/**
+ * Property keys for CoachingSession
+ * Use these constants instead of string literals for type safety
+ */
+var CoachingSessionPropertyKeys;
+(function (CoachingSessionPropertyKeys) {
+    /** Point-in-time name of the coached agent. */
+    CoachingSessionPropertyKeys["AgentName"] = "AgentName";
+    /** Who is running the session — the principal that created it. */
+    CoachingSessionPropertyKeys["CoachId"] = "CoachId";
+    /** What the session is about, for reporting across a team. */
+    CoachingSessionPropertyKeys["FocusArea"] = "FocusArea";
+    /** The coach’s commitment. A Scheduled session past this date reads as overdue — derived at read time, never stored as a stage. */
+    CoachingSessionPropertyKeys["DueAt"] = "DueAt";
+    /** When the agent confirmed understanding. Only the coached agent can set it; a coach cannot acknowledge on their behalf. */
+    CoachingSessionPropertyKeys["AgentAcknowledgedAt"] = "AgentAcknowledgedAt";
+    /** The evaluation that triggered the session, if any. Coaching can also be raised directly against a Case. */
+    CoachingSessionPropertyKeys["SourceQaEvaluationId"] = "SourceQaEvaluationId";
+    /** Point-in-time name of the coach. */
+    CoachingSessionPropertyKeys["CoachName"] = "CoachName";
+    /** The agent’s team when the session was created. */
+    CoachingSessionPropertyKeys["TeamId"] = "TeamId";
+    /** Scorecard question ids that triggered the session, e.g. ["EMAIL.BEHAV.12"]. Ids rather than prose so recurring themes and repeat failures are countable across a team. */
+    CoachingSessionPropertyKeys["Themes"] = "Themes";
+    /** When the conversation happened. The anchor for the effectiveness windows — the agent’s scores 30 days either side of this. */
+    CoachingSessionPropertyKeys["CompletedAt"] = "CompletedAt";
+    /** The coached agent. Only this user may acknowledge the session. */
+    CoachingSessionPropertyKeys["AgentId"] = "AgentId";
+    /** Why the session was raised, in the coach’s words. */
+    CoachingSessionPropertyKeys["Reason"] = "Reason";
+    /** What the agent agreed to do differently. */
+    CoachingSessionPropertyKeys["ActionItems"] = "ActionItems";
+    /** What good looks like next time — what the follow-up will be measured against. */
+    CoachingSessionPropertyKeys["ExpectedOutcome"] = "ExpectedOutcome";
+    /** When the session is booked for. */
+    CoachingSessionPropertyKeys["ScheduledAt"] = "ScheduledAt";
+    /** The previous session this one follows up, so a reassessment chain can be read end to end. */
+    CoachingSessionPropertyKeys["FollowUpOfId"] = "FollowUpOfId";
+})(CoachingSessionPropertyKeys = exports.CoachingSessionPropertyKeys || (exports.CoachingSessionPropertyKeys = {}));
+/**
+ * CoachingSession entity from SupportModule
+ *
+ * One coaching conversation with one agent, normally created from a submitted QA evaluation. Tracked to completion, acknowledged by the agent, and measured by the change in their QA scores either side.
+ *
+ * @module SupportModule
+ * @entity CoachingSession
+ * @schemaId d1cf0d88-2b19-4ae1-b565-8d1b04e50522
+ * @recordPrefix COACH
+ * @capabilities searchable, updateable, undeletable, triggerable
+ */
+class CoachingSession extends core_1.OdinRecord {
+}
+exports.CoachingSession = CoachingSession;
+// ============================================
+// RABBITMQ EVENT ROUTING KEYS
+// ============================================
+/**
+ * RabbitMQ routing keys for CoachingSession events
+ */
+exports.ROUTING_KEY_COACHING_SESSION_CREATED = 'SupportModule.CoachingSession.SubDbRecordCreated';
+exports.ROUTING_KEY_COACHING_SESSION_UPDATED = 'SupportModule.CoachingSession.SubDbRecordUpdated';
+exports.ROUTING_KEY_COACHING_SESSION_DELETED = 'SupportModule.CoachingSession.SubDbRecordDeleted';
+/**
+ * Type-specific routing keys for CoachingSession events
+ * Subscribe to these for events on specific entity types only
+ */
+/** This is the default record type created */
+exports.ROUTING_KEY_COACHING_SESSION_DEFAULT_CREATED = 'SupportModule.CoachingSession.DEFAULT.SubDbRecordCreated';
+/** This is the default record type updated */
+exports.ROUTING_KEY_COACHING_SESSION_DEFAULT_UPDATED = 'SupportModule.CoachingSession.DEFAULT.SubDbRecordUpdated';
+/** This is the default record type deleted */
+exports.ROUTING_KEY_COACHING_SESSION_DEFAULT_DELETED = 'SupportModule.CoachingSession.DEFAULT.SubDbRecordDeleted';

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

@@ -23,12 +23,12 @@ export declare enum ConfigEntityTypes {
  * Use these constants instead of string literals for type safety
  */
 export declare enum ConfigPropertyKeys {
-    /** Data field for Config records. Used by Platform team. */
-    Test = "Test",
     /** the name of the app this config relates to (Platform - Config) */
     AppName = "AppName",
     /** object of { key: value } mappings (Platform - Config) */
-    Mappings = "Mappings"
+    Mappings = "Mappings",
+    /** Data field for Config records. Used by Platform team. */
+    Test = "Test"
 }
 /**
  * Properties for Config records
@@ -36,11 +36,6 @@ export declare enum ConfigPropertyKeys {
  * @see SchemaModule:Config
  */
 export interface ConfigProperties {
-    /** Data field for Config records. Used by Platform team.
-     *
-     * @type {TEXT}
-     */
-    Test: string;
     /** the name of the app this config relates to (Platform - Config)
      *
      * @type {TEXT}
@@ -51,6 +46,11 @@ export interface ConfigProperties {
      * @type {JSON}
      */
     Mappings: string;
+    /** Data field for Config records. Used by Platform team.
+     *
+     * @type {TEXT}
+     */
+    Test: string;
 }
 /**
  * Config entity from SchemaModule

package/dist/entities-v2/Config.js

@@ -28,12 +28,12 @@ var ConfigEntityTypes;
  */
 var ConfigPropertyKeys;
 (function (ConfigPropertyKeys) {
-    /** Data field for Config records. Used by Platform team. */
-    ConfigPropertyKeys["Test"] = "Test";
     /** the name of the app this config relates to (Platform - Config) */
     ConfigPropertyKeys["AppName"] = "AppName";
     /** object of { key: value } mappings (Platform - Config) */
     ConfigPropertyKeys["Mappings"] = "Mappings";
+    /** Data field for Config records. Used by Platform team. */
+    ConfigPropertyKeys["Test"] = "Test";
 })(ConfigPropertyKeys = exports.ConfigPropertyKeys || (exports.ConfigPropertyKeys = {}));
 /**
  * Config entity from SchemaModule