Class Solution

Represents a solution.

Constructors

constructor

new Solution(
    config: {
        resources: (
            | { id?: string; properties: {}; slug?: string; type: "blueprint" }
            | { id?: string; properties: {}; slug?: string; type: "bot" }
            | { id?: string; properties: {}; slug?: string; type: "dataset" }
            | { id?: string; properties: {}; slug?: string; type: "file" }
            | { id?: string; properties: {}; slug?: string; type: "space" }
            | { id?: string; properties: {}; slug?: string; type: "secret" }
            | { id?: string; properties: {}; slug?: string; type: "skillset" }
            | { id?: string; properties: {}; slug?: string; type: "task" }
            | {
                id?: string;
                properties: {};
                slug?: string;
                type: "widgetIntegration";
            }
            | {
                id?: string;
                properties: {};
                slug?: string;
                type: "sitemapIntegration";
            }
            | {
                id?: string;
                properties: {};
                slug?: string;
                type: "slackIntegration";
            }
            | {
                id?: string;
                properties: {};
                slug?: string;
                type: "discordIntegration";
            }
            | {
                id?: string;
                properties: {};
                slug?: string;
                type: "telegramIntegration";
            }
            | {
                id?: string;
                properties: {};
                slug?: string;
                type: "whatsappIntegration";
            }
            | {
                id?: string;
                properties: {};
                slug?: string;
                type: "messengerIntegration";
            }
            | {
                id?: string;
                properties: {};
                slug?: string;
                type: "notionIntegration";
            }
            | {
                id?: string;
                properties: {};
                slug?: string;
                type: "emailIntegration";
            }
            | {
                id?: string;
                properties: {};
                slug?: string;
                type: "triggerIntegration";
            }
            | {
                id?: string;
                properties: {};
                slug?: string;
                type: "supportIntegration";
            }
            | {
                id?: string;
                properties: {};
                slug?: string;
                type: "extractIntegration";
            }
            | {
                id?: string;
                properties: {};
                slug?: string;
                type: "mcpserverIntegration";
            }
            | {
                id?: string;
                properties: {};
                slug?: string;
                type: "twilioIntegration";
            }
        )[];
        version: 1;
    },
): Solution
Parameters
- config: {
      resources: (
          | { id?: string; properties: {}; slug?: string; type: "blueprint" }
          | { id?: string; properties: {}; slug?: string; type: "bot" }
          | { id?: string; properties: {}; slug?: string; type: "dataset" }
          | { id?: string; properties: {}; slug?: string; type: "file" }
          | { id?: string; properties: {}; slug?: string; type: "space" }
          | { id?: string; properties: {}; slug?: string; type: "secret" }
          | { id?: string; properties: {}; slug?: string; type: "skillset" }
          | { id?: string; properties: {}; slug?: string; type: "task" }
          | {
              id?: string;
              properties: {};
              slug?: string;
              type: "widgetIntegration";
          }
          | {
              id?: string;
              properties: {};
              slug?: string;
              type: "sitemapIntegration";
          }
          | { id?: string; properties: {}; slug?: string; type: "slackIntegration" }
          | {
              id?: string;
              properties: {};
              slug?: string;
              type: "discordIntegration";
          }
          | {
              id?: string;
              properties: {};
              slug?: string;
              type: "telegramIntegration";
          }
          | {
              id?: string;
              properties: {};
              slug?: string;
              type: "whatsappIntegration";
          }
          | {
              id?: string;
              properties: {};
              slug?: string;
              type: "messengerIntegration";
          }
          | {
              id?: string;
              properties: {};
              slug?: string;
              type: "notionIntegration";
          }
          | { id?: string; properties: {}; slug?: string; type: "emailIntegration" }
          | {
              id?: string;
              properties: {};
              slug?: string;
              type: "triggerIntegration";
          }
          | {
              id?: string;
              properties: {};
              slug?: string;
              type: "supportIntegration";
          }
          | {
              id?: string;
              properties: {};
              slug?: string;
              type: "extractIntegration";
          }
          | {
              id?: string;
              properties: {};
              slug?: string;
              type: "mcpserverIntegration";
          }
          | {
              id?: string;
              properties: {};
              slug?: string;
              type: "twilioIntegration";
          }
      )[];
      version: 1;
  }
Returns Solution
- Defined in packages/cli/src/solution/index.js:1100

Accessors

baseClient

get baseClient(): ChatBotKit
Returns ChatBotKit
- Defined in packages/cli/src/solution/index.js:1107

