@chatbotkit/sdk 1.21.9 → 1.22.0

package/dist/cjs/partner/user/v1.d.ts

@@ -10,6 +10,7 @@ export type PartnerUserListRequest = {
     order?: "desc" | "asc";
     take?: number;
     meta?: Record<string, string>;
+    email?: string;
 };
 export type PartnerUserListResponse = import("../../types/api/v1.js").operations["listPartnerUsers"]["responses"]["200"]["content"]["application/json"];
 export type PartnerUserListStreamType = import("../../types/api/v1.js").operations["listPartnerUsers"]["responses"]["200"]["content"]["application/jsonl"];

package/dist/cjs/platform/content/index.cjs

@@ -4,11 +4,13 @@ exports.PlatformContentClient = void 0;
 const client_js_1 = require("../../client.cjs");
 const index_js_1 = require("./doc/index.cjs");
 const index_js_2 = require("./manual/index.cjs");
+const index_js_3 = require("./tutorial/index.cjs");
 class PlatformContentClient extends client_js_1.ChatBotKitClient {
     constructor(options) {
         super(options);
         this.doc = new index_js_1.PlatformContentDocClient(options);
         this.manual = new index_js_2.PlatformContentManualClient(options);
+        this.tutorial = new index_js_3.PlatformContentTutorialClient(options);
     }
 }
 exports.PlatformContentClient = PlatformContentClient;

package/dist/cjs/platform/content/index.d.ts

@@ -1,8 +1,10 @@
 export class PlatformContentClient extends ChatBotKitClient {
     doc: PlatformContentDocClient;
     manual: PlatformContentManualClient;
+    tutorial: PlatformContentTutorialClient;
 }
 export default PlatformContentClient;
 import { ChatBotKitClient } from '../../client.cjs';
 import { PlatformContentDocClient } from './doc/index.cjs';
 import { PlatformContentManualClient } from './manual/index.cjs';
+import { PlatformContentTutorialClient } from './tutorial/index.cjs';

package/dist/cjs/platform/content/tutorial/index.cjs

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlatformContentTutorialClient = void 0;
+const client_js_1 = require("../../../client.cjs");
+const v1_js_1 = require("./v1.cjs");
+class PlatformContentTutorialClient extends client_js_1.ChatBotKitClient {
+    constructor(options) {
+        super(options);
+    }
+    list(request) {
+        return (0, v1_js_1.listPlatformContentTutorials)(this, request);
+    }
+    search(request) {
+        return (0, v1_js_1.searchPlatformContentTutorials)(this, request);
+    }
+    fetch(tutorialId) {
+        return (0, v1_js_1.fetchPlatformContentTutorial)(this, tutorialId);
+    }
+}
+exports.PlatformContentTutorialClient = PlatformContentTutorialClient;
+exports.default = PlatformContentTutorialClient;

package/dist/cjs/platform/content/tutorial/index.d.ts

@@ -0,0 +1,8 @@
+export class PlatformContentTutorialClient extends ChatBotKitClient {
+    list(request?: import("./v1.js").PlatformContentTutorialListRequest): ResponsePromise<import("./v1.js").PlatformContentTutorialListResponse, import("./v1.js").PlatformContentTutorialListStreamType>;
+    search(request: import("./v1.js").PlatformContentTutorialSearchRequest): Promise<import("./v1.js").PlatformContentTutorialSearchResponse>;
+    fetch(tutorialId: string): ResponsePromise<import("./v1.js").PlatformContentTutorialFetchResponse, never>;
+}
+export default PlatformContentTutorialClient;
+export type ResponsePromise<T, U> = import("../../../client.js").ResponsePromise<T, U>;
+import { ChatBotKitClient } from '../../../client.cjs';

package/dist/cjs/platform/content/tutorial/v1.cjs

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listPlatformContentTutorials = listPlatformContentTutorials;
+exports.searchPlatformContentTutorials = searchPlatformContentTutorials;
+exports.fetchPlatformContentTutorial = fetchPlatformContentTutorial;
+function listPlatformContentTutorials(client, request) {
+    let url = `/api/v1/platform/content/tutorial/list`;
+    const response = client.clientFetch(url, { query: request });
+    return response;
+}
+async function searchPlatformContentTutorials(client, request) {
+    const url = `/api/v1/platform/content/tutorial/search`;
+    const response = await client.clientFetch(url, {
+        record: {
+            ...request,
+        },
+    });
+    return response;
+}
+function fetchPlatformContentTutorial(client, tutorialId) {
+    const url = `/api/v1/platform/content/tutorial/${tutorialId}/fetch`;
+    const response = client.clientFetch(url, {
+        endpoint: '/api/v1/platform/content/tutorial/{tutorialId}/fetch',
+    });
+    return response;
+}

