@operla-ai/sdk 0.4.0 → 0.4.2

package/dist/generated/types.gen.d.ts

@@ -2386,6 +2386,171 @@ export type List2Responses = {
     };
 };
 export type List2Response = List2Responses[keyof List2Responses];
+export type Create2Data = {
+    body?: {
+        /**
+         * The person the conversation is with. Set `resolved: true` when you already have a complete profile to skip identity resolution on later messages.
+         */
+        user?: {
+            /**
+             * Unique identifier of the person in the conversation, in your system.
+             */
+            userId: string;
+            /**
+             * Whether the user is fully identified. Pass `true` to skip user resolution (you have a complete profile); pass `false` (or omit) to have us verify identity from the message. In responses, reflects the current state.
+             */
+            resolved?: boolean;
+            /**
+             * Custom data attached to the user (name, email, account info, etc.).
+             */
+            data?: {
+                [key: string]: unknown;
+            };
+        };
+        /**
+         * Link the conversation to an entity (format: ent_xxxxxxxxxxxx).
+         */
+        entityId?: string;
+        /**
+         * Origin tag for the conversation (e.g. "website", "import"). Stored for analytics.
+         */
+        source?: string;
+    };
+    path?: never;
+    query?: never;
+    url: '/conversations';
+};
+export type Create2Errors = {
+    /**
+     * Bad request
+     */
+    400: {
+        statusCode: number;
+        error: {
+            code: 'MISSING-ORG' | 'VALIDATION' | 'INVALID-JSON';
+            message: string;
+        };
+    };
+    /**
+     * Authentication required
+     */
+    401: {
+        statusCode: number;
+        error: {
+            code: 'AUTH';
+            message: string;
+        };
+    };
+    /**
+     * Insufficient permissions
+     */
+    403: {
+        statusCode: number;
+        error: {
+            code: 'FORBIDDEN' | 'SCOPE-FORBIDDEN';
+            message: string;
+        };
+    };
+};
+export type Create2Error = Create2Errors[keyof Create2Errors];
+export type Create2Responses = {
+    /**
+     * Successful response
+     */
+    200: {
+        /**
+         * Conversation ID (format: conv_xxxxxxxxxxxx).
+         */
+        conversationId: string;
+        /**
+         * Organization the conversation is linked to (id + name); null when not tied to one.
+         */
+        organization: {
+            id: string;
+            name: string;
+        } | null;
+        /**
+         * Current lifecycle status of the conversation.
+         */
+        status: 'pending' | 'processing' | 'awaiting_validation' | 'awaiting_user' | 'resolved' | 'closed' | 'failed' | 'escalated' | 'spam';
+        /**
+         * Short human-readable subject computed from the first messages or the user's identity.
+         */
+        subject: string;
+        /**
+         * The person in the conversation, if identified. Null when no user is known yet.
+         */
+        user: {
+            /**
+             * Unique identifier of the person in the conversation, in your system.
+             */
+            userId: string;
+            /**
+             * Whether the user is fully identified. Pass `true` to skip user resolution (you have a complete profile); pass `false` (or omit) to have us verify identity from the message. In responses, reflects the current state.
+             */
+            resolved?: boolean;
+            /**
+             * Custom data attached to the user (name, email, account info, etc.).
+             */
+            data?: {
+                [key: string]: unknown;
+            };
+        } | null;
+        /**
+         * Entity the conversation is linked to (id + name); null when not tied to one.
+         */
+        entity: {
+            id: string;
+            name: string;
+        } | null;
+        /**
+         * Total number of messages exchanged so far (user + agent).
+         */
+        messageCount: number;
+        /**
+         * ISO timestamp of the last message, or null if no messages yet.
+         */
+        lastMessageAt: string | null;
+        /**
+         * ISO timestamp when the conversation was created.
+         */
+        createdAt: string;
+        /**
+         * ISO timestamp of the last modification (message, status change, etc.).
+         */
+        updatedAt: string;
+        /**
+         * Full message history in chronological order.
+         */
+        thread: Array<{
+            /**
+             * Who emitted the message — the user or your AI agent.
+             */
+            role: 'user' | 'agent';
+            /**
+             * Message body.
+             */
+            content: string;
+            /**
+             * ISO timestamp when the message was recorded.
+             */
+            timestamp: string;
+            /**
+             * Display name of the author (when available).
+             */
+            authorName?: string;
+        }>;
+        /**
+         * Origin tag provided when the conversation was created.
+         */
+        source?: string;
+        /**
+         * Cross-reference ID in your external ticketing system (e.g. Zendesk), when applicable.
+         */
+        externalTicketId?: string;
+    };
+};
+export type Create2Response = Create2Responses[keyof Create2Responses];
 export type Get2Data = {
     body?: never;
     path: {
@@ -2951,7 +3116,7 @@ export type List3Responses = {
     };
 };
 export type List3Response = List3Responses[keyof List3Responses];
-export type Create2Data = {
+export type Create3Data = {
     body?: {
         /**
          * Human-readable name of the entity.
@@ -2968,7 +3133,7 @@ export type Create2Data = {
     query?: never;
     url: '/entities';
 };
-export type Create2Errors = {
+export type Create3Errors = {
     /**
      * Bad request
      */
@@ -3000,8 +3165,8 @@ export type Create2Errors = {
         };
     };
 };
-export type Create2Error = Create2Errors[keyof Create2Errors];
-export type Create2Responses = {
+export type Create3Error = Create3Errors[keyof Create3Errors];
+export type Create3Responses = {
     /**
      * Successful response
      */
@@ -3037,7 +3202,7 @@ export type Create2Responses = {
         };
     };
 };
-export type Create2Response = Create2Responses[keyof Create2Responses];
+export type Create3Response = Create3Responses[keyof Create3Responses];
 export type Delete2Data = {
     body?: never;
     path: {
@@ -3382,7 +3547,7 @@ export type List4Responses = {
     };
 };
 export type List4Response = List4Responses[keyof List4Responses];
-export type Create3Data = {
+export type Create4Data = {
     body?: {
         /**
          * Human-readable label. The intent's machine name is derived from it (lower-cased, words joined by `_`).
@@ -3422,7 +3587,7 @@ export type Create3Data = {
     query?: never;
     url: '/intents';
 };
-export type Create3Errors = {
+export type Create4Errors = {
     /**
      * Bad request
      */
@@ -3454,8 +3619,8 @@ export type Create3Errors = {
         };
     };
 };
-export type Create3Error = Create3Errors[keyof Create3Errors];
-export type Create3Responses = {
+export type Create4Error = Create4Errors[keyof Create4Errors];
+export type Create4Responses = {
     /**
      * Successful response
      */
@@ -3520,7 +3685,7 @@ export type Create3Responses = {
         };
     };
 };
-export type Create3Response = Create3Responses[keyof Create3Responses];
+export type Create4Response = Create4Responses[keyof Create4Responses];
 export type Delete3Data = {
     body?: never;
     path: {
@@ -4009,7 +4174,7 @@ export type List5Responses = {
     };
 };
 export type List5Response = List5Responses[keyof List5Responses];
-export type Create4Data = {
+export type Create5Data = {
     body?: {
         /**
          * Article title.
@@ -4033,7 +4198,7 @@ export type Create4Data = {
     };
     url: '/kb';
 };
-export type Create4Errors = {
+export type Create5Errors = {
     /**
      * Bad request
      */
@@ -4065,8 +4230,8 @@ export type Create4Errors = {
         };
     };
 };
-export type Create4Error = Create4Errors[keyof Create4Errors];
-export type Create4Responses = {
+export type Create5Error = Create5Errors[keyof Create5Errors];
+export type Create5Responses = {
     /**
      * Successful response
      */
@@ -4156,7 +4321,7 @@ export type Create4Responses = {
         updatedAt: string;
     };
 };
-export type Create4Response = Create4Responses[keyof Create4Responses];
+export type Create5Response = Create5Responses[keyof Create5Responses];
 export type Delete4Data = {
     body?: never;
     path: {
@@ -4500,6 +4665,319 @@ export type Update4Responses = {
     };
 };
 export type Update4Response = Update4Responses[keyof Update4Responses];
+export type CreateManyData = {
+    body?: {
+        /**
+         * Articles to create (1–500). Each is published immediately as v1.
+         */
+        articles: Array<{
+            /**
+             * Article title.
+             */
+            title: string;
+            /**
+             * Article body (Markdown).
+             */
+            content: string;
+            /**
+             * Intent IDs this article serves. Empty = always-on within its scope.
+             */
+            intents?: Array<string>;
+            /**
+             * Target a specific entity (under the caller's organization) for this article only.
+             */
+            entityId?: string;
+        }>;
+    };
+    path?: never;
+    query?: never;
+    url: '/kb/bulk';
+};
+export type CreateManyErrors = {
+    /**
+     * Bad request
+     */
+    400: {
+        statusCode: number;
+        error: {
+            code: 'MISSING-ORG' | 'VALIDATION' | 'INVALID-JSON';
+            message: string;
+        };
+    };
+    /**
+     * Authentication required
+     */
+    401: {
+        statusCode: number;
+        error: {
+            code: 'AUTH';
+            message: string;
+        };
+    };
+    /**
+     * Insufficient permissions
+     */
+    403: {
+        statusCode: number;
+        error: {
+            code: 'FORBIDDEN' | 'SCOPE-FORBIDDEN';
+            message: string;
+        };
+    };
+};
+export type CreateManyError = CreateManyErrors[keyof CreateManyErrors];
+export type CreateManyResponses = {
+    /**
+     * All articles were created.
+     */
+    200: {
+        /**
+         * Articles that were created, with their original request index.
+         */
+        created: Array<{
+            /**
+             * Position of this article in the request `articles` array.
+             */
+            index: number;
+            /**
+             * The created article.
+             */
+            article: {
+                /**
+                 * KB article ID (format: kb_xxxxxxxxxxxx).
+                 */
+                id: string;
+                /**
+                 * Cascade level at which this article was created.
+                 */
+                scope: {
+                    /**
+                     * Cascade level this article lives at — `global` (whole tenant), `organization` (per-org), or `entity` (per-entity).
+                     */
+                    level: 'global' | 'organization' | 'entity';
+                    /**
+                     * ID of the organization when `level` is `organization` or `entity`.
+                     */
+                    organizationId?: string;
+                    /**
+                     * ID of the entity when `level` is `entity`.
+                     */
+                    entityId?: string;
+                };
+                /**
+                 * Intent IDs this article serves. Empty array = always-on within its scope.
+                 */
+                intents: Array<string>;
+                /**
+                 * Currently published content of the article.
+                 */
+                published: {
+                    /**
+                     * Monotonic version number of this snapshot.
+                     */
+                    version: number;
+                    /**
+                     * Article title at this version.
+                     */
+                    title: string;
+                    /**
+                     * Article body (Markdown) at this version.
+                     */
+                    content: string;
+                    /**
+                     * ISO timestamp of the publication that produced this snapshot.
+                     */
+                    publishedAt?: string;
+                    /**
+                     * ISO timestamp of the last draft edit (drafts only).
+                     */
+                    updatedAt?: string;
+                };
+                /**
+                 * Pending draft content, when one exists. Promote it via `publish: true` on update.
+                 */
+                draft?: {
+                    /**
+                     * Monotonic version number of this snapshot.
+                     */
+                    version: number;
+                    /**
+                     * Article title at this version.
+                     */
+                    title: string;
+                    /**
+                     * Article body (Markdown) at this version.
+                     */
+                    content: string;
+                    /**
+                     * ISO timestamp of the publication that produced this snapshot.
+                     */
+                    publishedAt?: string;
+                    /**
+                     * ISO timestamp of the last draft edit (drafts only).
+                     */
+                    updatedAt?: string;
+                };
+                /**
+                 * ISO timestamp when the article was created.
+                 */
+                createdAt: string;
+                /**
+                 * ISO timestamp of the last modification (publish, draft edit, intents change).
+                 */
+                updatedAt: string;
+            };
+        }>;
+        summary: {
+            /**
+             * Total number of articles in the request.
+             */
+            total: number;
+            /**
+             * How many were created.
+             */
+            created: number;
+            /**
+             * How many were rejected.
+             */
+            failed: number;
+        };
+    };
+    /**
+     * Partial success — some articles were created, the rest are listed in `failed`.
+     */
+    207: {
+        /**
+         * Articles that were created, with their original request index.
+         */
+        created: Array<{
+            /**
+             * Position of this article in the request `articles` array.
+             */
+            index: number;
+            /**
+             * The created article.
+             */
+            article: {
+                /**
+                 * KB article ID (format: kb_xxxxxxxxxxxx).
+                 */
+                id: string;
+                /**
+                 * Cascade level at which this article was created.
+                 */
+                scope: {
+                    /**
+                     * Cascade level this article lives at — `global` (whole tenant), `organization` (per-org), or `entity` (per-entity).
+                     */
+                    level: 'global' | 'organization' | 'entity';
+                    /**
+                     * ID of the organization when `level` is `organization` or `entity`.
+                     */
+                    organizationId?: string;
+                    /**
+                     * ID of the entity when `level` is `entity`.
+                     */
+                    entityId?: string;
+                };
+                /**
+                 * Intent IDs this article serves. Empty array = always-on within its scope.
+                 */
+                intents: Array<string>;
+                /**
+                 * Currently published content of the article.
+                 */
+                published: {
+                    /**
+                     * Monotonic version number of this snapshot.
+                     */
+                    version: number;
+                    /**
+                     * Article title at this version.
+                     */
+                    title: string;
+                    /**
+                     * Article body (Markdown) at this version.
+                     */
+                    content: string;
+                    /**
+                     * ISO timestamp of the publication that produced this snapshot.
+                     */
+                    publishedAt?: string;
+                    /**
+                     * ISO timestamp of the last draft edit (drafts only).
+                     */
+                    updatedAt?: string;
+                };
+                /**
+                 * Pending draft content, when one exists. Promote it via `publish: true` on update.
+                 */
+                draft?: {
+                    /**
+                     * Monotonic version number of this snapshot.
+                     */
+                    version: number;
+                    /**
+                     * Article title at this version.
+                     */
+                    title: string;
+                    /**
+                     * Article body (Markdown) at this version.
+                     */
+                    content: string;
+                    /**
+                     * ISO timestamp of the publication that produced this snapshot.
+                     */
+                    publishedAt?: string;
+                    /**
+                     * ISO timestamp of the last draft edit (drafts only).
+                     */
+                    updatedAt?: string;
+                };
+                /**
+                 * ISO timestamp when the article was created.
+                 */
+                createdAt: string;
+                /**
+                 * ISO timestamp of the last modification (publish, draft edit, intents change).
+                 */
+                updatedAt: string;
+            };
+        }>;
+        /**
+         * Articles that were rejected, with the reason — the rest were still created.
+         */
+        failed: Array<{
+            /**
+             * Position of the rejected article in the request `articles` array.
+             */
+            index: number;
+            /**
+             * Machine-readable failure code (e.g. `VALIDATION`).
+             */
+            code: string;
+            /**
+             * Human-readable reason the article was rejected.
+             */
+            error: string;
+        }>;
+        summary: {
+            /**
+             * Total number of articles in the request.
+             */
+            total: number;
+            /**
+             * How many were created.
+             */
+            created: number;
+            /**
+             * How many were rejected.
+             */
+            failed: number;
+        };
+    };
+};
+export type CreateManyResponse = CreateManyResponses[keyof CreateManyResponses];
 export type Publish2Data = {
     body?: never;
     path: {
@@ -4865,7 +5343,7 @@ export type List6Responses = {
     };
 };
 export type List6Response = List6Responses[keyof List6Responses];
-export type Create5Data = {
+export type Create6Data = {
     body?: {
         /**
          * Human-readable name of the organization (must be unique).
@@ -4886,7 +5364,7 @@ export type Create5Data = {
     query?: never;
     url: '/organizations';
 };
-export type Create5Errors = {
+export type Create6Errors = {
     /**
      * Bad request
      */
@@ -4918,8 +5396,8 @@ export type Create5Errors = {
         };
     };
 };
-export type Create5Error = Create5Errors[keyof Create5Errors];
-export type Create5Responses = {
+export type Create6Error = Create6Errors[keyof Create6Errors];
+export type Create6Responses = {
     /**
      * Successful response
      */
@@ -4957,7 +5435,7 @@ export type Create5Responses = {
         apiKey?: string;
     };
 };
-export type Create5Response = Create5Responses[keyof Create5Responses];
+export type Create6Response = Create6Responses[keyof Create6Responses];
 export type Delete5Data = {
     body?: never;
     path: {