@chatbotkit/sdk 1.22.0 → 1.24.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/dist/cjs/platform/doc/index.cjs +21 -0
  2. package/dist/cjs/platform/doc/index.d.ts +8 -0
  3. package/dist/cjs/platform/doc/v1.cjs +26 -0
  4. package/dist/cjs/platform/doc/v1.d.ts +19 -0
  5. package/dist/cjs/platform/example/index.cjs +3 -0
  6. package/dist/cjs/platform/example/index.d.ts +1 -0
  7. package/dist/cjs/platform/example/v1.cjs +8 -0
  8. package/dist/cjs/platform/example/v1.d.ts +2 -0
  9. package/dist/cjs/platform/index.cjs +12 -8
  10. package/dist/cjs/platform/index.d.ts +6 -2
  11. package/dist/cjs/platform/manual/index.cjs +21 -0
  12. package/dist/cjs/platform/manual/index.d.ts +8 -0
  13. package/dist/cjs/platform/manual/v1.cjs +26 -0
  14. package/dist/cjs/platform/manual/v1.d.ts +19 -0
  15. package/dist/cjs/platform/tutorial/index.cjs +21 -0
  16. package/dist/cjs/platform/tutorial/index.d.ts +8 -0
  17. package/dist/cjs/platform/tutorial/v1.cjs +26 -0
  18. package/dist/cjs/platform/tutorial/v1.d.ts +19 -0
  19. package/dist/cjs/report/index.cjs +4 -4
  20. package/dist/cjs/report/index.d.ts +2 -2
  21. package/dist/cjs/report/v1.cjs +6 -6
  22. package/dist/cjs/report/v1.d.ts +5 -5
  23. package/dist/cjs/types/api/v1.d.ts +501 -311
  24. package/dist/cjs/types/report.d.ts +17 -1
  25. package/dist/esm/platform/doc/index.d.ts +8 -0
  26. package/dist/esm/platform/doc/index.js +17 -0
  27. package/dist/esm/platform/doc/v1.d.ts +19 -0
  28. package/dist/esm/platform/doc/v1.js +21 -0
  29. package/dist/esm/platform/example/index.d.ts +1 -0
  30. package/dist/esm/platform/example/index.js +4 -1
  31. package/dist/esm/platform/example/v1.d.ts +2 -0
  32. package/dist/esm/platform/example/v1.js +7 -0
  33. package/dist/esm/platform/index.d.ts +6 -2
  34. package/dist/esm/platform/index.js +6 -2
  35. package/dist/esm/platform/manual/index.d.ts +8 -0
  36. package/dist/esm/platform/manual/index.js +17 -0
  37. package/dist/esm/platform/manual/v1.d.ts +19 -0
  38. package/dist/esm/platform/manual/v1.js +21 -0
  39. package/dist/esm/platform/tutorial/index.d.ts +8 -0
  40. package/dist/esm/platform/tutorial/index.js +17 -0
  41. package/dist/esm/platform/tutorial/v1.d.ts +19 -0
  42. package/dist/esm/platform/tutorial/v1.js +21 -0
  43. package/dist/esm/report/index.d.ts +2 -2
  44. package/dist/esm/report/index.js +5 -5
  45. package/dist/esm/report/v1.d.ts +5 -5
  46. package/dist/esm/report/v1.js +4 -4
  47. package/dist/esm/types/api/v1.d.ts +501 -311
  48. package/dist/esm/types/report.d.ts +17 -1
  49. package/package.json +152 -2
@@ -3,7 +3,7 @@
3
3
  * Generated from report registry schemas.
4
4
  */
5
5
 