package/dist/cjs/platform/content/tutorial/v1.d.ts

@@ -0,0 +1,19 @@
+export function listPlatformContentTutorials(client: ChatBotKitClient, request?: PlatformContentTutorialListRequest): ResponsePromise<PlatformContentTutorialListResponse, PlatformContentTutorialListStreamType>;
+export function searchPlatformContentTutorials(client: ChatBotKitClient, request: PlatformContentTutorialSearchRequest): Promise<PlatformContentTutorialSearchResponse>;
+export function fetchPlatformContentTutorial(client: ChatBotKitClient, tutorialId: string): ResponsePromise<PlatformContentTutorialFetchResponse, never>;
+export type ChatBotKitClient = import("../../../client.js").ChatBotKitClient;
+export type ResponsePromise<T, U> = import("../../../client.js").ResponsePromise<T, U>;
+export type PlatformContentTutorialListRequest = {
+    cursor?: string;
+    order?: "desc" | "asc";
+    take?: number;
+    meta?: Record<string, string>;
+};
+export type PlatformContentTutorialListResponse = import("../../../types/api/v1.js").operations["listPlatformContentTutorials"]["responses"]["200"]["content"]["application/json"];
+export type PlatformContentTutorialListItem = PlatformContentTutorialListResponse["items"][number];
+export type PlatformContentTutorialListStreamType = import("../../../types/api/v1.js").operations["listPlatformContentTutorials"]["responses"]["200"]["content"]["application/jsonl"];
+export type PlatformContentTutorialSearchRequestBody = import("../../../types/api/v1.js").operations["searchPlatformContentTutorials"]["requestBody"]["content"]["application/json"];
+export type PlatformContentTutorialSearchRequest = PlatformContentTutorialSearchRequestBody;
+export type PlatformContentTutorialSearchResponseBody = import("../../../types/api/v1.js").operations["searchPlatformContentTutorials"]["responses"]["200"]["content"]["application/json"];
+export type PlatformContentTutorialSearchResponse = PlatformContentTutorialSearchResponseBody;
+export type PlatformContentTutorialFetchResponse = import("../../../types/api/v1.js").operations["fetchPlatformContentTutorial"]["responses"]["200"]["content"]["application/json"];

package/dist/cjs/types/api/v1.d.ts