blueprint

get blueprint(): { [key: string]: BlueprintResource | undefined }
Returns { [key: string]: BlueprintResource | undefined }
- Defined in packages/cli/src/solution/index.js:1190

blueprints

get blueprints(): BlueprintResource[]
Returns BlueprintResource[]
- Defined in packages/cli/src/solution/index.js:1181

bot

get bot(): { [key: string]: BotResource | undefined }
Returns { [key: string]: BotResource | undefined }
- Defined in packages/cli/src/solution/index.js:1206

bots

get bots(): BotResource[]
Returns BotResource[]
- Defined in packages/cli/src/solution/index.js:1197

dataset

get dataset(): { [key: string]: DatasetResource | undefined }
Returns { [key: string]: DatasetResource | undefined }
- Defined in packages/cli/src/solution/index.js:1222

datasets

get datasets(): DatasetResource[]
Returns DatasetResource[]
- Defined in packages/cli/src/solution/index.js:1213

discordIntegration

get discordIntegration(): {
[key: string]: DiscordIntegrationResource
| undefined;
}
Returns { [key: string]: DiscordIntegrationResource | undefined }
- Defined in packages/cli/src/solution/index.js:1374

discordIntegrations

get discordIntegrations(): DiscordIntegrationResource[]
Returns DiscordIntegrationResource[]
- Defined in packages/cli/src/solution/index.js:1363

emailIntegration

get emailIntegration(): { [key: string]: EmailIntegrationResource | undefined }
Returns { [key: string]: EmailIntegrationResource | undefined }
- Defined in packages/cli/src/solution/index.js:1464

emailIntegrations

get emailIntegrations(): EmailIntegrationResource[]
Returns EmailIntegrationResource[]
- Defined in packages/cli/src/solution/index.js:1453

extractIntegration

get extractIntegration(): {
[key: string]: ExtractIntegrationResource
| undefined;
}
Returns { [key: string]: ExtractIntegrationResource | undefined }
- Defined in packages/cli/src/solution/index.js:1518

extractIntegrations

get extractIntegrations(): ExtractIntegrationResource[]
Returns ExtractIntegrationResource[]
- Defined in packages/cli/src/solution/index.js:1507

file

get file(): { [key: string]: FileResource | undefined }
Returns { [key: string]: FileResource | undefined }
- Defined in packages/cli/src/solution/index.js:1238

files

get files(): FileResource[]
Returns FileResource[]
- Defined in packages/cli/src/solution/index.js:1229

mcpserverIntegration

get mcpserverIntegration(): {
[key: string]: McpServerIntegrationResource
| undefined;
}
Returns { [key: string]: McpServerIntegrationResource | undefined }
- Defined in packages/cli/src/solution/index.js:1536

mcpserverIntegrations

get mcpserverIntegrations(): McpServerIntegrationResource[]
Returns McpServerIntegrationResource[]
- Defined in packages/cli/src/solution/index.js:1525

messengerIntegration

get messengerIntegration(): {
[key: string]: MessengerIntegrationResource
| undefined;
}
Returns { [key: string]: MessengerIntegrationResource | undefined }
- Defined in packages/cli/src/solution/index.js:1428

messengerIntegrations

get messengerIntegrations(): MessengerIntegrationResource[]
Returns MessengerIntegrationResource[]
- Defined in packages/cli/src/solution/index.js:1417

notionIntegration

get notionIntegration(): {
[key: string]: NotionIntegrationResource
| undefined;
}
Returns { [key: string]: NotionIntegrationResource | undefined }
- Defined in packages/cli/src/solution/index.js:1446

notionIntegrations

get notionIntegrations(): NotionIntegrationResource[]
Returns NotionIntegrationResource[]
- Defined in packages/cli/src/solution/index.js:1435

resources

get resources(): (
    | BlueprintResource
    | BotResource
    | DatasetResource
    | FileResource
    | SpaceResource
    | SecretResource
    | SkillsetResource
    | TaskResource
    | WidgetIntegrationResource
    | SitemapIntegrationResource
    | SlackIntegrationResource
    | DiscordIntegrationResource
    | TelegramIntegrationResource
    | WhatsAppIntegrationResource
    | MessengerIntegrationResource
    | NotionIntegrationResource
    | EmailIntegrationResource
    | TriggerIntegrationResource
    | SupportIntegrationResource
    | ExtractIntegrationResource
    | McpServerIntegrationResource
    | TwilioIntegrationResource
)[]
Get the resources.

