@stigmer/protos 3.5.3 → 3.7.0

package/ai/stigmer/agentic/agentchannel/v1/conversation_io_pb.d.ts

@@ -0,0 +1,541 @@
+import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv1";
+import type { ChannelDeliveryStatus } from "./delivery_pb.js";
+import type { ChannelOutboundPayload } from "./message_io_pb.js";
+import type { ChannelOutboundOrigin, ChannelReceiptState } from "./outbound_pb.js";
+import type { PageInfo } from "../../../commons/rpc/pagination_pb.js";
+import type { Timestamp } from "@bufbuild/protobuf/wkt";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file ai/stigmer/agentic/agentchannel/v1/conversation_io.proto.
+ */
+export declare const file_ai_stigmer_agentic_agentchannel_v1_conversation_io: GenFile;
+/**
+ * ChannelConversation is the durable identity and participation state of
+ * one channel conversation: one external customer on one agent channel,
+ * spanning sessions.
+ *
+ * @internal
+ * channel-conversations DD-001/DD-003: the Conversation aggregate.
+ * Infrastructure aggregate — no kind, no apiVersion (the ChannelDelivery
+ * posture) — but WITH a public query/command surface, because the console
+ * reads conversations and operates the control token (the
+ * ChannelMessageQueryController precedent for channel-scoped public RPCs
+ * without a kind). Identity is (agent_channel_id, conversation_key), the
+ * same key channel_conversation_binding anchors (DD-013 of
+ * agent-channel-integrations); the binding stays a separate aggregate (the
+ * session pointer) and never carries participation state. Field ownership
+ * is single-writer per DD-003 D-c; last_activity_at is the documented
+ * commutative-max exception.
+ *
+ * @generated from message ai.stigmer.agentic.agentchannel.v1.ChannelConversation
+ */
+export type ChannelConversation = Message<"ai.stigmer.agentic.agentchannel.v1.ChannelConversation"> & {
+    /**
+     * AgentChannel connection this conversation belongs to.
+     *
+     * @generated from field: string agent_channel_id = 1;
+     */
+    agentChannelId: string;
+    /**
+     * Provider-neutral conversation key (WhatsApp: the customer's wa_id).
+     *
+     * @generated from field: string conversation_key = 2;
+     */
+    conversationKey: string;
+    /**
+     * Organization that owns the channel.
+     *
+     * @internal
+     * Denormalized from the channel (its metadata.org) so the org-wide
+     * list never joins — the schedule_fire.org precedent.
+     *
+     * @generated from field: string org = 3;
+     */
+    org: string;
+    /**
+     * Who may speak to the customer right now. Defaults to the agent.
+     *
+     * @generated from field: ai.stigmer.agentic.agentchannel.v1.ConversationControl control = 4;
+     */
+    control: ConversationControl;
+    /**
+     * Identity account holding control when control is control_human.
+     *
+     * @generated from field: string controlled_by = 5;
+     */
+    controlledBy: string;
+    /**
+     * When control last changed hands.
+     *
+     * @generated from field: google.protobuf.Timestamp control_changed_at = 6;
+     */
+    controlChangedAt?: Timestamp;
+    /**
+     * True when the conversation is flagged for human attention.
+     *
+     * @internal
+     * DD-008 D-e: a projection of the latest escalation event, updated by
+     * the participation writer in the same motion that appends the event.
+     * Orthogonal to control (DD-002 D-a #4): takeover clears it, handback
+     * never touches it.
+     *
+     * @generated from field: bool needs_attention = 7;
+     */
+    needsAttention: boolean;
+    /**
+     * Why the conversation needs attention, in the escalating agent's words.
+     *
+     * @generated from field: string attention_reason = 8;
+     */
+    attentionReason: string;
+    /**
+     * When the attention flag last changed.
+     *
+     * @generated from field: google.protobuf.Timestamp attention_changed_at = 9;
+     */
+    attentionChangedAt?: Timestamp;
+    /**
+     * Customer display name as the provider reports it (WhatsApp:
+     * contacts[].profile.name). Empty until an inbound message carries one.
+     *
+     * @generated from field: string display_name = 10;
+     */
+    displayName: string;
+    /**
+     * When the customer last sent a message.
+     *
+     * @generated from field: google.protobuf.Timestamp last_customer_message_at = 11;
+     */
+    lastCustomerMessageAt?: Timestamp;
+    /**
+     * When anything last happened on the conversation, across all lanes.
+     *
+     * @generated from field: google.protobuf.Timestamp last_activity_at = 12;
+     */
+    lastActivityAt?: Timestamp;
+};
+/**
+ * Describes the message ai.stigmer.agentic.agentchannel.v1.ChannelConversation.
+ * Use `create(ChannelConversationSchema)` to create a new message.
+ */
+export declare const ChannelConversationSchema: GenMessage<ChannelConversation>;
+/**
+ * ConversationTimelineItem is one entry in a conversation's timeline.
+ *
+ * @internal
+ * channel-conversations DD-004: computed on read by stitching four
+ * stores — inbound webhook events, reply deliveries (rendered from the
+ * same extraction the delivery posted, never from execution transcripts),
+ * the outbound ledger, and the internal-lane event store (joined at T03
+ * Sitting 4). item_id is source-prefixed ("wa:", "dl:", "ob:", "ev:"),
+ * which makes cross-store collisions structurally impossible and gives
+ * cursors a total order without a synthetic sequence.
+ *
+ * @generated from message ai.stigmer.agentic.agentchannel.v1.ConversationTimelineItem
+ */
+export type ConversationTimelineItem = Message<"ai.stigmer.agentic.agentchannel.v1.ConversationTimelineItem"> & {
+    /**
+     * Stable, opaque item identifier.
+     *
+     * @generated from field: string item_id = 1;
+     */
+    itemId: string;
+    /**
+     * Which lane the item is on.
+     *
+     * @generated from field: ai.stigmer.agentic.agentchannel.v1.ConversationLane lane = 2;
+     */
+    lane: ConversationLane;
+    /**
+     * Who authored the item.
+     *
+     * @generated from field: ai.stigmer.agentic.agentchannel.v1.ConversationItemAuthor author = 3;
+     */
+    author: ConversationItemAuthor;
+    /**
+     * Identity account id of the authoring teammate. Empty unless author
+     * is author_teammate.
+     *
+     * @generated from field: string authored_by = 4;
+     */
+    authoredBy: string;
+    /**
+     * Rendered text body. Empty when the item has no text (see
+     * provider_message_type).
+     *
+     * @generated from field: string text = 5;
+     */
+    text: string;
+    /**
+     * The provider's verbatim message type for inbound items ("text",
+     * "image", "audio", "document", ...). Empty on outbound items in v1.
+     *
+     * @internal
+     * channel-conversations DD-004 amendment (T02 planning): non-text
+     * inbound is ignored by the reply pipeline today
+     * (WhatsAppInboundEventProcessor marks "non_text:<type>"), but the
+     * customer still sent it — a handoff timeline that hides it fails the
+     * product. Verbatim pass-through, never re-encoded (the DD-004 S-6
+     * posture); the UI renders known kinds as placeholders. Media content
+     * retrieval is a named non-goal of this slice.
+     *
+     * @generated from field: string provider_message_type = 6;
+     */
+    providerMessageType: string;
+    /**
+     * When the item happened (the source's own event instant).
+     *
+     * @generated from field: google.protobuf.Timestamp at = 7;
+     */
+    at?: Timestamp;
+    /**
+     * Our send attempt's lifecycle, for outbound items (delivery rows and
+     * outbound-ledger rows share the vocabulary). Unset on inbound items.
+     *
+     * @generated from field: ai.stigmer.agentic.agentchannel.v1.ChannelDeliveryStatus delivery_status = 8;
+     */
+    deliveryStatus: ChannelDeliveryStatus;
+    /**
+     * The provider's receipt report, for outbound-ledger items. A second
+     * axis beside delivery_status — never collapsed into it.
+     *
+     * @generated from field: ai.stigmer.agentic.agentchannel.v1.ChannelReceiptState receipt_state = 9;
+     */
+    receiptState: ChannelReceiptState;
+    /**
+     * Which trust context authorized an outbound-ledger item's send.
+     *
+     * @generated from field: ai.stigmer.agentic.agentchannel.v1.ChannelOutboundOrigin origin = 10;
+     */
+    origin: ChannelOutboundOrigin;
+};
+/**
+ * Describes the message ai.stigmer.agentic.agentchannel.v1.ConversationTimelineItem.
+ * Use `create(ConversationTimelineItemSchema)` to create a new message.
+ */
+export declare const ConversationTimelineItemSchema: GenMessage<ConversationTimelineItem>;
+/**
+ * Input for listing an organization's channel conversations.
+ *
+ * @generated from message ai.stigmer.agentic.agentchannel.v1.ListChannelConversationsInput
+ */
+export type ListChannelConversationsInput = Message<"ai.stigmer.agentic.agentchannel.v1.ListChannelConversationsInput"> & {
+    /**
+     * Organization whose conversations to list.
+     *
+     * @generated from field: string org = 1;
+     */
+    org: string;
+    /**
+     * Optional filter: only conversations on this agent channel.
+     *
+     * @generated from field: string agent_channel_id = 2;
+     */
+    agentChannelId: string;
+    /**
+     * Pagination options. Conversations are returned newest activity first.
+     *
+     * @generated from field: ai.stigmer.commons.rpc.PageInfo page_info = 3;
+     */
+    pageInfo?: PageInfo;
+};
+/**
+ * Describes the message ai.stigmer.agentic.agentchannel.v1.ListChannelConversationsInput.
+ * Use `create(ListChannelConversationsInputSchema)` to create a new message.
+ */
+export declare const ListChannelConversationsInputSchema: GenMessage<ListChannelConversationsInput>;
+/**
+ * ChannelConversationList contains a page of channel conversations,
+ * newest activity first.
+ *
+ * @generated from message ai.stigmer.agentic.agentchannel.v1.ChannelConversationList
+ */
+export type ChannelConversationList = Message<"ai.stigmer.agentic.agentchannel.v1.ChannelConversationList"> & {
+    /**
+     * Total number of conversations matching the filter.
+     *
+     * @generated from field: int32 total_count = 1;
+     */
+    totalCount: number;
+    /**
+     * Conversations in the current page.
+     *
+     * @generated from field: repeated ai.stigmer.agentic.agentchannel.v1.ChannelConversation items = 2;
+     */
+    items: ChannelConversation[];
+};
+/**
+ * Describes the message ai.stigmer.agentic.agentchannel.v1.ChannelConversationList.
+ * Use `create(ChannelConversationListSchema)` to create a new message.
+ */
+export declare const ChannelConversationListSchema: GenMessage<ChannelConversationList>;
+/**
+ * Input for reading one conversation's timeline.
+ *
+ * @generated from message ai.stigmer.agentic.agentchannel.v1.GetConversationTimelineInput
+ */
+export type GetConversationTimelineInput = Message<"ai.stigmer.agentic.agentchannel.v1.GetConversationTimelineInput"> & {
+    /**
+     * AgentChannel the conversation belongs to.
+     *
+     * @generated from field: string agent_channel_id = 1;
+     */
+    agentChannelId: string;
+    /**
+     * Conversation key within the channel (WhatsApp: the customer's wa_id).
+     *
+     * @generated from field: string conversation_key = 2;
+     */
+    conversationKey: string;
+    /**
+     * Maximum number of items to return per page. Server may return fewer.
+     *
+     * @generated from field: int32 page_size = 3;
+     */
+    pageSize: number;
+    /**
+     * Opaque cursor from a previous response. Empty for the newest page.
+     *
+     * @generated from field: string page_token = 4;
+     */
+    pageToken: string;
+};
+/**
+ * Describes the message ai.stigmer.agentic.agentchannel.v1.GetConversationTimelineInput.
+ * Use `create(GetConversationTimelineInputSchema)` to create a new message.
+ */
+export declare const GetConversationTimelineInputSchema: GenMessage<GetConversationTimelineInput>;
+/**
+ * ConversationTimeline contains one page of a conversation's timeline,
+ * newest first.
+ *
+ * @internal
+ * Cursor pagination, not PageInfo, deliberately (DD-004 D-b): the
+ * timeline is stitched across three stores at read time, so an offset is
+ * neither cheap nor stable while new items land; the cursor encodes
+ * (instant, item_id). No total_count for the same reason — a
+ * cross-store count would be a second full stitch pretending to be a
+ * number.
+ *
+ * @generated from message ai.stigmer.agentic.agentchannel.v1.ConversationTimeline
+ */
+export type ConversationTimeline = Message<"ai.stigmer.agentic.agentchannel.v1.ConversationTimeline"> & {
+    /**
+     * Timeline items in the current page, newest first.
+     *
+     * @generated from field: repeated ai.stigmer.agentic.agentchannel.v1.ConversationTimelineItem items = 1;
+     */
+    items: ConversationTimelineItem[];
+    /**
+     * Cursor for the next (older) page. Empty when no more items exist.
+     *
+     * @generated from field: string next_page_token = 2;
+     */
+    nextPageToken: string;
+};
+/**
+ * Describes the message ai.stigmer.agentic.agentchannel.v1.ConversationTimeline.
+ * Use `create(ConversationTimelineSchema)` to create a new message.
+ */
+export declare const ConversationTimelineSchema: GenMessage<ConversationTimeline>;
+/**
+ * Input for the conversation control commands (takeOver, handBack,
+ * clearAttention).
+ *
+ * @generated from message ai.stigmer.agentic.agentchannel.v1.ConversationControlInput
+ */
+export type ConversationControlInput = Message<"ai.stigmer.agentic.agentchannel.v1.ConversationControlInput"> & {
+    /**
+     * AgentChannel the conversation belongs to.
+     *
+     * @generated from field: string agent_channel_id = 1;
+     */
+    agentChannelId: string;
+    /**
+     * Conversation key within the channel (WhatsApp: the customer's wa_id).
+     *
+     * @generated from field: string conversation_key = 2;
+     */
+    conversationKey: string;
+};
+/**
+ * Describes the message ai.stigmer.agentic.agentchannel.v1.ConversationControlInput.
+ * Use `create(ConversationControlInputSchema)` to create a new message.
+ */
+export declare const ConversationControlInputSchema: GenMessage<ConversationControlInput>;
+/**
+ * Input for replying to a conversation as the business.
+ *
+ * @internal
+ * channel-conversations DD-009 D-a: conversation-scoped by design — the
+ * operator addresses a conversation they are looking at, never types a
+ * recipient, and the handler derives the recipient from the conversation
+ * key. This seam (not the cold-send lane) is where staff-reply semantics
+ * live: implicit takeover orders the control flip before-or-with the send
+ * (T03), and staff replies are exempt from the proactive caps (DD-009 D-c).
+ *
+ * @generated from message ai.stigmer.agentic.agentchannel.v1.ReplyToConversationInput
+ */
+export type ReplyToConversationInput = Message<"ai.stigmer.agentic.agentchannel.v1.ReplyToConversationInput"> & {
+    /**
+     * AgentChannel the conversation belongs to.
+     *
+     * @generated from field: string agent_channel_id = 1;
+     */
+    agentChannelId: string;
+    /**
+     * Conversation key within the channel (WhatsApp: the customer's wa_id).
+     *
+     * @generated from field: string conversation_key = 2;
+     */
+    conversationKey: string;
+    /**
+     * Typed message content (the outbound payload vocabulary, shared with
+     * sendMessage — one payload contract, no twin).
+     *
+     * @generated from field: ai.stigmer.agentic.agentchannel.v1.ChannelOutboundPayload payload = 3;
+     */
+    payload?: ChannelOutboundPayload;
+};
+/**
+ * Describes the message ai.stigmer.agentic.agentchannel.v1.ReplyToConversationInput.
+ * Use `create(ReplyToConversationInputSchema)` to create a new message.
+ */
+export declare const ReplyToConversationInputSchema: GenMessage<ReplyToConversationInput>;
+/**
+ * Input for flagging a conversation for human attention.
+ *
+ * @generated from message ai.stigmer.agentic.agentchannel.v1.EscalateConversationInput
+ */
+export type EscalateConversationInput = Message<"ai.stigmer.agentic.agentchannel.v1.EscalateConversationInput"> & {
+    /**
+     * Why the agent is escalating, in the agent's own words. Becomes the
+     * conversation's attention_reason and the escalation event's content.
+     *
+     * @generated from field: string reason = 1;
+     */
+    reason: string;
+};
+/**
+ * Describes the message ai.stigmer.agentic.agentchannel.v1.EscalateConversationInput.
+ * Use `create(EscalateConversationInputSchema)` to create a new message.
+ */
+export declare const EscalateConversationInputSchema: GenMessage<EscalateConversationInput>;
+/**
+ * ConversationControl names who may speak to the customer on a
+ * conversation's public lane.
+ *
+ * @internal
+ * channel-conversations DD-002 (lane x control): exactly one holder at a
+ * time; transitions are CAS-guarded through the participation writer
+ * (DD-007 D-f). Values carry the control_ prefix — proto3 enum values are
+ * package-scoped and bare names invite collisions (the receipt_ precedent).
+ *
+ * @generated from enum ai.stigmer.agentic.agentchannel.v1.ConversationControl
+ */
+export declare enum ConversationControl {
+    /**
+     * Default value when no control state is set.
+     *
+     * @generated from enum value: conversation_control_unspecified = 0;
+     */
+    conversation_control_unspecified = 0,
+    /**
+     * The agent serves the conversation (the default for every conversation).
+     *
+     * @generated from enum value: control_agent = 1;
+     */
+    control_agent = 1,
+    /**
+     * A human holds the conversation; the agent is quiet until handback.
+     *
+     * @generated from enum value: control_human = 2;
+     */
+    control_human = 2
+}
+/**
+ * Describes the enum ai.stigmer.agentic.agentchannel.v1.ConversationControl.
+ */
+export declare const ConversationControlSchema: GenEnum<ConversationControl>;
+/**
+ * ConversationLane distinguishes customer-visible items from internal ones.
+ *
+ * @internal
+ * channel-conversations DD-002: every timeline item has a lane. lane_internal
+ * carries the internal event store's items — escalations and attention clears
+ * since T03 Sitting 4, notes when their writer lands (the v1-stretch decision).
+ *
+ * @generated from enum ai.stigmer.agentic.agentchannel.v1.ConversationLane
+ */
+export declare enum ConversationLane {
+    /**
+     * Default value when no lane is set.
+     *
+     * @generated from enum value: conversation_lane_unspecified = 0;
+     */
+    conversation_lane_unspecified = 0,
+    /**
+     * The customer sees this item (their message, a delivered reply, a send).
+     *
+     * @generated from enum value: lane_public = 1;
+     */
+    lane_public = 1,
+    /**
+     * Org-internal item (escalations, notes); the customer never sees it.
+     *
+     * @generated from enum value: lane_internal = 2;
+     */
+    lane_internal = 2
+}
+/**
+ * Describes the enum ai.stigmer.agentic.agentchannel.v1.ConversationLane.
+ */
+export declare const ConversationLaneSchema: GenEnum<ConversationLane>;
+/**
+ * ConversationItemAuthor names who authored a timeline item.
+ *
+ * @generated from enum ai.stigmer.agentic.agentchannel.v1.ConversationItemAuthor
+ */
+export declare enum ConversationItemAuthor {
+    /**
+     * Default value when no author is set.
+     *
+     * @generated from enum value: conversation_item_author_unspecified = 0;
+     */
+    conversation_item_author_unspecified = 0,
+    /**
+     * The external customer.
+     *
+     * @generated from enum value: author_customer = 1;
+     */
+    author_customer = 1,
+    /**
+     * The serving agent.
+     *
+     * @generated from enum value: author_agent = 2;
+     */
+    author_agent = 2,
+    /**
+     * An org human replying as the business.
+     *
+     * @generated from enum value: author_teammate = 3;
+     */
+    author_teammate = 3,
+    /**
+     * Platform-authored conversation copy (e.g. the takeover
+     * acknowledgment), neither the agent's words nor a teammate's.
+     *
+     * @internal
+     * channel-conversations DD-005 D-d: acknowledgment rows carry the
+     * platform outbound origin (lands in T03); rendering them as the agent
+     * would be a lie. The value exists from day one so the item vocabulary
+     * never needs a patch when the first platform row appears.
+     *
+     * @generated from enum value: author_platform = 4;
+     */
+    author_platform = 4
+}
+/**
+ * Describes the enum ai.stigmer.agentic.agentchannel.v1.ConversationItemAuthor.
+ */
+export declare const ConversationItemAuthorSchema: GenEnum<ConversationItemAuthor>;