@@ -3412,6 +3412,66 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/platform/content/tutorial/{tutorialId}/fetch": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Fetch a specific platform tutorial
+         * @description Retrieves the complete content and metadata of a specific tutorial. This
+         *     includes the markdown content and all associated frontmatter.
+         *
+         */
+        get: operations["fetchPlatformContentTutorial"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/platform/content/tutorial/list": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Retrieve a list of platform tutorials
+         * @description Returns a list of available tutorials with their metadata.
+         *
+         */
+        get: operations["listPlatformContentTutorials"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/platform/content/tutorial/search": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Search platform tutorials using semantic similarity */
+        post: operations["searchPlatformContentTutorials"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/platform/example/{exampleId}/clone": {
         parameters: {
             query?: never;
@@ -17717,6 +17777,232 @@ export interface operations {
             };
         };
     };
+    fetchPlatformContentTutorial: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                tutorialId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The tutorial was retrieved successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @description The associated name */
+                        name: string;
+                        /** @description The associated description */
+                        description?: string;
+                        /** @description Meta data information */
+                        meta?: {
+                            [key: string]: unknown;
+                        };
+                        /** @description The instance ID */
+                        id: string;
+                        /** @description The timestamp (ms) when the instance was created */
+                        createdAt: number;
+                        /** @description The timestamp (ms) when the instance was updated */
+                        updatedAt: number;
+                        /** @description The category of the tutorial */
+                        category?: string;
+                        /** @description Tags associated with the tutorial */
+                        tags?: string[];
+                        /** @description The display order index */
+                        index?: number;
+                        /** @description The markdown content of the tutorial */
+                        content: string;
+                        /** @description The URL to the official tutorial page */
+                        url?: string;
+                    };
+                };
+            };
+            /** @description Tutorial not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description An error response */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": unknown;
+                };
+            };
+        };
+    };
+    listPlatformContentTutorials: {
+        parameters: {
+            query?: {
+                cursor?: string;
+                order?: "asc" | "desc";
+                take?: number;
+                meta?: {
+                    [key: string]: string;
+                };
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The list of tutorials was retrieved successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        items: {
+                            /** @description The associated name */
+                            name: string;
+                            /** @description The associated description */
+                            description?: string;
+                            /** @description Meta data information */
+                            meta?: {
+                                [key: string]: unknown;
+                            };
+                            /** @description The instance ID */
+                            id: string;
+                            /** @description The timestamp (ms) when the instance was created */
+                            createdAt: number;
+                            /** @description The timestamp (ms) when the instance was updated */
+                            updatedAt: number;
+                            /** @description The category of the tutorial */
+                            category?: string;
+                            /** @description Tags associated with the tutorial */
+                            tags?: string[];
+                            /** @description The display order index */
+                            index?: number;
+                            /** @description The URL to the official tutorial page */
+                            url?: string;
+                        }[];
+                    };
+                    "application/jsonl": {
+                        /**
+                         * @description The type of event
+                         * @enum {string}
+                         */
+                        type: "item";
+                        /** @description Instance list properties */
+                        data: {
+                            /** @description The associated name */
+                            name: string;
+                            /** @description The associated description */
+                            description?: string;
+                            /** @description Meta data information */
+                            meta?: {
+                                [key: string]: unknown;
+                            };
+                            /** @description The instance ID */
+                            id: string;
+                            /** @description The timestamp (ms) when the instance was created */
+                            createdAt: number;
+                            /** @description The timestamp (ms) when the instance was updated */
+                            updatedAt: number;
+                            /** @description The category of the tutorial */
+                            category?: string;
+                            /** @description Tags associated with the tutorial */
+                            tags?: string[];
+                            /** @description The display order index */
+                            index?: number;
+                            /** @description The URL to the official tutorial page */
+                            url?: string;
+                        };
+                    };
+                };
+            };
+            /** @description An error response */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": unknown;
+                };
+            };
+        };
+    };
+    searchPlatformContentTutorials: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /** @description The search query to find relevant tutorials */
+                    search: string;
+                    /**
+                     * @description The maximum number of results to return (1-100, default 10)
+                     * @default 10
+                     */
+                    take?: number;
+                };
+            };
+        };
+        responses: {
+            /** @description The search was successful */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        items: {
+                            /** @description The associated name */
+                            name: string;
+                            /** @description The associated description */
+                            description: string;
+                            /** @description Meta data information */
+                            meta?: {
+                                [key: string]: unknown;
+                            };
+                            /** @description The instance ID */
+                            id: string;
+                            /** @description The timestamp (ms) when the instance was created */
+                            createdAt: number;
+                            /** @description The timestamp (ms) when the instance was updated */
+                            updatedAt: number;
+                            /** @description The category of the tutorial */
+                            category?: string;
+                            /** @description Tags associated with the tutorial */
+                            tags: string[];
+                            /** @description The display order index */
+                            index: number;
+                            /** @description The similarity score of the search result */
+                            score: number;
+                            /** @description An excerpt from the most relevant part of the tutorial */
+                            excerpt: string;
+                            /** @description The URL to the official tutorial page */
+                            url: string;
+                        }[];
+                    };
+                };
+            };
+            /** @description An error response */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": unknown;
+                };
+            };
+        };
+    };
     clonePlatformExample: {
         parameters: {
             query?: never;

package/dist/cjs/types/report.d.ts

@@ -96,17 +96,14 @@ export interface ReportRegistry {
 
 // Input and Output Types for each report
 export type TotalRatingsInput = {
-  userId: string
   periodDays?: number
 }
 
 export type ThumbsUpInput = {
-  userId: string
   periodDays?: number
 }
 
 export type ThumbsDownInput = {
-  userId: string
   periodDays?: number
 }
 
@@ -115,47 +112,38 @@ export type TotalContactsInput = {
 }
 
 export type ActiveContactsInput = {
-  userId: string
   periodDays?: number
 }
 
 export type TotalConversationsInput = {
-  userId: string
   periodDays?: number
 }
 
 export type TotalMessagesInput = {
-  userId: string
   periodDays?: number
 }
 
 export type UserMessagesInput = {
-  userId: string
   periodDays?: number
 }
 
 export type BotMessagesInput = {
-  userId: string
   periodDays?: number
 }
 
 export type ActivityMessagesInput = {
-  userId: string
   periodDays?: number
 }
 
 export type AverageUserMessagesPerConversationInput = {
-  userId: string
   periodDays?: number
 }
 
 export type AverageBotMessagesPerConversationInput = {
-  userId: string
   periodDays?: number
 }
 
 export type AverageActionsPerConversationInput = {
-  userId: string
   periodDays?: number
 }
 

package/dist/esm/partner/user/v1.d.ts

@@ -10,6 +10,7 @@ export type PartnerUserListRequest = {
     order?: "desc" | "asc";
     take?: number;
     meta?: Record<string, string>;
+    email?: string;
 };
 export type PartnerUserListResponse = import("../../types/api/v1.js").operations["listPartnerUsers"]["responses"]["200"]["content"]["application/json"];
 export type PartnerUserListStreamType = import("../../types/api/v1.js").operations["listPartnerUsers"]["responses"]["200"]["content"]["application/jsonl"];

package/dist/esm/platform/content/index.d.ts

@@ -1,8 +1,10 @@
 export class PlatformContentClient extends ChatBotKitClient {
     doc: PlatformContentDocClient;
     manual: PlatformContentManualClient;
+    tutorial: PlatformContentTutorialClient;
 }
 export default PlatformContentClient;
 import { ChatBotKitClient } from '../../client.js';
 import { PlatformContentDocClient } from './doc/index.js';
 import { PlatformContentManualClient } from './manual/index.js';
+import { PlatformContentTutorialClient } from './tutorial/index.js';

package/dist/esm/platform/content/index.js

@@ -1,11 +1,13 @@
 import { ChatBotKitClient } from '../../client.js';
 import { PlatformContentDocClient } from './doc/index.js';
 import { PlatformContentManualClient } from './manual/index.js';
+import { PlatformContentTutorialClient } from './tutorial/index.js';
 export class PlatformContentClient extends ChatBotKitClient {
     constructor(options) {
         super(options);
         this.doc = new PlatformContentDocClient(options);
         this.manual = new PlatformContentManualClient(options);
+        this.tutorial = new PlatformContentTutorialClient(options);
     }
 }
 export default PlatformContentClient;

package/dist/esm/platform/content/tutorial/index.d.ts

@@ -0,0 +1,8 @@
+export class PlatformContentTutorialClient extends ChatBotKitClient {
+    list(request?: import("./v1.js").PlatformContentTutorialListRequest): ResponsePromise<import("./v1.js").PlatformContentTutorialListResponse, import("./v1.js").PlatformContentTutorialListStreamType>;
+    search(request: import("./v1.js").PlatformContentTutorialSearchRequest): Promise<import("./v1.js").PlatformContentTutorialSearchResponse>;
+    fetch(tutorialId: string): ResponsePromise<import("./v1.js").PlatformContentTutorialFetchResponse, never>;
+}
+export default PlatformContentTutorialClient;
+export type ResponsePromise<T, U> = import("../../../client.js").ResponsePromise<T, U>;
+import { ChatBotKitClient } from '../../../client.js';

package/dist/esm/platform/content/tutorial/index.js

@@ -0,0 +1,17 @@
+import { ChatBotKitClient } from '../../../client.js';
+import { fetchPlatformContentTutorial, listPlatformContentTutorials, searchPlatformContentTutorials, } from './v1.js';
+export class PlatformContentTutorialClient extends ChatBotKitClient {
+    constructor(options) {
+        super(options);
+    }
+    list(request) {
+        return listPlatformContentTutorials(this, request);
+    }
+    search(request) {
+        return searchPlatformContentTutorials(this, request);
+    }
+    fetch(tutorialId) {
+        return fetchPlatformContentTutorial(this, tutorialId);
+    }
+}
+export default PlatformContentTutorialClient;

package/dist/esm/platform/content/tutorial/v1.d.ts

@@ -0,0 +1,19 @@
+export function listPlatformContentTutorials(client: ChatBotKitClient, request?: PlatformContentTutorialListRequest): ResponsePromise<PlatformContentTutorialListResponse, PlatformContentTutorialListStreamType>;
+export function searchPlatformContentTutorials(client: ChatBotKitClient, request: PlatformContentTutorialSearchRequest): Promise<PlatformContentTutorialSearchResponse>;
+export function fetchPlatformContentTutorial(client: ChatBotKitClient, tutorialId: string): ResponsePromise<PlatformContentTutorialFetchResponse, never>;
+export type ChatBotKitClient = import("../../../client.js").ChatBotKitClient;
+export type ResponsePromise<T, U> = import("../../../client.js").ResponsePromise<T, U>;
+export type PlatformContentTutorialListRequest = {
+    cursor?: string;
+    order?: "desc" | "asc";
+    take?: number;
+    meta?: Record<string, string>;
+};
+export type PlatformContentTutorialListResponse = import("../../../types/api/v1.js").operations["listPlatformContentTutorials"]["responses"]["200"]["content"]["application/json"];
+export type PlatformContentTutorialListItem = PlatformContentTutorialListResponse["items"][number];
+export type PlatformContentTutorialListStreamType = import("../../../types/api/v1.js").operations["listPlatformContentTutorials"]["responses"]["200"]["content"]["application/jsonl"];
+export type PlatformContentTutorialSearchRequestBody = import("../../../types/api/v1.js").operations["searchPlatformContentTutorials"]["requestBody"]["content"]["application/json"];
+export type PlatformContentTutorialSearchRequest = PlatformContentTutorialSearchRequestBody;
+export type PlatformContentTutorialSearchResponseBody = import("../../../types/api/v1.js").operations["searchPlatformContentTutorials"]["responses"]["200"]["content"]["application/json"];
+export type PlatformContentTutorialSearchResponse = PlatformContentTutorialSearchResponseBody;
+export type PlatformContentTutorialFetchResponse = import("../../../types/api/v1.js").operations["fetchPlatformContentTutorial"]["responses"]["200"]["content"]["application/json"];

package/dist/esm/platform/content/tutorial/v1.js

@@ -0,0 +1,21 @@
+export function listPlatformContentTutorials(client, request) {
+    let url = `/api/v1/platform/content/tutorial/list`;
+    const response = client.clientFetch(url, { query: request });
+    return response;
+}
+export async function searchPlatformContentTutorials(client, request) {
+    const url = `/api/v1/platform/content/tutorial/search`;
+    const response = await client.clientFetch(url, {
+        record: {
+            ...request,
+        },
+    });
+    return response;
+}
+export function fetchPlatformContentTutorial(client, tutorialId) {
+    const url = `/api/v1/platform/content/tutorial/${tutorialId}/fetch`;
+    const response = client.clientFetch(url, {
+        endpoint: '/api/v1/platform/content/tutorial/{tutorialId}/fetch',
+    });
+    return response;
+}

package/dist/esm/types/api/v1.d.ts

@@ -3412,6 +3412,66 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/platform/content/tutorial/{tutorialId}/fetch": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Fetch a specific platform tutorial
+         * @description Retrieves the complete content and metadata of a specific tutorial. This
+         *     includes the markdown content and all associated frontmatter.
+         *
+         */
+        get: operations["fetchPlatformContentTutorial"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/platform/content/tutorial/list": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Retrieve a list of platform tutorials
+         * @description Returns a list of available tutorials with their metadata.
+         *
+         */
+        get: operations["listPlatformContentTutorials"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/platform/content/tutorial/search": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Search platform tutorials using semantic similarity */
+        post: operations["searchPlatformContentTutorials"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/platform/example/{exampleId}/clone": {
         parameters: {
             query?: never;
@@ -17717,6 +17777,232 @@ export interface operations {
             };
         };
     };
+    fetchPlatformContentTutorial: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                tutorialId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The tutorial was retrieved successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @description The associated name */
+                        name: string;
+                        /** @description The associated description */
+                        description?: string;
+                        /** @description Meta data information */
+                        meta?: {
+                            [key: string]: unknown;
+                        };
+                        /** @description The instance ID */
+                        id: string;
+                        /** @description The timestamp (ms) when the instance was created */
+                        createdAt: number;
+                        /** @description The timestamp (ms) when the instance was updated */
+                        updatedAt: number;
+                        /** @description The category of the tutorial */
+                        category?: string;
+                        /** @description Tags associated with the tutorial */
+                        tags?: string[];
+                        /** @description The display order index */
+                        index?: number;
+                        /** @description The markdown content of the tutorial */
+                        content: string;
+                        /** @description The URL to the official tutorial page */
+                        url?: string;
+                    };
+                };
+            };
+            /** @description Tutorial not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description An error response */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": unknown;
+                };
+            };
+        };
+    };
+    listPlatformContentTutorials: {
+        parameters: {
+            query?: {
+                cursor?: string;
+                order?: "asc" | "desc";
+                take?: number;
+                meta?: {
+                    [key: string]: string;
+                };
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The list of tutorials was retrieved successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        items: {
+                            /** @description The associated name */
+                            name: string;
+                            /** @description The associated description */
+                            description?: string;
+                            /** @description Meta data information */
+                            meta?: {
+                                [key: string]: unknown;
+                            };
+                            /** @description The instance ID */
+                            id: string;
+                            /** @description The timestamp (ms) when the instance was created */
+                            createdAt: number;
+                            /** @description The timestamp (ms) when the instance was updated */
+                            updatedAt: number;
+                            /** @description The category of the tutorial */
+                            category?: string;
+                            /** @description Tags associated with the tutorial */
+                            tags?: string[];
+                            /** @description The display order index */
+                            index?: number;
+                            /** @description The URL to the official tutorial page */
+                            url?: string;
+                        }[];
+                    };
+                    "application/jsonl": {
+                        /**
+                         * @description The type of event
+                         * @enum {string}
+                         */
+                        type: "item";
+                        /** @description Instance list properties */
+                        data: {
+                            /** @description The associated name */
+                            name: string;
+                            /** @description The associated description */
+                            description?: string;
+                            /** @description Meta data information */
+                            meta?: {
+                                [key: string]: unknown;
+                            };
+                            /** @description The instance ID */
+                            id: string;
+                            /** @description The timestamp (ms) when the instance was created */
+                            createdAt: number;
+                            /** @description The timestamp (ms) when the instance was updated */
+                            updatedAt: number;
+                            /** @description The category of the tutorial */
+                            category?: string;
+                            /** @description Tags associated with the tutorial */
+                            tags?: string[];
+                            /** @description The display order index */
+                            index?: number;
+                            /** @description The URL to the official tutorial page */
+                            url?: string;
+                        };
+                    };
+                };
+            };
+            /** @description An error response */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": unknown;
+                };
+            };
+        };
+    };
+    searchPlatformContentTutorials: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /** @description The search query to find relevant tutorials */
+                    search: string;
+                    /**
+                     * @description The maximum number of results to return (1-100, default 10)
+                     * @default 10
+                     */
+                    take?: number;
+                };
+            };
+        };
+        responses: {
+            /** @description The search was successful */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        items: {
+                            /** @description The associated name */
+                            name: string;
+                            /** @description The associated description */
+                            description: string;
+                            /** @description Meta data information */
+                            meta?: {
+                                [key: string]: unknown;
+                            };
+                            /** @description The instance ID */
+                            id: string;
+                            /** @description The timestamp (ms) when the instance was created */
+                            createdAt: number;
+                            /** @description The timestamp (ms) when the instance was updated */
+                            updatedAt: number;
+                            /** @description The category of the tutorial */
+                            category?: string;
+                            /** @description Tags associated with the tutorial */
+                            tags: string[];
+                            /** @description The display order index */
+                            index: number;
+                            /** @description The similarity score of the search result */
+                            score: number;
+                            /** @description An excerpt from the most relevant part of the tutorial */
+                            excerpt: string;
+                            /** @description The URL to the official tutorial page */
+                            url: string;
+                        }[];
+                    };
+                };
+            };
+            /** @description An error response */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": unknown;
+                };
+            };
+        };
+    };
     clonePlatformExample: {
         parameters: {
             query?: never;

package/dist/esm/types/report.d.ts

@@ -96,17 +96,14 @@ export interface ReportRegistry {
 
 // Input and Output Types for each report
 export type TotalRatingsInput = {
-  userId: string
   periodDays?: number
 }
 
 export type ThumbsUpInput = {
-  userId: string
   periodDays?: number
 }
 
 export type ThumbsDownInput = {
-  userId: string
   periodDays?: number
 }
 
@@ -115,47 +112,38 @@ export type TotalContactsInput = {
 }
 
 export type ActiveContactsInput = {
-  userId: string
   periodDays?: number
 }
 
 export type TotalConversationsInput = {
-  userId: string
   periodDays?: number
 }
 
 export type TotalMessagesInput = {
-  userId: string
   periodDays?: number
 }
 
 export type UserMessagesInput = {
-  userId: string
   periodDays?: number
 }
 
 export type BotMessagesInput = {
-  userId: string
   periodDays?: number
 }
 
 export type ActivityMessagesInput = {
-  userId: string
   periodDays?: number
 }
 
 export type AverageUserMessagesPerConversationInput = {
-  userId: string
   periodDays?: number
 }
 
 export type AverageBotMessagesPerConversationInput = {
-  userId: string
   periodDays?: number
 }
 
 export type AverageActionsPerConversationInput = {
-  userId: string
   periodDays?: number
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chatbotkit/sdk",
-  "version": "1.21.9",
+  "version": "1.22.0",
   "description": "The fastest way to build advanced AI chat bots",
   "license": "ISC",
   "engines": {
@@ -2248,6 +2248,56 @@
         "default": "./dist/cjs/platform/content/manual/v1.cjs"
       }
     },
+    "./platform/content/tutorial": {
+      "import": {
+        "types": "./dist/esm/platform/content/tutorial/index.d.ts",
+        "default": "./dist/esm/platform/content/tutorial/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/platform/content/tutorial/index.d.ts",
+        "default": "./dist/cjs/platform/content/tutorial/index.cjs"
+      }
+    },
+    "./platform/content/tutorial/index": {
+      "import": {
+        "types": "./dist/esm/platform/content/tutorial/index.d.ts",
+        "default": "./dist/esm/platform/content/tutorial/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/platform/content/tutorial/index.d.ts",
+        "default": "./dist/cjs/platform/content/tutorial/index.cjs"
+      }
+    },
+    "./platform/content/tutorial/index.js": {
+      "import": {
+        "types": "./dist/esm/platform/content/tutorial/index.d.ts",
+        "default": "./dist/esm/platform/content/tutorial/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/platform/content/tutorial/index.d.ts",
+        "default": "./dist/cjs/platform/content/tutorial/index.cjs"
+      }
+    },
+    "./platform/content/tutorial/v1": {
+      "import": {
+        "types": "./dist/esm/platform/content/tutorial/v1.d.ts",
+        "default": "./dist/esm/platform/content/tutorial/v1.js"
+      },
+      "require": {
+        "types": "./dist/cjs/platform/content/tutorial/v1.d.ts",
+        "default": "./dist/cjs/platform/content/tutorial/v1.cjs"
+      }
+    },
+    "./platform/content/tutorial/v1.js": {
+      "import": {
+        "types": "./dist/esm/platform/content/tutorial/v1.d.ts",
+        "default": "./dist/esm/platform/content/tutorial/v1.js"
+      },
+      "require": {
+        "types": "./dist/cjs/platform/content/tutorial/v1.d.ts",
+        "default": "./dist/cjs/platform/content/tutorial/v1.cjs"
+      }
+    },
     "./platform/example": {
       "import": {
         "types": "./dist/esm/platform/example/index.d.ts",
@@ -3097,9 +3147,9 @@
   },
   "devDependencies": {
     "npm-run-all": "^4.1.5",
-    "typedoc": "^0.25.3",
-    "typedoc-plugin-markdown": "^3.17.1",
-    "typedoc-plugin-mdn-links": "^3.1.18",
+    "typedoc": "^0.28.14",
+    "typedoc-plugin-markdown": "^4.9.0",
+    "typedoc-plugin-mdn-links": "^5.0.10",
     "typescript": "^5.9",
     "openapi-typescript": "7.4.4",
     "swagger-client": "^3.24.5"