Returns (
    | BlueprintResource
    | BotResource
    | DatasetResource
    | FileResource
    | SpaceResource
    | SecretResource
    | SkillsetResource
    | TaskResource
    | WidgetIntegrationResource
    | SitemapIntegrationResource
    | SlackIntegrationResource
    | DiscordIntegrationResource
    | TelegramIntegrationResource
    | WhatsAppIntegrationResource
    | MessengerIntegrationResource
    | NotionIntegrationResource
    | EmailIntegrationResource
    | TriggerIntegrationResource
    | SupportIntegrationResource
    | ExtractIntegrationResource
    | McpServerIntegrationResource
    | TwilioIntegrationResource
)[]
- Defined in packages/cli/src/solution/index.js:1122

secret

get secret(): { [key: string]: SecretResource | undefined }
Returns { [key: string]: SecretResource | undefined }
- Defined in packages/cli/src/solution/index.js:1270

secrets

get secrets(): SecretResource[]
Returns SecretResource[]
- Defined in packages/cli/src/solution/index.js:1261

sitemapIntegration

get sitemapIntegration(): {
[key: string]: SitemapIntegrationResource
| undefined;
}
Returns { [key: string]: SitemapIntegrationResource | undefined }
- Defined in packages/cli/src/solution/index.js:1338

sitemapIntegrations

get sitemapIntegrations(): SitemapIntegrationResource[]
Returns SitemapIntegrationResource[]
- Defined in packages/cli/src/solution/index.js:1327

skillset

get skillset(): { [key: string]: SkillsetResource | undefined }
Returns { [key: string]: SkillsetResource | undefined }
- Defined in packages/cli/src/solution/index.js:1286

skillsets

get skillsets(): SkillsetResource[]
Returns SkillsetResource[]
- Defined in packages/cli/src/solution/index.js:1277

slackIntegration

get slackIntegration(): { [key: string]: SlackIntegrationResource | undefined }
Returns { [key: string]: SlackIntegrationResource | undefined }
- Defined in packages/cli/src/solution/index.js:1356

slackIntegrations

get slackIntegrations(): SlackIntegrationResource[]
Returns SlackIntegrationResource[]
- Defined in packages/cli/src/solution/index.js:1345

space

get space(): { [key: string]: SpaceResource | undefined }
Returns { [key: string]: SpaceResource | undefined }
- Defined in packages/cli/src/solution/index.js:1254

spaces

get spaces(): SpaceResource[]
Returns SpaceResource[]
- Defined in packages/cli/src/solution/index.js:1245

supportIntegration

get supportIntegration(): {
[key: string]: SupportIntegrationResource
| undefined;
}
Returns { [key: string]: SupportIntegrationResource | undefined }
- Defined in packages/cli/src/solution/index.js:1500

supportIntegrations

get supportIntegrations(): SupportIntegrationResource[]
Returns SupportIntegrationResource[]
- Defined in packages/cli/src/solution/index.js:1489

task

get task(): { [key: string]: TaskResource | undefined }
Returns { [key: string]: TaskResource | undefined }
- Defined in packages/cli/src/solution/index.js:1302

tasks

get tasks(): TaskResource[]
Returns TaskResource[]
- Defined in packages/cli/src/solution/index.js:1293

telegramIntegration

get telegramIntegration(): {
[key: string]: TelegramIntegrationResource
| undefined;
}
Returns { [key: string]: TelegramIntegrationResource | undefined }
- Defined in packages/cli/src/solution/index.js:1392

telegramIntegrations

get telegramIntegrations(): TelegramIntegrationResource[]
Returns TelegramIntegrationResource[]
- Defined in packages/cli/src/solution/index.js:1381

triggerIntegration

get triggerIntegration(): {
[key: string]: TriggerIntegrationResource
| undefined;
}
Returns { [key: string]: TriggerIntegrationResource | undefined }
- Defined in packages/cli/src/solution/index.js:1482

triggerIntegrations

get triggerIntegrations(): TriggerIntegrationResource[]
Returns TriggerIntegrationResource[]
- Defined in packages/cli/src/solution/index.js:1471

twilioIntegration

get twilioIntegration(): {
[key: string]: TwilioIntegrationResource
| undefined;
}
Returns { [key: string]: TwilioIntegrationResource | undefined }
- Defined in packages/cli/src/solution/index.js:1554

twilioIntegrations

