@pam-ai/pam-ordo-contracts 3.30.0 → 3.32.0

package/dist/generated.d.ts

@@ -243,6 +243,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/inbox/desktop-notification-settings": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read the authenticated User's effective desktop-notification setting
+         * @description Returns the selected rooftop's default, the caller's optional rooftop-specific override, and the effective value. A present User override wins over the rooftop default in both directions. Browser permission and device subscription state remain local browser concerns and do not change this product preference.
+         */
+        get: operations["getDesktopNotificationSettings"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/inbox/commands/create-customer": {
         parameters: {
             query?: never;
@@ -283,6 +303,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/inbox/commands/record-reach-out-call": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Open or reuse Ordo work after an accepted Reach Out call
+         * @description Records an outbound Reach Out call only after the telephony platform has accepted it and returned a stable callId. The canonical Customer must belong to the selected rooftop; a phone number or asserted actor is not accepted as identity. Ordo resolves or creates the Conversation and opens a WorkCycle assigned to the authenticated User only when no active cycle exists. An existing OPEN or SNOOZED cycle and its owner, including null, remain unchanged; this command never claims someone else's or an unassigned active cycle. This call-specific OPEN-cycle rule is an intentional exception to the outbound-text Reach Out lifecycle. Replays of the same sourceSystem and callId within the rooftop return the same result, even with a different operationId, without creating another cycle. A rejected or unaccepted dial must never call this endpoint. Requires CALL_CUSTOMER.
+         */
+        post: operations["recordReachOutCall"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/inbox/commands/assign": {
         parameters: {
             query?: never;
@@ -550,6 +590,60 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/inbox/commands/set-desktop-notification-preference": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Set or clear the authenticated User's rooftop-specific desktop-notification override */
+        post: operations["setDesktopNotificationPreference"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/inbox/commands/register-desktop-push-subscription": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Register or refresh an account-wide browser push subscription
+         * @description The authenticated User owns the subscription. It can deliver eligible notifications from every rooftop that User can currently access; rooftop and User preferences are still evaluated independently for each notification. An endpoint already owned by another User is never silently rebound.
+         */
+        post: operations["registerDesktopPushSubscription"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/inbox/commands/unregister-desktop-push-subscription": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Unregister the authenticated User's browser push subscription */
+        post: operations["unregisterDesktopPushSubscription"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/inbox/commands/resolve-mention": {
         parameters: {
             query?: never;
@@ -998,6 +1092,7 @@ export interface components {
             notifications: components["schemas"]["InboxPolicyNotificationRuleV1"][];
             customerMessageNotifications?: components["schemas"]["InboxPolicyCustomerMessageNotificationsV1"];
             emailDelivery?: components["schemas"]["InboxEmailDeliveryPolicyV1"];
+            webPushDelivery?: components["schemas"]["InboxWebPushDeliveryPolicyV1"];
             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. */
@@ -1014,6 +1109,12 @@ export interface components {
             activatedAt: string;
             kinds: components["schemas"]["NotificationKind"][];
         };
+        /** @description Optional forward-only rooftop default for desktop Web Push. Missing policy or enabled=false defaults delivery off. A User's explicit rooftop override wins over this value in either direction. Only notifications created at or after activatedAt are eligible. */
+        InboxWebPushDeliveryPolicyV1: {
+            enabled: boolean;
+            /** Format: date-time */
+            activatedAt: string;
+        };
         /** @enum {string} */
         RealtimeQueryAreaV1: "inbox" | "conversation" | "customer_notes" | "notifications";
         /** @description Refetch instruction, never canonical state. eventId deduplicates repeated delivery. aggregateVersion is only a hint for the named aggregate and must not suppress independent comment, note, label, or recipient changes. A scope-only invalidation deliberately omits Conversation and aggregate identity, including when a formerly visible Conversation is no longer authorized. Notification areas are recipient-only. No source payloads, message bodies, Customer information, or subscription credentials belong in this frame. */
@@ -1380,11 +1481,18 @@ export interface components {
                 nextCursor: string | null;
             };
         };
+        /**
+         * @description Source-verified terminal outcome. Transient ringing and an absent recording do not establish one; missing on an Interaction means unknown, not answered.
+         * @enum {string}
+         */
+        CallTerminalOutcomeV1: "answered" | "voicemail" | "missed" | "busy" | "no_answer";
         InteractionRef: {
             /** Format: uuid */
             id: string;
             /** @description Authenticated User who authored an internal comment; null for non-User senders. */
             senderUserId?: string | null;
+            /** @description Verified recipient of an inbound Customer call or voicemail on a direct staff line. This records the dialed-line recipient, not WorkCycle ownership; an existing owner is never reassigned merely because this User received a call. */
+            recipientUserId?: string | null;
             /**
              * Format: uuid
              * @description Root internal comment referenced by this comment. Replies are flattened to one level.
@@ -1418,6 +1526,8 @@ export interface components {
             repairOrder?: components["schemas"]["InteractionRepairOrderRefV1"] | null;
             sequenceNumber: number;
             kind: string;
+            /** @description Optional terminal outcome for a call or voicemail Interaction, carried from the source record. Older calls and sources without an authoritative outcome omit it. A reader must not infer answered from absence or from the Interaction kind alone. */
+            callOutcome?: components["schemas"]["CallTerminalOutcomeV1"];
             channel?: string | null;
             /** @enum {string} */
             direction: "INBOUND" | "OUTBOUND" | "INTERNAL";
@@ -1621,7 +1731,7 @@ export interface components {
             };
         };
         /** @enum {string} */
-        NotificationKind: "reminder_due" | "customer_message" | "mention" | "internal_comment_reply" | "needs_attention" | "overdue" | "ro_opened" | "ro_closed";
+        NotificationKind: "reminder_due" | "customer_message" | "customer_call" | "mention" | "internal_comment_reply" | "needs_attention" | "overdue" | "ro_opened" | "ro_closed";
         /** @description Recipient-specific Ordo alert state. Opening or dismissing it never resolves domain work. */
         InboxNotification: {
             /** Format: uuid */
@@ -1805,8 +1915,10 @@ export interface components {
             senderUserExternalId?: string;
             /** @enum {string} */
             lineType?: "pam" | "rooftop" | "advisor";
-            /** @description Verified recipient advisor User for an inbound Customer SMS to an advisor-owned line. This is not the sender and must be resolved within clientOrgId before routing. */
+            /** @description Source-verified recipient advisor User for an inbound Customer SMS, call, or voicemail received on an advisor-owned line. This is not the sender and must be resolved within clientOrgId before direct routing. Producers must omit it when line ownership cannot be verified; a phone number or unverified display name is not authority for this identity. */
             recipientUserExternalId?: string;
+            /** @description Optional terminal telephony outcome for kind call or voicemail. Producers must not infer it from a transient ringing state or from an absent recording. Missing means outcome was not authoritatively established, not that the call was answered. Existing voicemail producers may omit it during the additive rollout. */
+            callOutcome?: components["schemas"]["CallTerminalOutcomeV1"];
             dynamoLocator?: components["schemas"]["ProducerDynamoLocatorV1"];
         };
         ProducerRepairOrderTransitionV1: {
@@ -2108,6 +2220,32 @@ export interface components {
             /** @description Opaque continuation cursor from the immediately preceding page. */
             cursor?: string;
         };
+        SetDesktopNotificationPreferenceCommand: {
+            operationId: string;
+            clientOrgId: string;
+            /** @description Explicit User setting, or null to inherit the rooftop default. */
+            override: boolean | null;
+        };
+        WebPushSubscriptionKeys: {
+            p256dh: string;
+            auth: string;
+        };
+        RegisterDesktopPushSubscriptionCommand: {
+            operationId: string;
+            clientOrgId: string;
+            subscription: {
+                /** Format: uri */
+                endpoint: string;
+                expirationTime: number | null;
+                keys: components["schemas"]["WebPushSubscriptionKeys"];
+            };
+        };
+        UnregisterDesktopPushSubscriptionCommand: {
+            operationId: string;
+            clientOrgId: string;
+            /** Format: uri */
+            endpoint: string;
+        };
         /**
          * @description Mark the caller's outstanding Mentions on one WorkCycle dealt with.
          *     CONVERSATION-WIDE, NOT PER-MENTION, and the shape is the point. A recipient does not think in Mentions; they think "I have handled this thread". Two colleagues naming the same person in one exchange raises two Mentions, and clearing one of them would leave the row on the Mentions list with nothing on screen to explain why.
@@ -2350,6 +2488,48 @@ export interface components {
                 ownershipDisposition: components["schemas"]["OutboundMessageOwnershipDisposition"];
             };
         };
+        ReachOutCallSource: {
+            /**
+             * @description Typed authority for the accepted call identifier.
+             * @constant
+             */
+            sourceSystem: "comms_platform";
+            /** @description Stable telephony call ID, not a freshly generated command ID. */
+            callId: string;
+            /**
+             * Format: date-time
+             * @description Telephony platform's accepted-call timestamp when supplied; otherwise the time its successful initiate response was observed. Never the time of the dial request or a rejected attempt.
+             */
+            acceptedAt: string;
+        };
+        RecordReachOutCallCommand: {
+            operationId: string;
+            clientOrgId: string;
+            customer: components["schemas"]["InboxCustomerIdentity"];
+            /**
+             * Format: uuid
+             * @description The Conversation observed by the caller, or null when contact search reported NONE. Ordo revalidates it against the canonical Customer.
+             */
+            conversationId: string | null;
+            call: components["schemas"]["ReachOutCallSource"];
+        };
+        RecordReachOutCallResult: {
+            data: {
+                operationId: string;
+                applied: boolean;
+                replayed: boolean;
+                callId: string;
+                /** Format: uuid */
+                conversationId: string;
+                conversationCreated: boolean;
+                /** Format: uuid */
+                workCycleId: string;
+                workCycleCreated: boolean;
+                /** @description Authenticated caller for a newly opened cycle, or the preserved owner of an existing active cycle. Null is possible when an existing active cycle was unassigned; the call never claims it. */
+                ownerUserId: string | null;
+                resultingVersion: number;
+            };
+        };
         CommandResult: {
             data: {
                 operationId: string;
@@ -2451,6 +2631,41 @@ export interface components {
                 nextCursor: string | null;
             };
         };
+        DesktopNotificationSettingsResponse: {
+            data: {
+                clientOrgId: string;
+                rooftopDefaultEnabled: boolean;
+                userOverride: boolean | null;
+                effectiveEnabled: boolean;
+                /** Format: date-time */
+                activatedAt: string | null;
+                vapidPublicKey: string;
+            };
+        };
+        DesktopNotificationPreferenceResult: {
+            data: {
+                operationId: string;
+                applied: boolean;
+                replayed: boolean;
+                clientOrgId: string;
+                rooftopDefaultEnabled: boolean;
+                userOverride: boolean | null;
+                effectiveEnabled: boolean;
+            };
+        };
+        DesktopPushSubscriptionResult: {
+            data: {
+                operationId: string;
+                applied: boolean;
+                replayed: boolean;
+                /**
+                 * Format: uuid
+                 * @description Existing subscription identity, or null when unregistration was a no-op.
+                 */
+                subscriptionId: string | null;
+                active: boolean;
+            };
+        };
         ErrorEnvelope: {
             error: {
                 code: string;
@@ -2553,6 +2768,36 @@ export interface components {
                 "application/json": components["schemas"]["DismissNotificationsResult"];
             };
         };
+        /** @description Applied or idempotently replayed desktop-notification preference. */
+        DesktopNotificationPreferenceApplied: {
+            headers: {
+                "x-correlation-id": components["headers"]["CorrelationId"];
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["DesktopNotificationPreferenceResult"];
+            };
+        };
+        /** @description Registered, refreshed, or idempotently replayed browser subscription. */
+        DesktopPushSubscriptionRegistered: {
+            headers: {
+                "x-correlation-id": components["headers"]["CorrelationId"];
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["DesktopPushSubscriptionResult"];
+            };
+        };
+        /** @description Unregistered or idempotently replayed browser subscription. */
+        DesktopPushSubscriptionUnregistered: {
+            headers: {
+                "x-correlation-id": components["headers"]["CorrelationId"];
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["DesktopPushSubscriptionResult"];
+            };
+        };
         /** @description Created or idempotently replayed canonical Customer result. */
         InboxCustomerCreated: {
             headers: {
@@ -2573,6 +2818,16 @@ export interface components {
                 "application/json": components["schemas"]["SendInboxMessageResult"];
             };
         };
+        /** @description Applied or idempotently replayed accepted Reach Out call result. */
+        ReachOutCallRecorded: {
+            headers: {
+                "x-correlation-id": components["headers"]["CorrelationId"];
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["RecordReachOutCallResult"];
+            };
+        };
         /** @description Invalid input. */
         BadRequest: {
             headers: {
@@ -2735,6 +2990,21 @@ export interface components {
                 "application/json": components["schemas"]["DismissNotificationsCommand"];
             };
         };
+        SetDesktopNotificationPreferenceCommand: {
+            content: {
+                "application/json": components["schemas"]["SetDesktopNotificationPreferenceCommand"];
+            };
+        };
+        RegisterDesktopPushSubscriptionCommand: {
+            content: {
+                "application/json": components["schemas"]["RegisterDesktopPushSubscriptionCommand"];
+            };
+        };
+        UnregisterDesktopPushSubscriptionCommand: {
+            content: {
+                "application/json": components["schemas"]["UnregisterDesktopPushSubscriptionCommand"];
+            };
+        };
         CreateInboxCustomerCommand: {
             content: {
                 "application/json": components["schemas"]["CreateInboxCustomerCommand"];
@@ -2745,6 +3015,11 @@ export interface components {
                 "application/json": components["schemas"]["SendInboxMessageCommand"];
             };
         };
+        RecordReachOutCallCommand: {
+            content: {
+                "application/json": components["schemas"]["RecordReachOutCallCommand"];
+            };
+        };
     };
     headers: {
         /** @description Stable request correlation identifier. */
@@ -3254,6 +3529,34 @@ export interface operations {
             503: components["responses"]["ServiceUnavailable"];
         };
     };
+    getDesktopNotificationSettings: {
+        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 Effective desktop-notification settings for the selected rooftop. */
+            200: {
+                headers: {
+                    "x-correlation-id": components["headers"]["CorrelationId"];
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DesktopNotificationSettingsResponse"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            500: components["responses"]["InternalError"];
+            503: components["responses"]["ServiceUnavailable"];
+        };
+    };
     createInboxCustomer: {
         parameters: {
             query?: never;
@@ -3297,6 +3600,28 @@ export interface operations {
             503: components["responses"]["ServiceUnavailable"];
         };
     };
+    recordReachOutCall: {
+        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: components["requestBodies"]["RecordReachOutCallCommand"];
+        responses: {
+            200: components["responses"]["ReachOutCallRecorded"];
+            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"];
+        };
+    };
     assignConversation: {
         parameters: {
             query?: never;
@@ -3641,6 +3966,69 @@ export interface operations {
             503: components["responses"]["ServiceUnavailable"];
         };
     };
+    setDesktopNotificationPreference: {
+        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: components["requestBodies"]["SetDesktopNotificationPreferenceCommand"];
+        responses: {
+            200: components["responses"]["DesktopNotificationPreferenceApplied"];
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            409: components["responses"]["Conflict"];
+            500: components["responses"]["InternalError"];
+            503: components["responses"]["ServiceUnavailable"];
+        };
+    };
+    registerDesktopPushSubscription: {
+        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: components["requestBodies"]["RegisterDesktopPushSubscriptionCommand"];
+        responses: {
+            200: components["responses"]["DesktopPushSubscriptionRegistered"];
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            409: components["responses"]["Conflict"];
+            500: components["responses"]["InternalError"];
+            503: components["responses"]["ServiceUnavailable"];
+        };
+    };
+    unregisterDesktopPushSubscription: {
+        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: components["requestBodies"]["UnregisterDesktopPushSubscriptionCommand"];
+        responses: {
+            200: components["responses"]["DesktopPushSubscriptionUnregistered"];
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            409: components["responses"]["Conflict"];
+            500: components["responses"]["InternalError"];
+            503: components["responses"]["ServiceUnavailable"];
+        };
+    };
     resolveInboxMentions: {
         parameters: {
             query?: never;