Class Resource

Represents a resource.

Index

Constructors

constructor

new Resource(
    config:
        | { 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";
        },
): Resource
Parameters
- config:
      | { 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";
      }
Returns Resource
- Defined in packages/cli/src/solution/index.js:616

Accessors

baseClient

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

client

get client(): {
    create: (properties: Record<string, any>) => Promise<{ id: string }>;
    update: (
        id: string,
        properties: Record<string, any>,
    ) => Promise<{ id: string }>;
}
Get the resource client.

Returns {
    create: (properties: Record<string, any>) => Promise<{ id: string }>;
    update: (
        id: string,
        properties: Record<string, any>,
    ) => Promise<{ id: string }>;
}
- Defined in packages/cli/src/solution/index.js:681

createProperties

get createProperties(): Record<string, any>
Get the properties to use for create operations. Override this method in subclasses to filter properties for creates.

Returns Record<string, any>
- Defined in packages/cli/src/solution/index.js:691

description

get description(): string
Returns string
- Defined in packages/cli/src/solution/index.js:657

id

get id(): string
Returns string
- Defined in packages/cli/src/solution/index.js:643

name

get name(): string
Returns string
- Defined in packages/cli/src/solution/index.js:650

slug

get slug(): string
Returns string
- Defined in packages/cli/src/solution/index.js:630

type

get type(): string
Returns string
- Defined in packages/cli/src/solution/index.js:623

updateProperties

get updateProperties(): Record<string, any>
Get the properties to use for update operations. Override this method in subclasses to filter properties for updates.

Returns Record<string, any>
- Defined in packages/cli/src/solution/index.js:701

Methods

sync

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

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

Class Resource

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Resource

Accessors

baseClient

Returns ChatBotKit

client

Returns {
    create: (properties: Record<string, any>) => Promise<{ id: string }>;
    update: (
        id: string,
        properties: Record<string, any>,
    ) => Promise<{ id: string }>;
}

createProperties

Returns Record<string, any>

description

Returns string

id

Returns string

name

Returns string

slug

Returns string

type

Returns string

updateProperties

Returns Record<string, any>

Methods

sync

Returns Promise<void>

Settings

On This Page

Class Resource

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Resource

Accessors

baseClient

Returns ChatBotKit

client

Returns { create: (properties: Record<string, any>) => Promise<{ id: string }>; update: ( id: string, properties: Record<string, any>, ) => Promise<{ id: string }>;}

createProperties

Returns Record<string, any>

description

Returns string

id

Returns string

name

Returns string

slug

Returns string

type

Returns string

updateProperties

Returns Record<string, any>

Methods

sync

Returns Promise<void>

Settings

On This Page

Returns {
create: (properties: Record<string, any>) => Promise<{ id: string }>;
update: (
id: string,
properties: Record<string, any>,
) => Promise<{ id: string }>;
}