@chatbotkit/sdk 1.15.1 → 1.15.3

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 (63) hide show
  1. package/dist/cjs/blueprint/index.cjs +30 -0
  2. package/dist/cjs/blueprint/index.d.ts +11 -0
  3. package/dist/cjs/blueprint/v1.cjs +51 -0
  4. package/dist/cjs/blueprint/v1.d.ts +49 -0
  5. package/dist/cjs/contact/index.d.ts +3 -3
  6. package/dist/cjs/contact/v1.d.ts +1 -0
  7. package/dist/cjs/index.cjs +36 -31
  8. package/dist/cjs/index.d.ts +5 -1
  9. package/dist/cjs/integration/discord/index.d.ts +3 -3
  10. package/dist/cjs/integration/discord/v1.d.ts +1 -0
  11. package/dist/cjs/integration/slack/index.d.ts +3 -3
  12. package/dist/cjs/integration/slack/v1.d.ts +1 -0
  13. package/dist/cjs/integration/trigger/index.d.ts +4 -4
  14. package/dist/cjs/integration/trigger/v1.d.ts +1 -0
  15. package/dist/cjs/platform/ability/index.cjs +15 -0
  16. package/dist/cjs/platform/ability/index.d.ts +6 -0
  17. package/dist/cjs/platform/ability/v1.cjs +9 -0
  18. package/dist/cjs/platform/ability/v1.d.ts +27 -0
  19. package/dist/cjs/platform/index.cjs +17 -0
  20. package/dist/cjs/platform/index.d.ts +10 -0
  21. package/dist/cjs/platform/model/index.cjs +15 -0
  22. package/dist/cjs/platform/model/index.d.ts +6 -0
  23. package/dist/cjs/platform/model/v1.cjs +9 -0
  24. package/dist/cjs/platform/model/v1.d.ts +27 -0
  25. package/dist/cjs/platform/secret/index.cjs +15 -0
  26. package/dist/cjs/platform/secret/index.d.ts +6 -0
  27. package/dist/cjs/platform/secret/v1.cjs +9 -0
  28. package/dist/cjs/platform/secret/v1.d.ts +27 -0
  29. package/dist/cjs/platform/v1.cjs +0 -0
  30. package/dist/cjs/platform/v1.d.ts +0 -0
  31. package/dist/cjs/secret/v1.d.ts +1 -0
  32. package/dist/cjs/skillset/ability/v1.d.ts +1 -0
  33. package/dist/esm/blueprint/index.d.ts +11 -0
  34. package/dist/esm/blueprint/index.js +26 -0
  35. package/dist/esm/blueprint/v1.d.ts +49 -0
  36. package/dist/esm/blueprint/v1.js +42 -0
  37. package/dist/esm/contact/v1.d.ts +1 -0
  38. package/dist/esm/index.d.ts +5 -1
  39. package/dist/esm/index.js +5 -0
  40. package/dist/esm/integration/discord/v1.d.ts +1 -0
  41. package/dist/esm/integration/slack/v1.d.ts +1 -0
  42. package/dist/esm/integration/trigger/v1.d.ts +1 -0
  43. package/dist/esm/platform/ability/index.d.ts +6 -0
  44. package/dist/esm/platform/ability/index.js +11 -0
  45. package/dist/esm/platform/ability/v1.d.ts +27 -0
  46. package/dist/esm/platform/ability/v1.js +5 -0
  47. package/dist/esm/platform/index.d.ts +10 -0
  48. package/dist/esm/platform/index.js +13 -0
  49. package/dist/esm/platform/model/index.d.ts +6 -0
  50. package/dist/esm/platform/model/index.js +11 -0
  51. package/dist/esm/platform/model/v1.d.ts +27 -0
  52. package/dist/esm/platform/model/v1.js +5 -0
  53. package/dist/esm/platform/secret/index.d.ts +6 -0
  54. package/dist/esm/platform/secret/index.js +11 -0
  55. package/dist/esm/platform/secret/v1.d.ts +27 -0
  56. package/dist/esm/platform/secret/v1.js +5 -0
  57. package/dist/esm/platform/v1.d.ts +1 -0
  58. package/dist/esm/platform/v1.js +1 -0
  59. package/dist/esm/secret/v1.d.ts +1 -0
  60. package/dist/esm/skillset/ability/v1.d.ts +1 -0
  61. package/dist/tsconfig.cjs.tsbuildinfo +1 -1
  62. package/dist/tsconfig.esm.tsbuildinfo +1 -1
  63. package/package.json +251 -1