get twilioIntegrations(): TwilioIntegrationResource[]
Returns TwilioIntegrationResource[]
- Defined in packages/cli/src/solution/index.js:1543

whatsappIntegration

get whatsappIntegration(): {
[key: string]: WhatsAppIntegrationResource
| undefined;
}
Returns { [key: string]: WhatsAppIntegrationResource | undefined }
- Defined in packages/cli/src/solution/index.js:1410

whatsappIntegrations

get whatsappIntegrations(): WhatsAppIntegrationResource[]
Returns WhatsAppIntegrationResource[]
- Defined in packages/cli/src/solution/index.js:1399

widgetIntegration

get widgetIntegration(): {
[key: string]: WidgetIntegrationResource
| undefined;
}
Returns { [key: string]: WidgetIntegrationResource | undefined }
- Defined in packages/cli/src/solution/index.js:1320

widgetIntegrations

get widgetIntegrations(): WidgetIntegrationResource[]
Returns WidgetIntegrationResource[]
- Defined in packages/cli/src/solution/index.js:1309

Methods

sync

sync(): Promise<void>
Sync the solution.

Returns Promise<void>
- Defined in packages/cli/src/solution/index.js:1563

`Static`create

create(name: string): Promise<void>
Creates a new solution.
Parameters
- name: string
Returns Promise<void>
- Defined in packages/cli/src/solution/index.js:1589

`Static`delete

delete(name: string): Promise<void>
Deletes a solution.
Parameters
- name: string
Returns Promise<void>
- Defined in packages/cli/src/solution/index.js:1614

`Static`list

list(): Promise<string[]>
Lists solutions.

Returns Promise<string[]>
- Defined in packages/cli/src/solution/index.js:1573

`Static`load

load(
    config:
        | string
        | {
            resources: (
                | { id?: string; properties: {}; slug?: string; type: "blueprint" }
                | { id?: string; properties: {}; slug?: string; type: "bot" }
                | { id?: string; properties: {}; slug?: string; type: "dataset" }
                | { id?: string; properties: {}; slug?: string; type: "file" }
                | { id?: string; properties: {}; slug?: string; type: "space" }
                | { id?: string; properties: {}; slug?: string; type: "secret" }
                | { id?: string; properties: {}; slug?: string; type: "skillset" }
                | { id?: string; properties: {}; slug?: string; type: "task" }
                | {
                    id?: string;
                    properties: {};
                    slug?: string;
                    type: "widgetIntegration";
                }
                | {
                    id?: string;
                    properties: {};
                    slug?: string;
                    type: "sitemapIntegration";
                }
                | {
                    id?: string;
                    properties: {};
                    slug?: string;
                    type: "slackIntegration";
                }
                | {
                    id?: string;
                    properties: {};
                    slug?: string;
                    type: "discordIntegration";
                }
                | {
                    id?: string;
                    properties: {};
                    slug?: string;
                    type: "telegramIntegration";
                }
                | {
                    id?: string;
                    properties: {};
                    slug?: string;
                    type: "whatsappIntegration";
                }
                | {
                    id?: string;
                    properties: {};
                    slug?: string;
                    type: "messengerIntegration";
                }
                | {
                    id?: string;
                    properties: {};
                    slug?: string;
                    type: "notionIntegration";
                }
                | {
                    id?: string;
                    properties: {};
                    slug?: string;
                    type: "emailIntegration";
                }
                | {
                    id?: string;
                    properties: {};
                    slug?: string;
                    type: "triggerIntegration";
                }
                | {
                    id?: string;
                    properties: {};
                    slug?: string;
                    type: "supportIntegration";
                }
                | {
                    id?: string;
                    properties: {};
                    slug?: string;
                    type: "extractIntegration";
                }
                | {
                    id?: string;
                    properties: {};
                    slug?: string;
                    type: "mcpserverIntegration";
                }
                | {
                    id?: string;
                    properties: {};
                    slug?: string;
                    type: "twilioIntegration";
                }
            )[];
            version: 1;
        },
): Promise<Solution>
Loads a solution from a configuration object or a file.
Parameters
- config:
      | string
      | {
          resources: (
              | { id?: string; properties: {}; slug?: string; type: "blueprint" }
              | { id?: string; properties: {}; slug?: string; type: "bot" }
              | { id?: string; properties: {}; slug?: string; type: "dataset" }
              | { id?: string; properties: {}; slug?: string; type: "file" }
              | { id?: string; properties: {}; slug?: string; type: "space" }
              | { id?: string; properties: {}; slug?: string; type: "secret" }
              | { id?: string; properties: {}; slug?: string; type: "skillset" }
              | { id?: string; properties: {}; slug?: string; type: "task" }
              | {
                  id?: string;
                  properties: {};
                  slug?: string;
                  type: "widgetIntegration";
              }
              | {
                  id?: string;
                  properties: {};
                  slug?: string;
                  type: "sitemapIntegration";
              }
              | {
                  id?: string;
                  properties: {};
                  slug?: string;
                  type: "slackIntegration";
              }
              | {
                  id?: string;
                  properties: {};
                  slug?: string;
                  type: "discordIntegration";
              }
              | {
                  id?: string;
                  properties: {};
                  slug?: string;
                  type: "telegramIntegration";
              }
              | {
                  id?: string;
                  properties: {};
                  slug?: string;
                  type: "whatsappIntegration";
              }
              | {
                  id?: string;
                  properties: {};
                  slug?: string;
                  type: "messengerIntegration";
              }
              | {
                  id?: string;
                  properties: {};
                  slug?: string;
                  type: "notionIntegration";
              }
              | {
                  id?: string;
                  properties: {};
                  slug?: string;
                  type: "emailIntegration";
              }
              | {
                  id?: string;
                  properties: {};
                  slug?: string;
                  type: "triggerIntegration";
              }
              | {
                  id?: string;
                  properties: {};
                  slug?: string;
                  type: "supportIntegration";
              }
              | {
                  id?: string;
                  properties: {};
                  slug?: string;
                  type: "extractIntegration";
              }
              | {
                  id?: string;
                  properties: {};
                  slug?: string;
                  type: "mcpserverIntegration";
              }
              | {
                  id?: string;
                  properties: {};
                  slug?: string;
                  type: "twilioIntegration";
              }
          )[];
          version: 1;
      }
