@chatbotkit/sdk 1.21.7 → 1.21.9

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

@@ -0,0 +1,284 @@
+/**
+ * This file is auto-generated. Do not edit manually.
+ * Generated from report registry schemas.
+ */
+
+export type ReportId = 'clr3m5n8k000008jq7h9e5b1a' | 'clr3m5n8k000108jq3c4d7f2b' | 'clr3m5n8k000208jq8e5f6g3c' | 'clr3m5n8k000308jq1h7i8j4d' | 'clr3m5n8k000408jq9i8j9k5e' | 'clr3m5n8k000508jq2j9k0l6f' | 'clr3m5n8k000608jq3k0l1m7g' | 'clr3m5n8k000708jq4l1m2n8h' | 'clr3m5n8k000808jq5m2n3o9i' | 'clr3m5n8k000908jq6n3o4p0j' | 'clr3m5n8k000a08jq7o4p5q1k' | 'clr3m5n8k000b08jq8p5q6r2l' | 'clr3m5n8k000c08jq9q6r7s3m'
+
+export interface ReportMetadata {
+  id: string
+  name: string
+  description: string
+  createdAt: string
+  updatedAt: string
+}
+
+export interface ReportRegistry {
+  'clr3m5n8k000008jq7h9e5b1a': {
+    name: string
+    description: string
+    input: TotalRatingsInput
+    output: TotalRatingsOutput
+  }
+  'clr3m5n8k000108jq3c4d7f2b': {
+    name: string
+    description: string
+    input: ThumbsUpInput
+    output: ThumbsUpOutput
+  }
+  'clr3m5n8k000208jq8e5f6g3c': {
+    name: string
+    description: string
+    input: ThumbsDownInput
+    output: ThumbsDownOutput
+  }
+  'clr3m5n8k000308jq1h7i8j4d': {
+    name: string
+    description: string
+    input: TotalContactsInput
+    output: TotalContactsOutput
+  }
+  'clr3m5n8k000408jq9i8j9k5e': {
+    name: string
+    description: string
+    input: ActiveContactsInput
+    output: ActiveContactsOutput
+  }
+  'clr3m5n8k000508jq2j9k0l6f': {
+    name: string
+    description: string
+    input: TotalConversationsInput
+    output: TotalConversationsOutput
+  }
+  'clr3m5n8k000608jq3k0l1m7g': {
+    name: string
+    description: string
+    input: TotalMessagesInput
+    output: TotalMessagesOutput
+  }
+  'clr3m5n8k000708jq4l1m2n8h': {
+    name: string
+    description: string
+    input: UserMessagesInput
+    output: UserMessagesOutput
+  }
+  'clr3m5n8k000808jq5m2n3o9i': {
+    name: string
+    description: string
+    input: BotMessagesInput
+    output: BotMessagesOutput
+  }
+  'clr3m5n8k000908jq6n3o4p0j': {
+    name: string
+    description: string
+    input: ActivityMessagesInput
+    output: ActivityMessagesOutput
+  }
+  'clr3m5n8k000a08jq7o4p5q1k': {
+    name: string
+    description: string
+    input: AverageUserMessagesPerConversationInput
+    output: AverageUserMessagesPerConversationOutput
+  }
+  'clr3m5n8k000b08jq8p5q6r2l': {
+    name: string
+    description: string
+    input: AverageBotMessagesPerConversationInput
+    output: AverageBotMessagesPerConversationOutput
+  }
+  'clr3m5n8k000c08jq9q6r7s3m': {
+    name: string
+    description: string
+    input: AverageActionsPerConversationInput
+    output: AverageActionsPerConversationOutput
+  }
+}
+
+// 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
+}
+
+export type TotalContactsInput = {
+  userId: string
+}
+
+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
+}
+
+export type TotalRatingsOutput = {
+  value: number
+  change?: number
+  period: string
+  breakdown?: { date: string; total: number }[]
+  thumbsUp?: number
+  thumbsDown?: number
+}
+
+export type ThumbsUpOutput = {
+  value: number
+  change?: number
+  period: string
+  breakdown?: { date: string; total: number }[]
+}
+
+export type ThumbsDownOutput = {
+  value: number
+  change?: number
+  period: string
+  breakdown?: { date: string; total: number }[]
+}
+
+export type TotalContactsOutput = {
+  value: number
+  period: string
+}
+
+export type ActiveContactsOutput = {
+  value: number
+  change?: number
+  period: string
+  breakdown?: { date: string; total: number }[]
+}
+
+export type TotalConversationsOutput = {
+  value: number
+  change?: number
+  period: string
+  breakdown?: { date: string; total: number }[]
+}
+
+export type TotalMessagesOutput = {
+  value: number
+  change?: number
+  period: string
+  breakdown?: { date: string; total: number }[]
+}
+
+export type UserMessagesOutput = {
+  value: number
+  change?: number
+  period: string
+  breakdown?: { date: string; total: number }[]
+}
+
+export type BotMessagesOutput = {
+  value: number
+  change?: number
+  period: string
+  breakdown?: { date: string; total: number }[]
+}
+
+export type ActivityMessagesOutput = {
+  value: number
+  change?: number
+  period: string
+  breakdown?: { date: string; total: number }[]
+}
+
+export type AverageUserMessagesPerConversationOutput = {
+  value: number
+  period: string
+}
+
+export type AverageBotMessagesPerConversationOutput = {
+  value: number
+  period: string
+}
+
+export type AverageActionsPerConversationOutput = {
+  value: number
+  period: string
+}
+
+// Mapping report IDs to their input/output types
+export type ReportInputTypes = {
+  'clr3m5n8k000008jq7h9e5b1a': TotalRatingsInput
+  'clr3m5n8k000108jq3c4d7f2b': ThumbsUpInput
+  'clr3m5n8k000208jq8e5f6g3c': ThumbsDownInput
+  'clr3m5n8k000308jq1h7i8j4d': TotalContactsInput
+  'clr3m5n8k000408jq9i8j9k5e': ActiveContactsInput
+  'clr3m5n8k000508jq2j9k0l6f': TotalConversationsInput
+  'clr3m5n8k000608jq3k0l1m7g': TotalMessagesInput
+  'clr3m5n8k000708jq4l1m2n8h': UserMessagesInput
+  'clr3m5n8k000808jq5m2n3o9i': BotMessagesInput
+  'clr3m5n8k000908jq6n3o4p0j': ActivityMessagesInput
+  'clr3m5n8k000a08jq7o4p5q1k': AverageUserMessagesPerConversationInput
+  'clr3m5n8k000b08jq8p5q6r2l': AverageBotMessagesPerConversationInput
+  'clr3m5n8k000c08jq9q6r7s3m': AverageActionsPerConversationInput
+}
+
+export type ReportOutputTypes = {
+  'clr3m5n8k000008jq7h9e5b1a': TotalRatingsOutput
+  'clr3m5n8k000108jq3c4d7f2b': ThumbsUpOutput
+  'clr3m5n8k000208jq8e5f6g3c': ThumbsDownOutput
+  'clr3m5n8k000308jq1h7i8j4d': TotalContactsOutput
+  'clr3m5n8k000408jq9i8j9k5e': ActiveContactsOutput
+  'clr3m5n8k000508jq2j9k0l6f': TotalConversationsOutput
+  'clr3m5n8k000608jq3k0l1m7g': TotalMessagesOutput
+  'clr3m5n8k000708jq4l1m2n8h': UserMessagesOutput
+  'clr3m5n8k000808jq5m2n3o9i': BotMessagesOutput
+  'clr3m5n8k000908jq6n3o4p0j': ActivityMessagesOutput
+  'clr3m5n8k000a08jq7o4p5q1k': AverageUserMessagesPerConversationOutput
+  'clr3m5n8k000b08jq8p5q6r2l': AverageBotMessagesPerConversationOutput
+  'clr3m5n8k000c08jq9q6r7s3m': AverageActionsPerConversationOutput
+}
+
+// Helper type to get input type by report ID
+export type GetReportInput<T extends ReportId> = ReportInputTypes[T]
+
+// Helper type to get output type by report ID
+export type GetReportOutput<T extends ReportId> = ReportOutputTypes[T]