@@ -0,0 +1,49 @@
1
+ export function listBlueprints(client: ChatBotKitClient, request?: BlueprintListRequest | undefined): ResponsePromise<BlueprintListResponse, BlueprintListStreamType>;
2
+ export function fetchBlueprint(client: ChatBotKitClient, blueprintId: string): Promise<BlueprintFetchResponse>;
3
+ export function createBlueprint(client: ChatBotKitClient, request: BlueprintCreateRequest): Promise<BlueprintCreateResponse>;
4
+ export function updateBlueprint(client: ChatBotKitClient, blueprintId: string, request: BlueprintUpdateRequest): Promise<BlueprintUpdateResponse>;
5
+ export function deleteBlueprint(client: ChatBotKitClient, blueprintId: string): Promise<BlueprintDeleteResponse>;
6
+ export function cloneBlueprint(client: ChatBotKitClient, blueprintId: string): Promise<BlueprintCloneResponse>;
7
+ export type ChatBotKitClient = import('../client.js').ChatBotKitClient;
8
+ export type ResponsePromise<T, U> = import('../client.js').ResponsePromise<T, U>;
9
+ export type BlueprintOptions = {
10
+ name?: string;
11
+ description?: string;
12
+ meta?: Record<string, any>;
13
+ };
14
+ export type BlueprintInstance = BlueprintOptions & {
15
+ id: string;
16
+ createdAt: number;
17
+ updatedAt: number;
18
+ };
19
+ export type BlueprintListRequest = {
20
+ cursor?: string;
21
+ order?: 'desc' | 'asc';
22
+ take?: number;
23
+ meta?: Record<string, string>;
24
+ };
25
+ export type BlueprintListResponse = {
26
+ items: BlueprintInstance[];
27
+ };
28
+ export type BlueprintListStreamItemType = {
29
+ type: 'item';
30
+ data: BlueprintInstance;
31
+ };
32
+ export type BlueprintListStreamType = BlueprintListStreamItemType;
33
+ export type BlueprintFetchResponse = BlueprintInstance & {};
34
+ export type BlueprintCreateRequest = BlueprintOptions & {
35
+ model?: import('../model/v1.js').Model;
36
+ };
37
+ export type BlueprintCreateResponse = {
38
+ id: string;
39
+ };
40
+ export type BlueprintUpdateRequest = BlueprintOptions & {};
41
+ export type BlueprintUpdateResponse = {
42
+ id: string;
43
+ };
44
+ export type BlueprintDeleteResponse = {
45
+ id: string;
46
+ };
47
+ export type BlueprintCloneResponse = {
48
+ id: string;
49
+ };
@@ -0,0 +1,42 @@
1
+ export function listBlueprints(client, request) {
2
+ let url = `/api/v1/blueprint/list`;
3
+ const response = client.clientFetch(url, { query: request });
4
+ return response;
5
+ }
6
+ export async function fetchBlueprint(client, blueprintId) {
7
+ const url = `/api/v1/blueprint/${blueprintId}/fetch`;
8
+ const response = await client.clientFetch(url);
9
+ return response;
10
+ }
11
+ export async function createBlueprint(client, request) {
12
+ const url = `/api/v1/blueprint/create`;
13
+ const response = await client.clientFetch(url, {
14
+ record: {
15
+ ...request,
16
+ },
17
+ });
18
+ return response;
19
+ }
20
+ export async function updateBlueprint(client, blueprintId, request) {
21
+ const url = `/api/v1/blueprint/${blueprintId}/update`;
22
+ const response = await client.clientFetch(url, {
23
+ record: {
24
+ ...request,
25
+ },
26
+ });
27
+ return response;
28
+ }
29
+ export async function deleteBlueprint(client, blueprintId) {
30
+ const url = `/api/v1/blueprint/${blueprintId}/delete`;
31
+ const response = await client.clientFetch(url, {
32
+ record: {},
33
+ });
34
+ return response;
35
+ }
36
+ export async function cloneBlueprint(client, blueprintId) {
37
+ const url = `/api/v1/blueprint/${blueprintId}/clone`;
38
+ const response = await client.clientFetch(url, {
39
+ record: {},
40
+ });
41
+ return response;
42
+ }
@@ -11,6 +11,7 @@ export type ContactOptions = {
11
11
  fingerprint?: string;
12
12
  email?: string;
13
13
  phone?: string;
14
+ nick?: string;
14
15
  meta?: Record<string, any>;
15
16
  };