6
- export type ReportId = 'clr3m5n8k000008jq7h9e5b1a' | 'clr3m5n8k000108jq3c4d7f2b' | 'clr3m5n8k000208jq8e5f6g3c' | 'clr3m5n8k000308jq1h7i8j4d' | 'clr3m5n8k000408jq9i8j9k5e' | 'clr3m5n8k000508jq2j9k0l6f' | 'clr3m5n8k000608jq3k0l1m7g' | 'clr3m5n8k000708jq4l1m2n8h' | 'clr3m5n8k000808jq5m2n3o9i' | 'clr3m5n8k000908jq6n3o4p0j' | 'clr3m5n8k000a08jq7o4p5q1k' | 'clr3m5n8k000b08jq8p5q6r2l' | 'clr3m5n8k000c08jq9q6r7s3m'
6
+ export type ReportId = 'clr3m5n8k000008jq7h9e5b1a' | 'clr3m5n8k000108jq3c4d7f2b' | 'clr3m5n8k000208jq8e5f6g3c' | 'clr3m5n8k000308jq1h7i8j4d' | 'clr3m5n8k000408jq9i8j9k5e' | 'clr3m5n8k000508jq2j9k0l6f' | 'clr3m5n8k000608jq3k0l1m7g' | 'clr3m5n8k000708jq4l1m2n8h' | 'clr3m5n8k000808jq5m2n3o9i' | 'clr3m5n8k000908jq6n3o4p0j' | 'clr3m5n8k000a08jq7o4p5q1k' | 'clr3m5n8k000b08jq8p5q6r2l' | 'clr3m5n8k000c08jq9q6r7s3m' | 'clr3m5n8k000d08jqar7s8t4n'
7
7
 
8
8
  export interface ReportMetadata {
9
9
  id: string
@@ -92,6 +92,12 @@ export interface ReportRegistry {
92
92
  input: AverageActionsPerConversationInput
93
93
  output: AverageActionsPerConversationOutput
94
94
  }
95
+ 'clr3m5n8k000d08jqar7s8t4n': {
96
+ name: string
97
+ description: string
98
+ input: ComprehensiveOverviewInput
99
+ output: ComprehensiveOverviewOutput
100
+ }
95
101
  }
96
102
 
97
103
  // Input and Output Types for each report
@@ -147,6 +153,10 @@ export type AverageActionsPerConversationInput = {
147
153
  periodDays?: number
148
154
  }
149
155
 