package/dist/esm/index.d.ts

@@ -18,6 +18,7 @@ export class ChatBotKit extends ChatBotKitClient {
     memory: MemoryClient;
     policy: PolicyClient;
     portal: PortalClient;
+    report: ReportClient;
     usage: UsageClient;
     graphql: GraphqlClient;
 }
@@ -38,10 +39,11 @@ import { TeamClient } from './team/index.js';
 import { MemoryClient } from './memory/index.js';
 import { PolicyClient } from './policy/index.js';
 import { PortalClient } from './portal/index.js';
+import { ReportClient } from './report/index.js';
 import { GraphqlClient } from './graphql/index.js';
 import { SpaceClient } from './space/index.js';
 import { UsageClient } from './usage/index.js';
 import { ChatBotKitClient } from './client.js';
 import { PlatformClient } from './platform/index.js';
 import { TaskClient } from './task/index.js';
-export { BlueprintClient, BotClient, ChannelClient, FileClient, MagicClient, PartnerClient, DatasetClient, SkillsetClient, IntegrationClient, ConversationClient, ContactClient, SecretClient, TeamClient, MemoryClient, PolicyClient, PortalClient, GraphqlClient, SpaceClient, UsageClient };
+export { BlueprintClient, BotClient, ChannelClient, FileClient, MagicClient, PartnerClient, DatasetClient, SkillsetClient, IntegrationClient, ConversationClient, ContactClient, SecretClient, TeamClient, MemoryClient, PolicyClient, PortalClient, ReportClient, GraphqlClient, SpaceClient, UsageClient };