16
17
  export type ContactInstance = ContactOptions & {
@@ -1,4 +1,6 @@
1
1
  export class ChatBotKit extends ChatBotKitClient {
2
+ platform: PlatformClient;
3
+ blueprint: BlueprintClient;
2
4
  bot: BotClient;
3
5
  file: FileClient;
4
6
  magic: MagicClient;
@@ -21,5 +23,7 @@ import { IntegrationClient } from './integration/index.js';
21
23
  import { ConversationClient } from './conversation/index.js';
22
24
  import { ContactClient } from './contact/index.js';
23
25
  import { SecretClient } from './secret/index.js';
26
+ import { BlueprintClient } from './blueprint/index.js';
24
27
  import { ChatBotKitClient } from './client.js';
25
- export { BotClient, FileClient, MagicClient, PartnerClient, DatasetClient, SkillsetClient, IntegrationClient, ConversationClient, ContactClient, SecretClient };
28
+ import { PlatformClient } from './platform/index.js';
29
+ export { BotClient, FileClient, MagicClient, PartnerClient, DatasetClient, SkillsetClient, IntegrationClient, ConversationClient, ContactClient, SecretClient, BlueprintClient };
package/dist/esm/index.js CHANGED
@@ -1,3 +1,4 @@
1
+ import { BlueprintClient } from './blueprint/index.js';
1
2
  import { BotClient } from './bot/index.js';
2
3
  import { ChatBotKitClient } from './client.js';
3
4
  import { ContactClient } from './contact/index.js';
@@ -7,6 +8,7 @@ import { FileClient } from './file/index.js';
7
8
  import { IntegrationClient } from './integration/index.js';
8
9
  import { MagicClient } from './magic/index.js';
9
10
  import { PartnerClient } from './partner/index.js';
11
+ import { PlatformClient } from './platform/index.js';
10
12
  import { SecretClient } from './secret/index.js';
11
13
  import { SkillsetClient } from './skillset/index.js';
12
14
  export { BotClient };
@@ -19,9 +21,12 @@ export { IntegrationClient };
19
21
  export { ConversationClient };
20
22
  export { ContactClient };
21
23
  export { SecretClient };
24
+ export { BlueprintClient };
22
25
  export class ChatBotKit extends ChatBotKitClient {
23
26
  constructor(options) {
24
27
  super(options);
28
+ this.platform = new PlatformClient(options);
29
+ this.blueprint = new BlueprintClient(options);
25
30
  this.bot = new BotClient(options);
26
31
  this.file = new FileClient(options);
27
32
  this.magic = new MagicClient(options);
@@ -25,6 +25,7 @@ export type DiscordIntegrationOptions = BotRefOrConfig & {
25
25
  botToken?: string;
26
26
  publicKey?: string;
27
27
  handle?: string;
28
+ contactCollection?: boolean;
28
29
  sessionDuration?: number;
29
30
  meta?: Record<string, any>;
30
31
  };
@@ -24,6 +24,7 @@ export type SlackIntegrationOptions = BotRefOrConfig & {
24
24
  signingSecret?: string;
25
25
  botToken?: string;
26
26
  visibleMessages?: number;
27
+ contactCollection?: boolean;
27
28
  sessionDuration?: number;
28
29
  meta?: Record<string, any>;
29
30
  };
@@ -23,6 +23,7 @@ export type TriggerIntegrationOptions = BotRefOrConfig & {
23
23
  name?: string;
24
24
  description?: string;
25
25
  authenticate?: boolean;
26
+ triggerSchedule?: "never" | "quarterhourly" | "halfhourly" | "hourly" | "daily" | "weekly" | "monthly";
26
27
  sessionDuration?: number;
27
28
  meta?: Record<string, any>;
28
29
  };
@@ -0,0 +1,6 @@
1
+ export class PlatformAbilityClient extends ChatBotKitClient {
2
+ list(request?: import("./v1.js").PlatformAbilityListRequest | undefined): ResponsePromise<import('./v1.js').PlatformAbilityListResponse, import('./v1.js').PlatformAbilityListStreamType>;
3
+ }
4
+ export default PlatformAbilityClient;
5
+ export type ResponsePromise<T, U> = import('../../client.js').ResponsePromise<T, U>;
6
+ import { ChatBotKitClient } from '../../client.js';
@@ -0,0 +1,11 @@
1
+ import { ChatBotKitClient } from '../../client.js';
2
+ import { listPlatformAbilities } from './v1.js';
3
+ export class PlatformAbilityClient extends ChatBotKitClient {
4
+ constructor(options) {
5
+ super(options);
6
+ }
7
+ list(request) {
8
+ return listPlatformAbilities(this, request);
9
+ }
10
+ }
11
+ export default PlatformAbilityClient;
@@ -0,0 +1,27 @@
1
+ export function listPlatformAbilities(client: ChatBotKitClient, request?: PlatformAbilityListRequest | undefined): ResponsePromise<PlatformAbilityListResponse, PlatformAbilityListStreamType>;
2
+ export type ChatBotKitClient = import('../../client.js').ChatBotKitClient;
3
+ export type ResponsePromise<T, U> = import('../../client.js').ResponsePromise<T, U>;
4
+ export type PlatformAbilityOptions = {
5
+ name?: string;
6
+ description?: string;
7
+ meta?: Record<string, any>;
8
+ };
9
+ export type PlatformAbilityInstance = PlatformAbilityOptions & {
10
+ id: string;
11
+ createdAt: number;
12
+ updatedAt: number;
13
+ };
14
+ export type PlatformAbilityListRequest = {
15
+ cursor?: string;
16
+ order?: 'desc' | 'asc';
17
+ take?: number;
18
+ meta?: Record<string, string>;
19
+ };
20
+ export type PlatformAbilityListResponse = {
21
+ items: PlatformAbilityInstance[];
22
+ };
23
+ export type PlatformAbilityListStreamItemType = {
24
+ type: 'item';
25
+ data: PlatformAbilityInstance;
26
+ };
27
+ export type PlatformAbilityListStreamType = PlatformAbilityListStreamItemType;
@@ -0,0 +1,5 @@
1
+ export function listPlatformAbilities(client, request) {
2
+ let url = `/api/v1/platform/ability/list`;
3
+ const response = client.clientFetch(url, { query: request });
4
+ return response;
5
+ }
@@ -0,0 +1,10 @@
1
+ export class PlatformClient extends ChatBotKitClient {
2
+ user: PlatformModelClient;
3
+ ability: PlatformAbilityClient;
4
+ secrets: PlatformSecretClient;
5
+ }
6
+ export default PlatformClient;
7
+ import { ChatBotKitClient } from '../client.js';
8
+ import { PlatformModelClient } from './model/index.js';
9
+ import { PlatformAbilityClient } from './ability/index.js';
10
+ import { PlatformSecretClient } from './secret/index.js';
@@ -0,0 +1,13 @@
1
+ import { ChatBotKitClient } from '../client.js';
2
+ import { PlatformAbilityClient } from './ability/index.js';
3
+ import { PlatformModelClient } from './model/index.js';
4
+ import { PlatformSecretClient } from './secret/index.js';
5
+ export class PlatformClient extends ChatBotKitClient {
6
+ constructor(options) {
7
+ super(options);
8
+ this.user = new PlatformModelClient(options);
9
+ this.ability = new PlatformAbilityClient(options);
10
+ this.secrets = new PlatformSecretClient(options);
11
+ }
12
+ }
13
+ export default PlatformClient;
@@ -0,0 +1,6 @@
1
+ export class PlatformModelClient extends ChatBotKitClient {
2
+ list(request?: import("./v1.js").PlatformModelListRequest | undefined): ResponsePromise<import('./v1.js').PlatformModelListResponse, import('./v1.js').PlatformModelListStreamType>;
3
+ }
4
+ export default PlatformModelClient;
5
+ export type ResponsePromise<T, U> = import('../../client.js').ResponsePromise<T, U>;
6
+ import { ChatBotKitClient } from '../../client.js';
@@ -0,0 +1,11 @@
1
+ import { ChatBotKitClient } from '../../client.js';
2
+ import { listPlatformModels } from './v1.js';
3
+ export class PlatformModelClient extends ChatBotKitClient {
4
+ constructor(options) {
5
+ super(options);
6
+ }
7
+ list(request) {
8
+ return listPlatformModels(this, request);
9
+ }
10
+ }
11
+ export default PlatformModelClient;
@@ -0,0 +1,27 @@
1
+ export function listPlatformModels(client: ChatBotKitClient, request?: PlatformModelListRequest | undefined): ResponsePromise<PlatformModelListResponse, PlatformModelListStreamType>;
2
+ export type ChatBotKitClient = import('../../client.js').ChatBotKitClient;
3
+ export type ResponsePromise<T, U> = import('../../client.js').ResponsePromise<T, U>;
4
+ export type PlatformModelOptions = {
5
+ name?: string;
6
+ description?: string;
7
+ meta?: Record<string, any>;
8
+ };
9
+ export type PlatformModelInstance = PlatformModelOptions & {
10
+ id: string;
11
+ createdAt: number;
12
+ updatedAt: number;
13
+ };
14
+ export type PlatformModelListRequest = {
15
+ cursor?: string;
16
+ order?: 'desc' | 'asc';
17
+ take?: number;
18
+ meta?: Record<string, string>;
19
+ };
20
+ export type PlatformModelListResponse = {
21
+ items: PlatformModelInstance[];
22
+ };
23
+ export type PlatformModelListStreamItemType = {
24
+ type: 'item';
25
+ data: PlatformModelInstance;
26
+ };
27
+ export type PlatformModelListStreamType = PlatformModelListStreamItemType;
@@ -0,0 +1,5 @@
1
+ export function listPlatformModels(client, request) {
2
+ let url = `/api/v1/platform/model/list`;
3
+ const response = client.clientFetch(url, { query: request });
4
+ return response;
5
+ }
@@ -0,0 +1,6 @@
1
+ export class PlatformSecretClient extends ChatBotKitClient {
2
+ list(request?: import("./v1.js").PlatformSecretListRequest | undefined): ResponsePromise<import('./v1.js').PlatformSecretListResponse, import('./v1.js').PlatformSecretListStreamType>;
3
+ }
4
+ export default PlatformSecretClient;
5
+ export type ResponsePromise<T, U> = import('../../client.js').ResponsePromise<T, U>;
6
+ import { ChatBotKitClient } from '../../client.js';
@@ -0,0 +1,11 @@
1
+ import { ChatBotKitClient } from '../../client.js';
2
+ import { listPlatformSecrets } from './v1.js';
3
+ export class PlatformSecretClient extends ChatBotKitClient {
4
+ constructor(options) {
5
+ super(options);
6
+ }
7
+ list(request) {
8
+ return listPlatformSecrets(this, request);
9
+ }
10
+ }
11
+ export default PlatformSecretClient;
@@ -0,0 +1,27 @@
1
+ export function listPlatformSecrets(client: ChatBotKitClient, request?: PlatformSecretListRequest | undefined): ResponsePromise<PlatformSecretListResponse, PlatformSecretListStreamType>;
2
+ export type ChatBotKitClient = import('../../client.js').ChatBotKitClient;
3
+ export type ResponsePromise<T, U> = import('../../client.js').ResponsePromise<T, U>;
4
+ export type PlatformSecretOptions = {
5
+ name?: string;
6
+ description?: string;
7
+ meta?: Record<string, any>;
8
+ };
9
+ export type PlatformSecretInstance = PlatformSecretOptions & {
10
+ id: string;
11
+ createdAt: number;
12
+ updatedAt: number;
13
+ };
14
+ export type PlatformSecretListRequest = {
15
+ cursor?: string;
16
+ order?: 'desc' | 'asc';
17
+ take?: number;
18
+ meta?: Record<string, string>;
19
+ };
20
+ export type PlatformSecretListResponse = {
21
+ items: PlatformSecretInstance[];
22
+ };
23
+ export type PlatformSecretListStreamItemType = {
24
+ type: 'item';
25
+ data: PlatformSecretInstance;
26
+ };
27
+ export type PlatformSecretListStreamType = PlatformSecretListStreamItemType;
@@ -0,0 +1,5 @@
1
+ export function listPlatformSecrets(client, request) {
2
+ let url = `/api/v1/platform/secret/list`;
3
+ const response = client.clientFetch(url, { query: request });
4
+ return response;
5
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1 @@
1
+ export {};
@@ -8,6 +8,7 @@ export type ResponsePromise<T, U> = import('../client.js').ResponsePromise<T, U>
8
8
  export type SecretOptions = {
9
9
  name?: string;
10
10
  description?: string;
11
+ kind?: 'shared' | 'personal';
11
12
  type?: 'plain' | 'basic' | 'bearer' | 'oauth' | 'template';
12
13
  value?: string;
13
14
  meta?: Record<string, any>;
@@ -6,6 +6,7 @@ export function deleteSkillsetAbility(client: ChatBotKitClient, skillsetId: stri
6
6
  export type ChatBotKitClient = import('../../client.js').ChatBotKitClient;
7
7
  export type ResponsePromise<T, U> = import('../../client.js').ResponsePromise<T, U>;
8
8
  export type SkillsetAbilityOptions = {
9
+ secretId?: string;
9
10
  name: string;
10
11
  description: string;
11
12
  instruction: string;