@operla-ai/sdk 0.0.7

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

@@ -0,0 +1,861 @@
+export type ClientOptions = {
+    baseUrl: 'https://{subdomain}.operla.ai' | (string & {});
+};
+export type ListData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Filter: only list conversations linked to this entity.
+         */
+        entityId?: string;
+        /**
+         * Filter: only list conversations in this status.
+         */
+        status?: 'pending' | 'processing' | 'awaiting_validation' | 'awaiting_user' | 'validated' | 'refused' | 'resolved' | 'closed' | 'failed' | 'escalated' | 'spam';
+        /**
+         * Max number of conversations to return (1-100, default 20).
+         */
+        limit?: number;
+        /**
+         * Number of conversations to skip for pagination (default 0).
+         */
+        offset?: number | null;
+    };
+    url: '/conversations';
+};
+export type ListErrors = {
+    /**
+     * Authentication required
+     */
+    401: unknown;
+    /**
+     * Insufficient permissions
+     */
+    403: unknown;
+};
+export type ListResponses = {
+    /**
+     * Successful response
+     */
+    200: {
+        /**
+         * Conversations matching the query, sorted by last activity (most recent first).
+         */
+        conversations: Array<{
+            /**
+             * Conversation ID (format: conv_xxxxxxxxxxxx).
+             */
+            conversationId: string;
+            /**
+             * Organization linked to the conversation (when you use organizations).
+             */
+            organizationId?: string;
+            /**
+             * Current lifecycle status of the conversation.
+             */
+            status: 'pending' | 'processing' | 'awaiting_validation' | 'awaiting_user' | 'validated' | 'refused' | '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 linked to the conversation (when you use entities).
+             */
+            entityId?: string;
+            /**
+             * 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;
+        }>;
+        /**
+         * Total number of conversations matching the query (across all pages).
+         */
+        total: number;
+        /**
+         * Page size applied to this response.
+         */
+        limit: number;
+        /**
+         * Offset applied to this response.
+         */
+        offset: number;
+    };
+};
+export type ListResponse = ListResponses[keyof ListResponses];
+export type GetData = {
+    body?: never;
+    path: {
+        conversationId: string;
+    };
+    query?: never;
+    url: '/conversations/{conversationId}';
+};
+export type GetErrors = {
+    /**
+     * Authentication required
+     */
+    401: unknown;
+    /**
+     * Insufficient permissions
+     */
+    403: unknown;
+};
+export type GetResponses = {
+    /**
+     * Successful response
+     */
+    200: {
+        /**
+         * Conversation ID (format: conv_xxxxxxxxxxxx).
+         */
+        conversationId: string;
+        /**
+         * Organization linked to the conversation (when you use organizations).
+         */
+        organizationId?: string;
+        /**
+         * Current lifecycle status of the conversation.
+         */
+        status: 'pending' | 'processing' | 'awaiting_validation' | 'awaiting_user' | 'validated' | 'refused' | '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 linked to the conversation (when you use entities).
+         */
+        entityId?: string;
+        /**
+         * 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 GetResponse = GetResponses[keyof GetResponses];
+export type SendMessageData = {
+    body?: {
+        /**
+         * Message text sent by the user.
+         */
+        message: string;
+        /**
+         * Conversation ID (format: conv_xxxxxxxxxxxx). Omit on the first call — the server generates one and returns it.
+         */
+        conversationId?: string;
+        /**
+         * Link the conversation to an entity (only applied when creating the conversation; ignored on subsequent messages for the same conversationId).
+         */
+        entityId?: string;
+        /**
+         * The user sending the message. Set `resolved: true` on the user object to skip identity resolution when you already have a complete profile.
+         */
+        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;
+            };
+        };
+        /**
+         * Overrides the configured KBs for this message. Not stored.
+         */
+        kbArticles?: Array<{
+            /**
+             * Article title shown to the agent.
+             */
+            title: string;
+            /**
+             * Article body (markdown-friendly).
+             */
+            content: string;
+        }>;
+        /**
+         * Origin tag for the conversation (e.g. "website", "chat_page"). Stored on the conversation for analytics.
+         */
+        source?: string;
+        /**
+         * Custom key/value pairs attached to the conversation. Available as variables in your agent prompts.
+         */
+        metadata?: {
+            [key: string]: string;
+        };
+    };
+    path?: never;
+    query?: never;
+    url: '/conversations/messages';
+};
+export type SendMessageErrors = {
+    /**
+     * Authentication required
+     */
+    401: unknown;
+    /**
+     * Insufficient permissions
+     */
+    403: unknown;
+};
+export type SendMessageResponses = {
+    /**
+     * Successful response
+     */
+    200: {
+        /**
+         * Conversation ID — pass it back on subsequent calls to continue the conversation.
+         */
+        conversationId: string;
+        /**
+         * Organization linked to the conversation (when you use organizations).
+         */
+        organizationId?: 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 linked to the conversation (when you use entities).
+         */
+        entityId?: string;
+        /**
+         * AI-generated response to the user message.
+         */
+        content: string;
+    };
+};
+export type SendMessageResponse = SendMessageResponses[keyof SendMessageResponses];
+export type List2Data = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Filter: only list entities under this organization (when you use organizations).
+         */
+        organizationId?: string;
+    };
+    url: '/entities';
+};
+export type List2Errors = {
+    /**
+     * Authentication required
+     */
+    401: unknown;
+    /**
+     * Insufficient permissions
+     */
+    403: unknown;
+};
+export type List2Responses = {
+    /**
+     * Successful response
+     */
+    200: {
+        /**
+         * Entities matching the query.
+         */
+        entities: Array<{
+            /**
+             * Entity ID (format: ent_xxxxxxxxxxxx).
+             */
+            id: string;
+            organizationId?: string | null;
+            /**
+             * Human-readable name of the entity.
+             */
+            name: string;
+            /**
+             * Free-form metadata attached to the entity (shape is up to you).
+             */
+            metadata?: {
+                [key: string]: unknown;
+            };
+            /**
+             * ISO timestamp when the entity was created.
+             */
+            createdAt: string;
+            /**
+             * ISO timestamp of the last update.
+             */
+            updatedAt: string;
+        }>;
+        /**
+         * Total number of entities matching the query.
+         */
+        total: number;
+    };
+};
+export type List2Response = List2Responses[keyof List2Responses];
+export type CreateData = {
+    body?: {
+        /**
+         * Human-readable name of the entity.
+         */
+        name: string;
+        /**
+         * Free-form metadata attached to the entity (shape is up to you).
+         */
+        metadata?: {
+            [key: string]: unknown;
+        };
+    };
+    path?: never;
+    query?: never;
+    url: '/entities';
+};
+export type CreateErrors = {
+    /**
+     * Authentication required
+     */
+    401: unknown;
+    /**
+     * Insufficient permissions
+     */
+    403: unknown;
+};
+export type CreateResponses = {
+    /**
+     * Successful response
+     */
+    200: {
+        /**
+         * Entity ID (format: ent_xxxxxxxxxxxx).
+         */
+        id: string;
+        organizationId?: string | null;
+        /**
+         * Human-readable name of the entity.
+         */
+        name: string;
+        /**
+         * Free-form metadata attached to the entity (shape is up to you).
+         */
+        metadata?: {
+            [key: string]: unknown;
+        };
+        /**
+         * ISO timestamp when the entity was created.
+         */
+        createdAt: string;
+        /**
+         * ISO timestamp of the last update.
+         */
+        updatedAt: string;
+    };
+};
+export type CreateResponse = CreateResponses[keyof CreateResponses];
+export type DeleteData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/entities/{id}';
+};
+export type DeleteErrors = {
+    /**
+     * Authentication required
+     */
+    401: unknown;
+    /**
+     * Insufficient permissions
+     */
+    403: unknown;
+};
+export type DeleteResponses = {
+    /**
+     * Successful response
+     */
+    200: {
+        /**
+         * Confirmation message.
+         */
+        message: string;
+    };
+};
+export type DeleteResponse = DeleteResponses[keyof DeleteResponses];
+export type Get2Data = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/entities/{id}';
+};
+export type Get2Errors = {
+    /**
+     * Authentication required
+     */
+    401: unknown;
+    /**
+     * Insufficient permissions
+     */
+    403: unknown;
+};
+export type Get2Responses = {
+    /**
+     * Successful response
+     */
+    200: {
+        /**
+         * Entity ID (format: ent_xxxxxxxxxxxx).
+         */
+        id: string;
+        organizationId?: string | null;
+        /**
+         * Human-readable name of the entity.
+         */
+        name: string;
+        /**
+         * Free-form metadata attached to the entity (shape is up to you).
+         */
+        metadata?: {
+            [key: string]: unknown;
+        };
+        /**
+         * ISO timestamp when the entity was created.
+         */
+        createdAt: string;
+        /**
+         * ISO timestamp of the last update.
+         */
+        updatedAt: string;
+    };
+};
+export type Get2Response = Get2Responses[keyof Get2Responses];
+export type UpdateData = {
+    body?: {
+        /**
+         * New name for the entity.
+         */
+        name?: string;
+        /**
+         * Replace the free-form metadata attached to the entity.
+         */
+        metadata?: {
+            [key: string]: unknown;
+        };
+    };
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/entities/{id}';
+};
+export type UpdateErrors = {
+    /**
+     * Authentication required
+     */
+    401: unknown;
+    /**
+     * Insufficient permissions
+     */
+    403: unknown;
+};
+export type UpdateResponses = {
+    /**
+     * Successful response
+     */
+    200: {
+        /**
+         * Entity ID (format: ent_xxxxxxxxxxxx).
+         */
+        id: string;
+        organizationId?: string | null;
+        /**
+         * Human-readable name of the entity.
+         */
+        name: string;
+        /**
+         * Free-form metadata attached to the entity (shape is up to you).
+         */
+        metadata?: {
+            [key: string]: unknown;
+        };
+        /**
+         * ISO timestamp when the entity was created.
+         */
+        createdAt: string;
+        /**
+         * ISO timestamp of the last update.
+         */
+        updatedAt: string;
+    };
+};
+export type UpdateResponse = UpdateResponses[keyof UpdateResponses];
+export type List3Data = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/organizations';
+};
+export type List3Errors = {
+    /**
+     * Authentication required
+     */
+    401: unknown;
+    /**
+     * Insufficient permissions
+     */
+    403: unknown;
+};
+export type List3Responses = {
+    /**
+     * Successful response
+     */
+    200: {
+        /**
+         * Organizations matching the query.
+         */
+        organizations: Array<{
+            /**
+             * Organization ID (format: org_xxxxxxxxxxxx).
+             */
+            id: string;
+            /**
+             * Human-readable name of the organization.
+             */
+            name: string;
+            /**
+             * Free-form metadata attached to the organization (shape is up to you).
+             */
+            metadata?: {
+                [key: string]: unknown;
+            };
+            /**
+             * ISO timestamp when the organization was created.
+             */
+            createdAt: string;
+            /**
+             * ISO timestamp of the last update.
+             */
+            updatedAt: string;
+        }>;
+        /**
+         * Total number of organizations matching the query.
+         */
+        total: number;
+    };
+};
+export type List3Response = List3Responses[keyof List3Responses];
+export type Create2Data = {
+    body?: {
+        /**
+         * Human-readable name of the organization (must be unique).
+         */
+        name: string;
+        /**
+         * Free-form metadata attached to the organization (shape is up to you).
+         */
+        metadata?: {
+            [key: string]: unknown;
+        };
+        /**
+         * When true, also generate a scoped API key for the new organization (returned only once in the response). Defaults to false — API keys can be created later.
+         */
+        generateApiKey?: boolean;
+    };
+    path?: never;
+    query?: never;
+    url: '/organizations';
+};
+export type Create2Errors = {
+    /**
+     * Authentication required
+     */
+    401: unknown;
+    /**
+     * Insufficient permissions
+     */
+    403: unknown;
+};
+export type Create2Responses = {
+    /**
+     * Successful response
+     */
+    200: {
+        /**
+         * The newly-created organization.
+         */
+        organization: {
+            /**
+             * Organization ID (format: org_xxxxxxxxxxxx).
+             */
+            id: string;
+            /**
+             * Human-readable name of the organization.
+             */
+            name: string;
+            /**
+             * Free-form metadata attached to the organization (shape is up to you).
+             */
+            metadata?: {
+                [key: string]: unknown;
+            };
+            /**
+             * ISO timestamp when the organization was created.
+             */
+            createdAt: string;
+            /**
+             * ISO timestamp of the last update.
+             */
+            updatedAt: string;
+        };
+        /**
+         * Scoped API key for the newly-created organization — shown only once. Store it securely; it cannot be retrieved later. Present only when `generateApiKey: true` was passed in the request.
+         */
+        apiKey?: string;
+    };
+};
+export type Create2Response = Create2Responses[keyof Create2Responses];
+export type Delete2Data = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/organizations/{id}';
+};
+export type Delete2Errors = {
+    /**
+     * Authentication required
+     */
+    401: unknown;
+    /**
+     * Insufficient permissions
+     */
+    403: unknown;
+};
+export type Delete2Responses = {
+    /**
+     * Successful response
+     */
+    200: {
+        /**
+         * Confirmation message.
+         */
+        message: string;
+    };
+};
+export type Delete2Response = Delete2Responses[keyof Delete2Responses];
+export type Get3Data = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/organizations/{id}';
+};
+export type Get3Errors = {
+    /**
+     * Authentication required
+     */
+    401: unknown;
+    /**
+     * Insufficient permissions
+     */
+    403: unknown;
+};
+export type Get3Responses = {
+    /**
+     * Successful response
+     */
+    200: {
+        /**
+         * Organization ID (format: org_xxxxxxxxxxxx).
+         */
+        id: string;
+        /**
+         * Human-readable name of the organization.
+         */
+        name: string;
+        /**
+         * Free-form metadata attached to the organization (shape is up to you).
+         */
+        metadata?: {
+            [key: string]: unknown;
+        };
+        /**
+         * ISO timestamp when the organization was created.
+         */
+        createdAt: string;
+        /**
+         * ISO timestamp of the last update.
+         */
+        updatedAt: string;
+    };
+};
+export type Get3Response = Get3Responses[keyof Get3Responses];
+export type Update2Data = {
+    body?: {
+        /**
+         * New name for the organization.
+         */
+        name?: string;
+        /**
+         * Replace the free-form metadata attached to the organization.
+         */
+        metadata?: {
+            [key: string]: unknown;
+        };
+    };
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/organizations/{id}';
+};
+export type Update2Errors = {
+    /**
+     * Authentication required
+     */
+    401: unknown;
+    /**
+     * Insufficient permissions
+     */
+    403: unknown;
+};
+export type Update2Responses = {
+    /**
+     * Successful response
+     */
+    200: {
+        /**
+         * Organization ID (format: org_xxxxxxxxxxxx).
+         */
+        id: string;
+        /**
+         * Human-readable name of the organization.
+         */
+        name: string;
+        /**
+         * Free-form metadata attached to the organization (shape is up to you).
+         */
+        metadata?: {
+            [key: string]: unknown;
+        };
+        /**
+         * ISO timestamp when the organization was created.
+         */
+        createdAt: string;
+        /**
+         * ISO timestamp of the last update.
+         */
+        updatedAt: string;
+    };
+};
+export type Update2Response = Update2Responses[keyof Update2Responses];
+//# sourceMappingURL=types.gen.d.ts.map