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?: "secret" }
            | { id?: string; properties?: {}; slug?: string; type?: "skillset" }
            | {
                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?: "secret" }
          | { id?: string; properties?: {}; slug?: string; type?: "skillset" }
          | {
              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:1002

Accessors

baseClient

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

blueprint

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

blueprints

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

bot

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

bots

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

dataset

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

file

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

files

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

mcpserverIntegration

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

mcpserverIntegrations

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

messengerIntegration

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

messengerIntegrations

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

notionIntegration

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

notionIntegrations

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

resources

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

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

secret

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

secrets

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

sitemapIntegration

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

sitemapIntegrations

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

skillset

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

skillsets

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

slackIntegration

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

slackIntegrations

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

supportIntegration

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

supportIntegrations

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

telegramIntegration

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

telegramIntegrations

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

triggerIntegration

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

triggerIntegrations

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

twilioIntegration

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

twilioIntegrations

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

whatsappIntegration

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

whatsappIntegrations

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

widgetIntegration

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

widgetIntegrations

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

Methods

sync

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

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

`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:1454

`Static`delete

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

`Static`list

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

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

`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?: "secret" }
                | { id?: string; properties?: {}; slug?: string; type?: "skillset" }
                | {
                    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?: "secret" }
              | { id?: string; properties?: {}; slug?: string; type?: "skillset" }
              | {
                  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:1496

`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:1535

Class Solution

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Solution

Accessors

baseClient

Returns ChatBotKit

blueprint

Returns { [key: string]: BlueprintResource }

blueprints

Returns BlueprintResource[]

bot

Returns { [key: string]: BotResource }

bots

Returns BotResource[]

dataset

Returns { [key: string]: DatasetResource }

datasets

Returns DatasetResource[]

discordIntegration

Returns { [key: string]: DiscordIntegrationResource }

discordIntegrations

Returns DiscordIntegrationResource[]

emailIntegration

Returns { [key: string]: EmailIntegrationResource }

emailIntegrations

Returns EmailIntegrationResource[]

extractIntegration

Returns { [key: string]: ExtractIntegrationResource }

extractIntegrations

Returns ExtractIntegrationResource[]

file

Returns { [key: string]: FileResource }

files

Returns FileResource[]

mcpserverIntegration

Returns { [key: string]: McpServerIntegrationResource }

mcpserverIntegrations

Returns McpServerIntegrationResource[]

messengerIntegration

Returns { [key: string]: MessengerIntegrationResource }

messengerIntegrations

Returns MessengerIntegrationResource[]

notionIntegration

Returns { [key: string]: NotionIntegrationResource }

notionIntegrations

Returns NotionIntegrationResource[]

resources

secret

Returns { [key: string]: SecretResource }

secrets

Returns SecretResource[]

sitemapIntegration

Returns { [key: string]: SitemapIntegrationResource }

sitemapIntegrations

Returns SitemapIntegrationResource[]

skillset

Returns { [key: string]: SkillsetResource }

skillsets

Returns SkillsetResource[]

slackIntegration

Returns { [key: string]: SlackIntegrationResource }

slackIntegrations

Returns SlackIntegrationResource[]

supportIntegration

Returns { [key: string]: SupportIntegrationResource }

supportIntegrations

Returns SupportIntegrationResource[]

telegramIntegration

Returns { [key: string]: TelegramIntegrationResource }

telegramIntegrations

Returns TelegramIntegrationResource[]

triggerIntegration

Returns { [key: string]: TriggerIntegrationResource }

triggerIntegrations

`Static`create

`Static`delete

`Static`list

`Static`load

`Static`save