@pam-ai/pam-ordo-contracts 3.23.0 → 3.24.0

package/dist/generated.d.ts

@@ -3,6 +3,62 @@
  * Do not make direct changes to the file.
  */
 export interface paths {
+    "/v1/inbox/staff-work-status/self": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Read the authenticated staff member's effective work status */
+        get: operations["getInboxStaffWorkStatus"];
+        /** Set the authenticated staff member's bounded work-status override */
+        put: operations["setInboxStaffWorkStatus"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/inbox/staff-schedules/{userId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Read one rooftop staff schedule */
+        get: operations["getInboxStaffSchedule"];
+        /** Replace one staff member's weekly rota and dated exceptions */
+        put: operations["setInboxStaffSchedule"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/inbox/assignment-candidates": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List rooftop staff with authoritative work status for assignment
+         * @description Returns the active rooftop roster from Permissions with effective work status. A scheduled shift is display context only and never implies AVAILABLE. Only a current explicit AVAILABLE self status may set assignmentCandidate true. Cursors are opaque and UNKNOWN or stale authority is always excluded.
+         */
+        get: operations["listInboxAssignmentCandidates"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/inbox/realtime-session": {
         parameters: {
             query?: never;
@@ -530,6 +586,158 @@ export interface components {
         InboxScope: "MY_INBOX" | "TEAM_INBOX" | "MENTIONS" | "CUSTOMERS" | "RO";
         /** @enum {string} */
         WorkCycleStatus: "OPEN" | "SNOOZED" | "RESOLVED";
+        /**
+         * @description Effective staff state owned by Permissions. AVAILABLE is reserved for a current explicit self override; being scheduled is not availability.
+         * @enum {string}
+         */
+        StaffWorkStatus: "AVAILABLE" | "ON_BREAK" | "OFF_FOR_DAY" | "OFF_SHIFT" | "UNKNOWN";
+        /** @enum {string} */
+        StaffWorkStatusSource: "SELF_OVERRIDE" | "DATE_EXCEPTION" | "WEEKLY_ROTA" | "NO_SCHEDULE" | "STALE_SCHEDULE";
+        StaffShiftWindow: {
+            /** Format: date */
+            date: string;
+            /** Format: date-time */
+            startAt: string;
+            /** Format: date-time */
+            endAt: string;
+        };
+        StaffWorkStatusSnapshot: {
+            clientOrgId: string;
+            userId: string;
+            status: components["schemas"]["StaffWorkStatus"];
+            source: components["schemas"]["StaffWorkStatusSource"];
+            /** Format: date-time */
+            observedAt: string;
+            /** @description The instant after which this answer must be recomputed. Null is allowed only for UNKNOWN. */
+            expiresAt: string | null;
+            scheduleVersion: number | null;
+            reason: string | null;
+            todayShift: components["schemas"]["StaffShiftWindow"] | null;
+        };
+        StaffAssignmentCandidate: {
+            clientOrgId: string;
+            userId: string;
+            status: components["schemas"]["StaffWorkStatus"];
+            source: components["schemas"]["StaffWorkStatusSource"];
+            /** Format: date-time */
+            observedAt: string;
+            expiresAt: string | null;
+            scheduleVersion: number | null;
+            reason: string | null;
+            todayShift: components["schemas"]["StaffShiftWindow"] | null;
+            displayName: components["schemas"]["HydratedText"];
+            persona: string | null;
+            department: ("SERVICE" | "BDC") | null;
+            teamIds: string[];
+            /** @description Active rooftop/capability eligibility for a deliberate User assignment. */
+            manualAssignmentEligible: boolean;
+            /** @description True only when manual eligibility and a current explicit AVAILABLE status both hold. */
+            automaticAssignmentEligible: boolean;
+            exclusionReason: string | null;
+        };
+        StaffAssignmentCandidatesResponse: {
+            data: {
+                /** Format: date-time */
+                observedAt: string;
+                candidates: components["schemas"]["StaffAssignmentCandidate"][];
+                nextCursor: string | null;
+            };
+        };
+        StaffWorkStatusSelfCommand: {
+            clientOrgId: string;
+            /** @enum {string} */
+            status: "AVAILABLE" | "ON_BREAK" | "OFF_FOR_DAY";
+            /** @enum {integer} */
+            breakDurationMinutes?: 15 | 30 | 60;
+            expectedVersion: number;
+            reason?: string;
+        } & unknown;
+        StaffWorkStatusSelfResult: {
+            data: {
+                overrideVersion: number;
+                workStatus: components["schemas"]["StaffWorkStatusSnapshot"];
+            };
+        };
+        StaffLocalTimeInterval: {
+            start: string;
+            end: string;
+        };
+        StaffWeeklyRota: {
+            MONDAY: components["schemas"]["StaffDayIntervals"];
+            TUESDAY: components["schemas"]["StaffDayIntervals"];
+            WEDNESDAY: components["schemas"]["StaffDayIntervals"];
+            THURSDAY: components["schemas"]["StaffDayIntervals"];
+            FRIDAY: components["schemas"]["StaffDayIntervals"];
+            SATURDAY: components["schemas"]["StaffDayIntervals"];
+            SUNDAY: components["schemas"]["StaffDayIntervals"];
+        };
+        StaffDayIntervals: components["schemas"]["StaffLocalTimeInterval"][];
+        StaffScheduleException: {
+            /** Format: date */
+            date: string;
+            /** @enum {string} */
+            kind: "WORKING" | "OFF";
+            intervals: components["schemas"]["StaffDayIntervals"];
+            reason: string | null;
+        };
+        StaffSchedule: {
+            clientOrgId: string;
+            userId: string;
+            version: number;
+            timezone: string;
+            /** Format: date */
+            effectiveFrom: string;
+            /** Format: date-time */
+            expiresAt: string;
+            weeklyRota: components["schemas"]["StaffWeeklyRota"];
+            dateExceptions: components["schemas"]["StaffScheduleException"][];
+            /** Format: date-time */
+            updatedAt: string;
+        };
+        StaffScheduleCommand: {
+            clientOrgId: string;
+            expectedVersion: number;
+            timezone: string;
+            /** Format: date */
+            effectiveFrom: string;
+            /** Format: date-time */
+            expiresAt: string;
+            weeklyRota: components["schemas"]["StaffWeeklyRota"];
+            dateExceptions: components["schemas"]["StaffScheduleException"][];
+        };
+        StaffScheduleResult: {
+            data: components["schemas"]["StaffSchedule"];
+        };
+        StaffRosterCandidateRequestV1: {
+            /** @constant */
+            schemaVersion: 1;
+            /** @constant */
+            mode: "ROSTER";
+            clientOrgId: string;
+            cursor?: string;
+            limit: number;
+        };
+        StaffExactCandidateRequestV1: {
+            /** @constant */
+            schemaVersion: 1;
+            /** @constant */
+            mode: "EXACT";
+            clientOrgId: string;
+            userIds: string[];
+        };
+        StaffAssignmentCandidateRequestV1: components["schemas"]["StaffRosterCandidateRequestV1"] | components["schemas"]["StaffExactCandidateRequestV1"];
+        /** @description For ROSTER requests, results retain the authority's stable roster page order and nextCursor is the opaque continuation cursor or null at completion. For EXACT requests, results are a unique subset of the requested User IDs in request order; an unresolved or ineligible User may be omitted, and nextCursor must be null. */
+        StaffAssignmentCandidateResponseV1: {
+            /** @constant */
+            schemaVersion: 1;
+            clientOrgId: string;
+            /** Format: date-time */
+            observedAt: string;
+            /** @description Candidate rows in stable roster order for ROSTER mode, or a unique request-ordered subset for EXACT mode. */
+            results: components["schemas"]["StaffAssignmentCandidate"][];
+            /** @description Opaque ROSTER continuation cursor; always null for EXACT mode. */
+            nextCursor: string | null;
+        };
         /** @enum {string} */
         AvailabilityState: "available" | "missing" | "stale" | "timeout" | "unauthorized" | "unsupported";
         Availability: {
@@ -741,6 +949,14 @@ export interface components {
             notifications: components["schemas"]["InboxPolicyNotificationRuleV1"][];
             customerMessageNotifications?: components["schemas"]["InboxPolicyCustomerMessageNotificationsV1"];
             emailDelivery?: components["schemas"]["InboxEmailDeliveryPolicyV1"];
+            staffWorkStatus?: components["schemas"]["InboxPolicyStaffWorkStatusV1"];
+        };
+        /** @description Rooftop activation for authoritative Permissions work status. Missing is normalized as DISPLAY_ONLY. SHADOW records the decision without changing routing; ENFORCED may exclude non-AVAILABLE Users from automatic routing. Manual assignment continues to use manualAssignmentEligible. */
+        InboxPolicyStaffWorkStatusV1: {
+            /** @enum {string} */
+            mode: "DISPLAY_ONLY" | "SHADOW" | "ENFORCED";
+            /** Format: date-time */
+            activatedAt: string;
         };
         /** @description Optional email-only delivery policy, separate from notification creation and recipient selection. Missing policy or enabled=false sends no email. Only notifications created at or after activatedAt are eligible. An empty kinds array opts into nothing. Reading, dismissal, and source resolution do not suppress an otherwise authorized send. Current disablement is a kill switch for unsent work; unknown send outcomes require reconciliation. */
         InboxEmailDeliveryPolicyV1: {
@@ -2177,6 +2393,7 @@ export interface components {
         /** @description Authorized rooftop context. For commands this value must match body.clientOrgId; neither value is trusted without DASH-233 resolution. */
         ClientOrgId: string;
         ConversationId: string;
+        StaffUserId: string;
     };
     requestBodies: {
         BaseCommand: {
@@ -2273,6 +2490,163 @@ export interface components {
 }
 export type $defs = Record<string, never>;
 export interface operations {
+    getInboxStaffWorkStatus: {
+        parameters: {
+            query?: never;
+            header: {
+                /** @description Authorized rooftop context. For commands this value must match body.clientOrgId; neither value is trusted without DASH-233 resolution. */
+                "x-client-org-id": components["parameters"]["ClientOrgId"];
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Current self status and today's authoritative schedule window. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["StaffWorkStatusSelfResult"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            500: components["responses"]["InternalError"];
+            503: components["responses"]["ServiceUnavailable"];
+        };
+    };
+    setInboxStaffWorkStatus: {
+        parameters: {
+            query?: never;
+            header: {
+                /** @description Authorized rooftop context. For commands this value must match body.clientOrgId; neither value is trusted without DASH-233 resolution. */
+                "x-client-org-id": components["parameters"]["ClientOrgId"];
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["StaffWorkStatusSelfCommand"];
+            };
+        };
+        responses: {
+            /** @description Applied self status with server-derived expiry. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["StaffWorkStatusSelfResult"];
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            409: components["responses"]["Conflict"];
+            500: components["responses"]["InternalError"];
+            503: components["responses"]["ServiceUnavailable"];
+        };
+    };
+    getInboxStaffSchedule: {
+        parameters: {
+            query?: never;
+            header: {
+                /** @description Authorized rooftop context. For commands this value must match body.clientOrgId; neither value is trusted without DASH-233 resolution. */
+                "x-client-org-id": components["parameters"]["ClientOrgId"];
+            };
+            path: {
+                userId: components["parameters"]["StaffUserId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Manager-authorized staff schedule. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["StaffScheduleResult"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            500: components["responses"]["InternalError"];
+            503: components["responses"]["ServiceUnavailable"];
+        };
+    };
+    setInboxStaffSchedule: {
+        parameters: {
+            query?: never;
+            header: {
+                /** @description Authorized rooftop context. For commands this value must match body.clientOrgId; neither value is trusted without DASH-233 resolution. */
+                "x-client-org-id": components["parameters"]["ClientOrgId"];
+            };
+            path: {
+                userId: components["parameters"]["StaffUserId"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["StaffScheduleCommand"];
+            };
+        };
+        responses: {
+            /** @description Applied schedule snapshot. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["StaffScheduleResult"];
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            409: components["responses"]["Conflict"];
+            500: components["responses"]["InternalError"];
+            503: components["responses"]["ServiceUnavailable"];
+        };
+    };
+    listInboxAssignmentCandidates: {
+        parameters: {
+            query?: {
+                cursor?: string;
+                limit?: number;
+            };
+            header: {
+                /** @description Authorized rooftop context. For commands this value must match body.clientOrgId; neither value is trusted without DASH-233 resolution. */
+                "x-client-org-id": components["parameters"]["ClientOrgId"];
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Bounded active rooftop staff page and effective work status. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["StaffAssignmentCandidatesResponse"];
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            500: components["responses"]["InternalError"];
+            503: components["responses"]["ServiceUnavailable"];
+        };
+    };
     createInboxRealtimeSession: {
         parameters: {
             query?: never;