package/dist/esm/index.js

@@ -14,6 +14,7 @@ import { PartnerClient } from './partner/index.js';
 import { PlatformClient } from './platform/index.js';
 import { PolicyClient } from './policy/index.js';
 import { PortalClient } from './portal/index.js';
+import { ReportClient } from './report/index.js';
 import { SecretClient } from './secret/index.js';
 import { SkillsetClient } from './skillset/index.js';
 import { SpaceClient } from './space/index.js';
@@ -36,6 +37,7 @@ export { TeamClient };
 export { MemoryClient };
 export { PolicyClient };
 export { PortalClient };
+export { ReportClient };
 export { GraphqlClient };
 export { SpaceClient };
 export { UsageClient };
@@ -61,6 +63,7 @@ export class ChatBotKit extends ChatBotKitClient {
         this.memory = new MemoryClient(options);
         this.policy = new PolicyClient(options);
         this.portal = new PortalClient(options);
+        this.report = new ReportClient(options);
         this.usage = new UsageClient(options);
         this.graphql = new GraphqlClient(options);
     }

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

@@ -3,8 +3,9 @@ export class PlatformClient extends ChatBotKitClient {
     ability: PlatformAbilityClient;
     action: PlatformActionClient;
     content: PlatformContentClient;
-    secrets: PlatformSecretClient;
+    secret: PlatformSecretClient;
     example: PlatformExampleClient;
+    report: PlatformReportClient;
 }
 export default PlatformClient;
 import { ChatBotKitClient } from '../client.js';
@@ -14,3 +15,4 @@ import { PlatformActionClient } from './action/index.js';
 import { PlatformContentClient } from './content/index.js';
 import { PlatformSecretClient } from './secret/index.js';
 import { PlatformExampleClient } from './example/index.js';
+import { PlatformReportClient } from './report/index.js';

package/dist/esm/platform/index.js

@@ -4,6 +4,7 @@ import { PlatformActionClient } from './action/index.js';
 import { PlatformContentClient } from './content/index.js';
 import { PlatformExampleClient } from './example/index.js';
 import { PlatformModelClient } from './model/index.js';