Returns Promise<Solution>
- Defined in packages/cli/src/solution/index.js:1631

`Static`save

save(name: string, solution: Solution): Promise<void>
Saves a solution to a file.
Parameters
- name: string
- solution: Solution
Returns Promise<void>
- Defined in packages/cli/src/solution/index.js:1670

Class Solution

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Solution

Accessors

baseClient

Returns ChatBotKit

blueprint

Returns { [key: string]: BlueprintResource | undefined }

blueprints

Returns BlueprintResource[]

bot

Returns { [key: string]: BotResource | undefined }

bots

Returns BotResource[]

dataset

Returns { [key: string]: DatasetResource | undefined }

datasets

Returns DatasetResource[]

discordIntegration

Returns { [key: string]: DiscordIntegrationResource | undefined }

discordIntegrations

Returns DiscordIntegrationResource[]

emailIntegration

Returns { [key: string]: EmailIntegrationResource | undefined }

emailIntegrations

Returns EmailIntegrationResource[]

extractIntegration

Returns { [key: string]: ExtractIntegrationResource | undefined }

extractIntegrations

Returns ExtractIntegrationResource[]

file

Returns { [key: string]: FileResource | undefined }

files

Returns FileResource[]

mcpserverIntegration

Returns { [key: string]: McpServerIntegrationResource | undefined }

mcpserverIntegrations

Returns McpServerIntegrationResource[]

messengerIntegration

Returns { [key: string]: MessengerIntegrationResource | undefined }

messengerIntegrations

Returns MessengerIntegrationResource[]

notionIntegration

Returns { [key: string]: NotionIntegrationResource | undefined }

notionIntegrations

Returns NotionIntegrationResource[]

resources

secret

Returns { [key: string]: SecretResource | undefined }

secrets

Returns SecretResource[]

sitemapIntegration

Returns { [key: string]: SitemapIntegrationResource | undefined }

sitemapIntegrations

Returns SitemapIntegrationResource[]

skillset

Returns { [key: string]: SkillsetResource | undefined }

skillsets

Returns SkillsetResource[]

slackIntegration

Returns { [key: string]: SlackIntegrationResource | undefined }

slackIntegrations

Returns SlackIntegrationResource[]

space

Returns { [key: string]: SpaceResource | undefined }

spaces

Returns SpaceResource[]

supportIntegration

Returns { [key: string]: SupportIntegrationResource | undefined }

supportIntegrations

Returns SupportIntegrationResource[]

task

Returns { [key: string]: TaskResource | undefined }

tasks

`Static`create

`Static`delete

`Static`list

`Static`load

`Static`save