156
+ export type ComprehensiveOverviewInput = {
157
+ periodDays?: number
158
+ }
159
+
150
160
  export type TotalRatingsOutput = {
151
161
  value: number
152
162
  change?: number
@@ -232,6 +242,10 @@ export type AverageActionsPerConversationOutput = {
232
242
  period: string
233
243
  }
234
244
 
245
+ export type ComprehensiveOverviewOutput = {
246
+ data: { title: string; description: string; value: number; change?: number; period: string; details?: { metric?: { title: string; description: string; value: number; change?: number; period: string }; chart?: { type: string; data: { date: string; total: number; thumbsUp?: number; thumbsDown?: number }[] }; list?: { id: string; icon?: string; name: string; description: string; createdAt?: string; tags?: unknown[] }[] } }[]
247
+ }
248
+
235
249
  // Mapping report IDs to their input/output types
236
250
  export type ReportInputTypes = {
237
251
  'clr3m5n8k000008jq7h9e5b1a': TotalRatingsInput
@@ -247,6 +261,7 @@ export type ReportInputTypes = {
247
261
  'clr3m5n8k000a08jq7o4p5q1k': AverageUserMessagesPerConversationInput
248
262
  'clr3m5n8k000b08jq8p5q6r2l': AverageBotMessagesPerConversationInput
249
263
  'clr3m5n8k000c08jq9q6r7s3m': AverageActionsPerConversationInput
264
+ 'clr3m5n8k000d08jqar7s8t4n': ComprehensiveOverviewInput
250
265
  }
251
266
 
252
267
  export type ReportOutputTypes = {
@@ -263,6 +278,7 @@ export type ReportOutputTypes = {
263
278
  'clr3m5n8k000a08jq7o4p5q1k': AverageUserMessagesPerConversationOutput
264
279
  'clr3m5n8k000b08jq8p5q6r2l': AverageBotMessagesPerConversationOutput
265
280
  'clr3m5n8k000c08jq9q6r7s3m': AverageActionsPerConversationOutput
281
+ 'clr3m5n8k000d08jqar7s8t4n': ComprehensiveOverviewOutput
266
282
  }
267
283
 
268
284
  // Helper type to get input type by report ID
@@ -0,0 +1,8 @@
1
+ export class PlatformDocClient extends ChatBotKitClient {
2
+ list(request?: import("./v1.js").PlatformDocListRequest): ResponsePromise<import("./v1.js").PlatformDocListResponse, import("./v1.js").PlatformDocListStreamType>;
3
+ search(request: import("./v1.js").PlatformDocSearchRequest): Promise<import("./v1.js").PlatformDocSearchResponse>;
4
+ fetch(docId: string): ResponsePromise<import("./v1.js").PlatformDocFetchResponse, never>;
5
+ }
6
+ export default PlatformDocClient;
7
+ export type ResponsePromise<T, U> = import("../../client.js").ResponsePromise<T, U>;
8
+ import { ChatBotKitClient } from '../../client.js';
@@ -0,0 +1,17 @@
1
+ import { ChatBotKitClient } from '../../client.js';
2
+ import { fetchPlatformDoc, listPlatformDocs, searchPlatformDocs } from './v1.js';
3
+ export class PlatformDocClient extends ChatBotKitClient {
4
+ constructor(options) {
5
+ super(options);
6
+ }
7
+ list(request) {
8
+ return listPlatformDocs(this, request);
9
+ }
10
+ search(request) {
11
+ return searchPlatformDocs(this, request);
12
+ }
13
+ fetch(docId) {
14
+ return fetchPlatformDoc(this, docId);
15
+ }
16
+ }
17
+ export default PlatformDocClient;
@@ -0,0 +1,19 @@
1
+ export function listPlatformDocs(client: ChatBotKitClient, request?: PlatformDocListRequest): ResponsePromise<PlatformDocListResponse, PlatformDocListStreamType>;
2
+ export function searchPlatformDocs(client: ChatBotKitClient, request: PlatformDocSearchRequest): Promise<PlatformDocSearchResponse>;
3
+ export function fetchPlatformDoc(client: ChatBotKitClient, docId: string): ResponsePromise<PlatformDocFetchResponse, never>;
4
+ export type ChatBotKitClient = import("../../client.js").ChatBotKitClient;
5
+ export type ResponsePromise<T, U> = import("../../client.js").ResponsePromise<T, U>;
6
+ export type PlatformDocListRequest = {
7
+ cursor?: string;
8
+ order?: "desc" | "asc";
9
+ take?: number;
10
+ meta?: Record<string, string>;
11
+ };
12
+ export type PlatformDocListResponse = import("../../types/api/v1.js").operations["listPlatformDocs"]["responses"]["200"]["content"]["application/json"];
13
+ export type PlatformDocListItem = PlatformDocListResponse["items"][number];
14
+ export type PlatformDocListStreamType = import("../../types/api/v1.js").operations["listPlatformDocs"]["responses"]["200"]["content"]["application/jsonl"];
15
+ export type PlatformDocSearchRequestBody = import("../../types/api/v1.js").operations["searchPlatformDocs"]["requestBody"]["content"]["application/json"];
16
+ export type PlatformDocSearchRequest = PlatformDocSearchRequestBody;
17
+ export type PlatformDocSearchResponseBody = import("../../types/api/v1.js").operations["searchPlatformDocs"]["responses"]["200"]["content"]["application/json"];
18
+ export type PlatformDocSearchResponse = PlatformDocSearchResponseBody;
19
+ export type PlatformDocFetchResponse = import("../../types/api/v1.js").operations["fetchPlatformDoc"]["responses"]["200"]["content"]["application/json"];
@@ -0,0 +1,21 @@
1
+ export function listPlatformDocs(client, request) {
2
+ let url = `/api/v1/platform/doc/list`;
3
+ const response = client.clientFetch(url, { query: request });
4
+ return response;
5
+ }
6
+ export async function searchPlatformDocs(client, request) {
7
+ const url = `/api/v1/platform/doc/search`;
8
+ const response = await client.clientFetch(url, {
9
+ record: {
10
+ ...request,
11
+ },
12
+ });
13
+ return response;
14
+ }
15
+ export function fetchPlatformDoc(client, docId) {
16
+ const url = `/api/v1/platform/doc/${docId}/fetch`;
17
+ const response = client.clientFetch(url, {
18
+ endpoint: '/api/v1/platform/doc/{docId}/fetch',
19
+ });
20
+ return response;
21
+ }
@@ -1,6 +1,7 @@
1
1
  export class PlatformExampleClient extends ChatBotKitClient {
2
2
  list(request?: import("./v1.js").PlatformExampleListRequest): ResponsePromise<import("./v1.js").PlatformExampleListResponse, import("./v1.js").PlatformExampleListStreamType>;
3
3
  search(request: import("./v1.js").PlatformExampleSearchRequest): Promise<import("./v1.js").PlatformExampleSearchResponse>;
4
+ fetch(exampleId: string): ResponsePromise<import("./v1.js").PlatformExampleFetchResponse, never>;
4
5
  clone(exampleId: string): Promise<import("./v1.js").PlatformExampleCloneResponse>;
5
6
  }
6
7
  export default PlatformExampleClient;
@@ -1,5 +1,5 @@
1
1
  import { ChatBotKitClient } from '../../client.js';
2
- import { clonePlatformExample, listPlatformExamples, searchPlatformExamples, } from './v1.js';
2
+ import { clonePlatformExample, fetchPlatformExample, listPlatformExamples, searchPlatformExamples, } from './v1.js';
3
3
  export class PlatformExampleClient extends ChatBotKitClient {
4
4
  constructor(options) {
5
5
  super(options);
@@ -10,6 +10,9 @@ export class PlatformExampleClient extends ChatBotKitClient {
10
10
  search(request) {
11
11
  return searchPlatformExamples(this, request);
12
12
  }
13
+ fetch(exampleId) {
14
+ return fetchPlatformExample(this, exampleId);
15
+ }
13
16
  clone(exampleId) {
14
17
  return clonePlatformExample(this, exampleId);
15
18
  }
@@ -1,5 +1,6 @@
1
1
  export function listPlatformExamples(client: ChatBotKitClient, request?: PlatformExampleListRequest): ResponsePromise<PlatformExampleListResponse, PlatformExampleListStreamType>;
2
2
  export function searchPlatformExamples(client: ChatBotKitClient, request: PlatformExampleSearchRequest): Promise<PlatformExampleSearchResponse>;
3
+ export function fetchPlatformExample(client: ChatBotKitClient, exampleId: string): ResponsePromise<PlatformExampleFetchResponse, never>;
3
4
  export function clonePlatformExample(client: ChatBotKitClient, exampleId: string): Promise<PlatformExampleCloneResponse>;
4
5
  export type ChatBotKitClient = import("../../client.js").ChatBotKitClient;
5
6
  export type ResponsePromise<T, U> = import("../../client.js").ResponsePromise<T, U>;
@@ -15,6 +16,7 @@ export type PlatformExampleSearchRequestBody = import("../../types/api/v1.js").o
15
16
  export type PlatformExampleSearchRequest = PlatformExampleSearchRequestBody;
16
17
  export type PlatformExampleSearchResponseBody = import("../../types/api/v1.js").operations["searchPlatformExamples"]["responses"]["200"]["content"]["application/json"];
17
18
  export type PlatformExampleSearchResponse = PlatformExampleSearchResponseBody;
19
+ export type PlatformExampleFetchResponse = import("../../types/api/v1.js").operations["fetchPlatformExample"]["responses"]["200"]["content"]["application/json"];
18
20
  export type PlatformExampleCloneRequestBody = import("../../types/api/v1.js").operations["clonePlatformExample"]["requestBody"]["content"]["application/json"];
19
21
  export type PlatformExampleCloneRequest = PlatformExampleCloneRequestBody;
20
22
  export type PlatformExampleCloneResponseBody = import("../../types/api/v1.js").operations["clonePlatformExample"]["responses"]["200"]["content"]["application/json"];
@@ -12,6 +12,13 @@ export async function searchPlatformExamples(client, request) {
12
12
  });
13
13
  return response;
14
14
  }
15
+ export function fetchPlatformExample(client, exampleId) {
16
+ const url = `/api/v1/platform/example/${exampleId}/fetch`;
17
+ const response = client.clientFetch(url, {
18
+ endpoint: '/api/v1/platform/example/{exampleId}/fetch',
19
+ });
20
+ return response;
21
+ }
15
22
  export async function clonePlatformExample(client, exampleId) {
16
23
  const url = `/api/v1/platform/example/${exampleId}/clone`;
17
24
  const response = await client.clientFetch(url, {
@@ -2,7 +2,9 @@ export class PlatformClient extends ChatBotKitClient {
2
2
  model: PlatformModelClient;
3
3
  ability: PlatformAbilityClient;
4
4
  action: PlatformActionClient;
5
- content: PlatformContentClient;
5
+ doc: PlatformDocClient;
6
+ manual: PlatformManualClient;
7
+ tutorial: PlatformTutorialClient;
6
8
  secret: PlatformSecretClient;
7
9
  example: PlatformExampleClient;
8
10
  report: PlatformReportClient;
@@ -12,7 +14,9 @@ import { ChatBotKitClient } from '../client.js';
12
14
  import { PlatformModelClient } from './model/index.js';
13
15
  import { PlatformAbilityClient } from './ability/index.js';
14
16
  import { PlatformActionClient } from './action/index.js';
15
- import { PlatformContentClient } from './content/index.js';
17
+ import { PlatformDocClient } from './doc/index.js';
18
+ import { PlatformManualClient } from './manual/index.js';
19
+ import { PlatformTutorialClient } from './tutorial/index.js';
16
20
  import { PlatformSecretClient } from './secret/index.js';
17
21
  import { PlatformExampleClient } from './example/index.js';
18
22
  import { PlatformReportClient } from './report/index.js';
@@ -1,18 +1,22 @@
1
1
  import { ChatBotKitClient } from '../client.js';
2
2
  import { PlatformAbilityClient } from './ability/index.js';
3
3
  import { PlatformActionClient } from './action/index.js';
4
- import { PlatformContentClient } from './content/index.js';
4
+ import { PlatformDocClient } from './doc/index.js';
5
5
  import { PlatformExampleClient } from './example/index.js';
6
+ import { PlatformManualClient } from './manual/index.js';
6
7
  import { PlatformModelClient } from './model/index.js';
7
8
  import { PlatformReportClient } from './report/index.js';
8
9
  import { PlatformSecretClient } from './secret/index.js';
10
+ import { PlatformTutorialClient } from './tutorial/index.js';
9
11
  export class PlatformClient extends ChatBotKitClient {
10
12
  constructor(options) {
11
13
  super(options);
12
14
  this.model = new PlatformModelClient(options);
13
15
  this.ability = new PlatformAbilityClient(options);
14
16
  this.action = new PlatformActionClient(options);
15
- this.content = new PlatformContentClient(options);
17
+ this.doc = new PlatformDocClient(options);
18
+ this.manual = new PlatformManualClient(options);
19
+ this.tutorial = new PlatformTutorialClient(options);
16
20
  this.secret = new PlatformSecretClient(options);
17
21
  this.example = new PlatformExampleClient(options);
18
22
  this.report = new PlatformReportClient(options);
@@ -0,0 +1,8 @@
1
+ export class PlatformManualClient extends ChatBotKitClient {
2
+ list(request?: import("./v1.js").PlatformManualListRequest): ResponsePromise<import("./v1.js").PlatformManualListResponse, import("./v1.js").PlatformManualListStreamType>;
3
+ search(request: import("./v1.js").PlatformManualSearchRequest): Promise<import("./v1.js").PlatformManualSearchResponse>;
4
+ fetch(manualId: string): ResponsePromise<import("./v1.js").PlatformManualFetchResponse, never>;
5
+ }
6
+ export default PlatformManualClient;
7
+ export type ResponsePromise<T, U> = import("../../client.js").ResponsePromise<T, U>;
8
+ import { ChatBotKitClient } from '../../client.js';
@@ -0,0 +1,17 @@
1
+ import { ChatBotKitClient } from '../../client.js';
2
+ import { fetchPlatformManual, listPlatformManuals, searchPlatformManuals, } from './v1.js';
3
+ export class PlatformManualClient extends ChatBotKitClient {
4
+ constructor(options) {
5
+ super(options);
6
+ }
7
+ list(request) {
8
+ return listPlatformManuals(this, request);
9
+ }
10
+ search(request) {
11
+ return searchPlatformManuals(this, request);
12
+ }
13
+ fetch(manualId) {
14
+ return fetchPlatformManual(this, manualId);
15
+ }
16
+ }
17
+ export default PlatformManualClient;
@@ -0,0 +1,19 @@
1
+ export function listPlatformManuals(client: ChatBotKitClient, request?: PlatformManualListRequest): ResponsePromise<PlatformManualListResponse, PlatformManualListStreamType>;
2
+ export function searchPlatformManuals(client: ChatBotKitClient, request: PlatformManualSearchRequest): Promise<PlatformManualSearchResponse>;
3
+ export function fetchPlatformManual(client: ChatBotKitClient, manualId: string): ResponsePromise<PlatformManualFetchResponse, never>;
4
+ export type ChatBotKitClient = import("../../client.js").ChatBotKitClient;
5
+ export type ResponsePromise<T, U> = import("../../client.js").ResponsePromise<T, U>;
6
+ export type PlatformManualListRequest = {
7
+ cursor?: string;
8
+ order?: "desc" | "asc";
9
+ take?: number;
10
+ meta?: Record<string, string>;
11
+ };
12
+ export type PlatformManualListResponse = import("../../types/api/v1.js").operations["listPlatformManuals"]["responses"]["200"]["content"]["application/json"];
13
+ export type PlatformManualListItem = PlatformManualListResponse["items"][number];
14
+ export type PlatformManualListStreamType = import("../../types/api/v1.js").operations["listPlatformManuals"]["responses"]["200"]["content"]["application/jsonl"];
15
+ export type PlatformManualSearchRequestBody = import("../../types/api/v1.js").operations["searchPlatformManuals"]["requestBody"]["content"]["application/json"];
16
+ export type PlatformManualSearchRequest = PlatformManualSearchRequestBody;
17
+ export type PlatformManualSearchResponseBody = import("../../types/api/v1.js").operations["searchPlatformManuals"]["responses"]["200"]["content"]["application/json"];
18
+ export type PlatformManualSearchResponse = PlatformManualSearchResponseBody;
19
+ export type PlatformManualFetchResponse = import("../../types/api/v1.js").operations["fetchPlatformManual"]["responses"]["200"]["content"]["application/json"];
@@ -0,0 +1,21 @@
1
+ export function listPlatformManuals(client, request) {
2
+ let url = `/api/v1/platform/manual/list`;
3
+ const response = client.clientFetch(url, { query: request });
4
+ return response;
5
+ }
6
+ export async function searchPlatformManuals(client, request) {
7
+ const url = `/api/v1/platform/manual/search`;
8
+ const response = await client.clientFetch(url, {
9
+ record: {
10
+ ...request,
11
+ },
12
+ });
13
+ return response;
14
+ }
15
+ export function fetchPlatformManual(client, manualId) {
16
+ const url = `/api/v1/platform/manual/${manualId}/fetch`;
17
+ const response = client.clientFetch(url, {
18
+ endpoint: '/api/v1/platform/manual/{manualId}/fetch',
19
+ });
20
+ return response;
21
+ }
@@ -0,0 +1,8 @@
1
+ export class PlatformTutorialClient extends ChatBotKitClient {
2
+ list(request?: import("./v1.js").PlatformTutorialListRequest): ResponsePromise<import("./v1.js").PlatformTutorialListResponse, import("./v1.js").PlatformTutorialListStreamType>;
3
+ search(request: import("./v1.js").PlatformTutorialSearchRequest): Promise<import("./v1.js").PlatformTutorialSearchResponse>;
4
+ fetch(tutorialId: string): ResponsePromise<import("./v1.js").PlatformTutorialFetchResponse, never>;
5
+ }
6
+ export default PlatformTutorialClient;
7
+ export type ResponsePromise<T, U> = import("../../client.js").ResponsePromise<T, U>;
8
+ import { ChatBotKitClient } from '../../client.js';
@@ -0,0 +1,17 @@
1
+ import { ChatBotKitClient } from '../../client.js';
2
+ import { fetchPlatformTutorial, listPlatformTutorials, searchPlatformTutorials, } from './v1.js';
3
+ export class PlatformTutorialClient extends ChatBotKitClient {
4
+ constructor(options) {
5
+ super(options);
6
+ }
7
+ list(request) {
8
+ return listPlatformTutorials(this, request);
9
+ }
10
+ search(request) {
11
+ return searchPlatformTutorials(this, request);
12
+ }
13
+ fetch(tutorialId) {
14
+ return fetchPlatformTutorial(this, tutorialId);
15
+ }
16
+ }
17
+ export default PlatformTutorialClient;
@@ -0,0 +1,19 @@
1
+ export function listPlatformTutorials(client: ChatBotKitClient, request?: PlatformTutorialListRequest): ResponsePromise<PlatformTutorialListResponse, PlatformTutorialListStreamType>;
2
+ export function searchPlatformTutorials(client: ChatBotKitClient, request: PlatformTutorialSearchRequest): Promise<PlatformTutorialSearchResponse>;
3
+ export function fetchPlatformTutorial(client: ChatBotKitClient, tutorialId: string): ResponsePromise<PlatformTutorialFetchResponse, never>;
4
+ export type ChatBotKitClient = import("../../client.js").ChatBotKitClient;
5
+ export type ResponsePromise<T, U> = import("../../client.js").ResponsePromise<T, U>;
6
+ export type PlatformTutorialListRequest = {
7
+ cursor?: string;
8
+ order?: "desc" | "asc";
9
+ take?: number;
10
+ meta?: Record<string, string>;
11
+ };
12
+ export type PlatformTutorialListResponse = import("../../types/api/v1.js").operations["listPlatformTutorials"]["responses"]["200"]["content"]["application/json"];
13
+ export type PlatformTutorialListItem = PlatformTutorialListResponse["items"][number];
14
+ export type PlatformTutorialListStreamType = import("../../types/api/v1.js").operations["listPlatformTutorials"]["responses"]["200"]["content"]["application/jsonl"];
15
+ export type PlatformTutorialSearchRequestBody = import("../../types/api/v1.js").operations["searchPlatformTutorials"]["requestBody"]["content"]["application/json"];
16
+ export type PlatformTutorialSearchRequest = PlatformTutorialSearchRequestBody;
17
+ export type PlatformTutorialSearchResponseBody = import("../../types/api/v1.js").operations["searchPlatformTutorials"]["responses"]["200"]["content"]["application/json"];
18
+ export type PlatformTutorialSearchResponse = PlatformTutorialSearchResponseBody;
19
+ export type PlatformTutorialFetchResponse = import("../../types/api/v1.js").operations["fetchPlatformTutorial"]["responses"]["200"]["content"]["application/json"];
@@ -0,0 +1,21 @@
1
+ export function listPlatformTutorials(client, request) {
2
+ let url = `/api/v1/platform/tutorial/list`;
3
+ const response = client.clientFetch(url, { query: request });
4
+ return response;
5
+ }
6
+ export async function searchPlatformTutorials(client, request) {
7
+ const url = `/api/v1/platform/tutorial/search`;
8
+ const response = await client.clientFetch(url, {
9
+ record: {
10
+ ...request,
11
+ },
12
+ });
13
+ return response;
14
+ }
15
+ export function fetchPlatformTutorial(client, tutorialId) {
16
+ const url = `/api/v1/platform/tutorial/${tutorialId}/fetch`;
17
+ const response = client.clientFetch(url, {
18
+ endpoint: '/api/v1/platform/tutorial/{tutorialId}/fetch',
19
+ });
20
+ return response;
21
+ }
@@ -1,6 +1,6 @@
1
1
  export class ReportClient extends ChatBotKitClient {
2
- fetch(reportId: string, request: import("./v1.js").ReportFetchRequest): Promise<import("./v1.js").ReportFetchResponse>;
3
- fetchTyped<T extends import("./v1.js").ReportId>(reportId: T, request: import("./v1.js").ReportInputTypes[T]): Promise<import("./v1.js").ReportOutputTypes[T]>;
2
+ generate(reportId: string, request: import("./v1.js").ReportGenerateRequest): Promise<import("./v1.js").ReportGenerateResponse>;
3
+ generateTyped<T extends import("./v1.js").ReportId>(reportId: T, request: import("./v1.js").ReportInputTypes[T]): Promise<import("./v1.js").ReportOutputTypes[T]>;
4
4
  }
5
5
  export default ReportClient;
6
6
  import { ChatBotKitClient } from '../client.js';
@@ -1,14 +1,14 @@
1
1
  import { ChatBotKitClient } from '../client.js';
2
- import { fetchReport, fetchTypedReport } from './v1.js';
2
+ import { generateReport, generateTypedReport } from './v1.js';
3
3
  export class ReportClient extends ChatBotKitClient {
4
4
  constructor(options) {
5
5
  super(options);
6
6
  }
7
- fetch(reportId, request) {
8
- return fetchReport(this, reportId, request);
7
+ generate(reportId, request) {
8
+ return generateReport(this, reportId, request);
9
9
  }
10
- fetchTyped(reportId, request) {
11
- return fetchTypedReport(this, reportId, request);
10
+ generateTyped(reportId, request) {
11
+ return generateTypedReport(this, reportId, request);
12
12
  }
13
13
  }
14
14
  export default ReportClient;
@@ -1,9 +1,9 @@
1
- export function fetchReport(client: ChatBotKitClient, reportId: string, request: ReportFetchRequest): Promise<ReportFetchResponse>;
2
- export function fetchTypedReport<T extends ReportId>(client: ChatBotKitClient, reportId: T, request: ReportInputTypes[T]): Promise<ReportOutputTypes[T]>;
1
+ export function generateReport(client: ChatBotKitClient, reportId: string, request: ReportGenerateRequest): Promise<ReportGenerateResponse>;
2
+ export function generateTypedReport<T extends ReportId>(client: ChatBotKitClient, reportId: T, request: ReportInputTypes[T]): Promise<ReportOutputTypes[T]>;
3
3
  export type ChatBotKitClient = import("../client.js").ChatBotKitClient;
4
- export type ReportFetchRequestBody = import("../types/api/v1.js").operations["fetchReport"]["requestBody"]["content"]["application/json"];
5
- export type ReportFetchRequest = ReportFetchRequestBody;
6
- export type ReportFetchResponse = import("../types/api/v1.js").operations["fetchReport"]["responses"]["200"]["content"]["application/json"];
4
+ export type ReportGenerateRequestBody = import("../types/api/v1.js").operations["generateReport"]["requestBody"]["content"]["application/json"];
5
+ export type ReportGenerateRequest = ReportGenerateRequestBody;
6
+ export type ReportGenerateResponse = import("../types/api/v1.js").operations["generateReport"]["responses"]["200"]["content"]["application/json"];
7
7
  export type ReportId = import("../types/report.js").ReportId;
8
8
  export type ReportInputTypes = import("../types/report.js").ReportInputTypes;
9
9
  export type ReportOutputTypes = import("../types/report.js").ReportOutputTypes;
@@ -1,5 +1,5 @@
1
- export async function fetchReport(client, reportId, request) {
2
- const url = `/api/v1/report/${reportId}/fetch`;
1
+ export async function generateReport(client, reportId, request) {
2
+ const url = `/api/v1/report/${reportId}/generate`;
3
3
  const response = await client.clientFetch(url, {
4
4
  record: {
5
5
  ...request,
@@ -7,8 +7,8 @@ export async function fetchReport(client, reportId, request) {
7
7
  });
8
8
  return response;
9
9
  }
10
- export async function fetchTypedReport(client, reportId, request) {
11
- const url = `/api/v1/report/${reportId}/fetch`;
10
+ export async function generateTypedReport(client, reportId, request) {
11
+ const url = `/api/v1/report/${reportId}/generate`;
12
12
  const response = await client.clientFetch(url, {
13
13
  record: {
14
14
  ...request,