+import { PlatformReportClient } from './report/index.js';
 import { PlatformSecretClient } from './secret/index.js';
 export class PlatformClient extends ChatBotKitClient {
     constructor(options) {
@@ -12,8 +13,9 @@ export class PlatformClient extends ChatBotKitClient {
         this.ability = new PlatformAbilityClient(options);
         this.action = new PlatformActionClient(options);
         this.content = new PlatformContentClient(options);
-        this.secrets = new PlatformSecretClient(options);
+        this.secret = new PlatformSecretClient(options);
         this.example = new PlatformExampleClient(options);
+        this.report = new PlatformReportClient(options);
     }
 }
 export default PlatformClient;

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

@@ -0,0 +1,6 @@
+export class PlatformReportClient extends ChatBotKitClient {
+    list(request?: import("./v1.js").PlatformReportListRequest): ResponsePromise<import("./v1.js").PlatformReportListResponse, import("./v1.js").PlatformReportListStreamType>;
+}
+export default PlatformReportClient;
+export type ResponsePromise<T, U> = import("../../client.js").ResponsePromise<T, U>;
+import { ChatBotKitClient } from '../../client.js';

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

@@ -0,0 +1,11 @@
+import { ChatBotKitClient } from '../../client.js';
+import { listPlatformReports } from './v1.js';
+export class PlatformReportClient extends ChatBotKitClient {
+    constructor(options) {
+        super(options);
+    }
+    list(request) {
+        return listPlatformReports(this, request);
+    }
+}
+export default PlatformReportClient;

package/dist/esm/platform/report/v1.d.ts

@@ -0,0 +1,12 @@
+export function listPlatformReports(client: ChatBotKitClient, request?: PlatformReportListRequest): ResponsePromise<PlatformReportListResponse, PlatformReportListStreamType>;
+export type ChatBotKitClient = import("../../client.js").ChatBotKitClient;
+export type ResponsePromise<T, U> = import("../../client.js").ResponsePromise<T, U>;
+export type PlatformReportListRequest = {
+    cursor?: string;
+    order?: "desc" | "asc";
+    take?: number;
+    meta?: Record<string, string>;
+};
+export type PlatformReportListResponse = import("../../types/api/v1.js").operations["listPlatformReports"]["responses"]["200"]["content"]["application/json"];
+export type PlatformReportListItem = PlatformReportListResponse["items"][number];
+export type PlatformReportListStreamType = import("../../types/api/v1.js").operations["listPlatformReports"]["responses"]["200"]["content"]["application/jsonl"];

package/dist/esm/platform/report/v1.js

@@ -0,0 +1,5 @@
+export function listPlatformReports(client, request) {
+    let url = `/api/v1/platform/report/list`;
+    const response = client.clientFetch(url, { query: request });
+    return response;
+}

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

@@ -0,0 +1,6 @@
+export class ReportClient extends ChatBotKitClient {
+    fetch(reportId: string, request: import("./v1.js").ReportFetchRequest): Promise<import("./v1.js").ReportFetchResponse>;
+    fetchTyped<T extends import("./v1.js").ReportId>(reportId: T, request: import("./v1.js").ReportInputTypes[T]): Promise<import("./v1.js").ReportOutputTypes[T]>;
+}
+export default ReportClient;
+import { ChatBotKitClient } from '../client.js';

package/dist/esm/report/index.js

@@ -0,0 +1,14 @@
+import { ChatBotKitClient } from '../client.js';
+import { fetchReport, fetchTypedReport } from './v1.js';
+export class ReportClient extends ChatBotKitClient {
+    constructor(options) {
+        super(options);
+    }
+    fetch(reportId, request) {
+        return fetchReport(this, reportId, request);
+    }
+    fetchTyped(reportId, request) {
+        return fetchTypedReport(this, reportId, request);
+    }
+}
+export default ReportClient;

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

@@ -0,0 +1,9 @@
+export function fetchReport(client: ChatBotKitClient, reportId: string, request: ReportFetchRequest): Promise<ReportFetchResponse>;
+export function fetchTypedReport<T extends ReportId>(client: ChatBotKitClient, reportId: T, request: ReportInputTypes[T]): Promise<ReportOutputTypes[T]>;
+export type ChatBotKitClient = import("../client.js").ChatBotKitClient;
+export type ReportFetchRequestBody = import("../types/api/v1.js").operations["fetchReport"]["requestBody"]["content"]["application/json"];
+export type ReportFetchRequest = ReportFetchRequestBody;
+export type ReportFetchResponse = import("../types/api/v1.js").operations["fetchReport"]["responses"]["200"]["content"]["application/json"];
+export type ReportId = import("../types/report.js").ReportId;
+export type ReportInputTypes = import("../types/report.js").ReportInputTypes;
+export type ReportOutputTypes = import("../types/report.js").ReportOutputTypes;

package/dist/esm/report/v1.js

@@ -0,0 +1,18 @@
+export async function fetchReport(client, reportId, request) {
+    const url = `/api/v1/report/${reportId}/fetch`;
+    const response = await client.clientFetch(url, {
+        record: {
+            ...request,
+        },
+    });
+    return response;
+}
+export async function fetchTypedReport(client, reportId, request) {
+    const url = `/api/v1/report/${reportId}/fetch`;
+    const response = await client.clientFetch(url, {
+        record: {
+            ...request,
+        },
+    });
+    return response;
+}