@pam-ai/pam-ordo-contracts 3.31.0 → 3.33.0

package/dist/generated.d.ts

@@ -303,6 +303,46 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/inbox/commands/open-contact-conversation": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Open or create a Customer's canonical Conversation without opening work
+         * @description Resolves the canonical same-rooftop Conversation for a Customer selected from Reach out, creating an empty Conversation only when none exists. This is navigation provisioning, not a lifecycle mutation: it creates no WorkCycle, assignment, Interaction, notification, or unread activity and never changes an existing owner. The optional conversationId is the value observed in contact search and is revalidated against the canonical Customer before use. Requires VIEW_CUSTOMER_DIRECTORY.
+         */
+        post: operations["openInboxContactConversation"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        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;
@@ -1461,11 +1501,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.
@@ -1499,6 +1546,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";
@@ -1702,7 +1751,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 */
@@ -1886,8 +1935,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: {
@@ -2438,6 +2489,26 @@ export interface components {
             attachments?: components["schemas"]["OutboundAttachmentV1"][];
             ownershipDisposition: components["schemas"]["OutboundMessageOwnershipDisposition"];
         };
+        OpenInboxContactConversationCommand: {
+            operationId: string;
+            clientOrgId: string;
+            customer: components["schemas"]["InboxCustomerIdentity"];
+            /**
+             * Format: uuid
+             * @description The Conversation observed by contact search, or null when the row reported NONE. Ordo revalidates it against the canonical Customer and safely finds or creates the Conversation under its tenant lock.
+             */
+            conversationId: string | null;
+        };
+        OpenInboxContactConversationResult: {
+            data: {
+                operationId: string;
+                applied: boolean;
+                replayed: boolean;
+                /** Format: uuid */
+                conversationId: string;
+                conversationCreated: boolean;
+            };
+        };
         /** @enum {string} */
         OutboundMessageDeliveryState: "PENDING" | "ACCEPTED" | "FAILED" | "UNKNOWN";
         SendInboxMessageResult: {
@@ -2457,6 +2528,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;
@@ -2745,6 +2858,26 @@ export interface components {
                 "application/json": components["schemas"]["SendInboxMessageResult"];
             };
         };
+        /** @description Resolved, created, or idempotently replayed canonical Conversation result. */
+        InboxContactConversationOpened: {
+            headers: {
+                "x-correlation-id": components["headers"]["CorrelationId"];
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["OpenInboxContactConversationResult"];
+            };
+        };
+        /** @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: {
@@ -2932,6 +3065,16 @@ export interface components {
                 "application/json": components["schemas"]["SendInboxMessageCommand"];
             };
         };
+        OpenInboxContactConversationCommand: {
+            content: {
+                "application/json": components["schemas"]["OpenInboxContactConversationCommand"];
+            };
+        };
+        RecordReachOutCallCommand: {
+            content: {
+                "application/json": components["schemas"]["RecordReachOutCallCommand"];
+            };
+        };
     };
     headers: {
         /** @description Stable request correlation identifier. */
@@ -3377,8 +3520,8 @@ export interface operations {
                 sort?: "NAME" | "RECENT_REPAIR_ORDER";
                 /** @description Opaque keyset cursor. Present because a browse is not bounded the way a search is: a busy rooftop can carry several hundred open repair orders, and a limit alone would silently truncate the answer. */
                 cursor?: string;
-                /** @description Which side of the directory to read. MINE returns only Customers whose Conversation the reader owns; EVERYONE returns the rest. One set is always in the way of the other, so this is a switch rather than a filter. */
-                relationship?: "MINE" | "EVERYONE";
+                /** @description Which side of the directory to read. MINE returns only Customers whose Conversation the reader owns; EVERYONE returns the rest. ALL returns both sides in one page while preserving each row's relationship, so a picker can partition a single consistent result without issuing duplicate upstream directory searches. */
+                relationship?: "MINE" | "EVERYONE" | "ALL";
                 limit?: number;
             };
             header: {
@@ -3512,6 +3655,50 @@ export interface operations {
             503: components["responses"]["ServiceUnavailable"];
         };
     };
+    openInboxContactConversation: {
+        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"]["OpenInboxContactConversationCommand"];
+        responses: {
+            200: components["responses"]["InboxContactConversationOpened"];
+            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"];
+        };
+    };
+    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;