Class: PluginInstanceManager

Manages plugin instances (installations) for a project.

Constructors

new PluginInstanceManager()

new PluginInstanceManager(ctx, projectId): PluginInstanceManager

Internal

Parameters

Parameter	Type
ctx	ClientContext
projectId	string

Returns

PluginInstanceManager

Defined in

4Players/cortex-typescript-sdk/src/resources/plugins.ts:82

Methods

create()

create(body): Promise<object>

Install a plugin for this project

Parameters

Parameter	Type	Description
body	object	Plugin installation payload
body.pluginId	string	Description Plugin ID to activate
body.settings?	object	Description Initial settings

Returns

Promise<object>

Created plugin instance

Name	Type	Description	Defined in
createdAt	string	Format: date-time Description Creation timestamp	4Players/cortex-typescript-sdk/src/types.ts:2566
id	string	Description Instance UUID	4Players/cortex-typescript-sdk/src/types.ts:2549
isEnabled	boolean	Description Whether this instance is enabled	4Players/cortex-typescript-sdk/src/types.ts:2561
pluginId	string	Description Plugin ID	4Players/cortex-typescript-sdk/src/types.ts:2555
projectId?	string	Description Project ID (null = all projects)	4Players/cortex-typescript-sdk/src/types.ts:2553
settings	object	Description User-configured settings	4Players/cortex-typescript-sdk/src/types.ts:2557
tenantId	string	Description Tenant ID	4Players/cortex-typescript-sdk/src/types.ts:2551
updatedAt	string	Format: date-time Description Last update timestamp	4Players/cortex-typescript-sdk/src/types.ts:2571

Defined in

4Players/cortex-typescript-sdk/src/resources/plugins.ts:105

---

delete()

delete(instanceId): Promise<object>

Uninstall a plugin instance

Parameters

Parameter	Type	Description
instanceId	string	Plugin instance ID

Returns

Promise<object>

Deletion confirmation

Name	Type	Description	Defined in
message	string	Description Status message Example Plugin instance deleted	4Players/cortex-typescript-sdk/src/types.ts:2586

Defined in

4Players/cortex-typescript-sdk/src/resources/plugins.ts:148

---

get()

get(instanceId): Promise<object>

Get a plugin instance by ID

Parameters

Parameter	Type	Description
instanceId	string	Plugin instance ID

Returns

Promise<object>

Plugin instance with plugin details

Name	Type	Description	Defined in
createdAt	string	Format: date-time Description Creation timestamp	4Players/cortex-typescript-sdk/src/types.ts:2530
id	string	Description Instance UUID	4Players/cortex-typescript-sdk/src/types.ts:2513
isEnabled	boolean	Description Whether this instance is enabled	4Players/cortex-typescript-sdk/src/types.ts:2525
plugin	object	Description Plugin definition	4Players/cortex-typescript-sdk/src/types.ts:2537
plugin.category	"moderation" | "analytics" | "automation" | "integration"	Description Category	4Players/cortex-typescript-sdk/src/types.ts:2454
plugin.description?	string	Description Description	4Players/cortex-typescript-sdk/src/types.ts:2444
plugin.events	string[]	Description Event patterns Example [ "message.created" ]	4Players/cortex-typescript-sdk/src/types.ts:2461
plugin.icon?	string	Description Heroicons icon name Example heroicons_outline:shield-check	4Players/cortex-typescript-sdk/src/types.ts:2483
plugin.id	string	Description Plugin UUID	4Players/cortex-typescript-sdk/src/types.ts:2432
plugin.isActive	boolean	Description Whether plugin is available	4Players/cortex-typescript-sdk/src/types.ts:2485
plugin.name	string	Description Display name Example Profanity Filter	4Players/cortex-typescript-sdk/src/types.ts:2442
plugin.outputAnnotationType?	"profanity" | "summary" | "action_items" | "sentiment"	Description Output annotation type	4Players/cortex-typescript-sdk/src/types.ts:2466
plugin.pricingUrl?	string	Description Pricing page URL for the tied Payment product, shown in the install cost-acceptance notice. Example https://odin.4players.io/pricing	4Players/cortex-typescript-sdk/src/types.ts:2478
plugin.productSlug?	string	Description Payment product slug this plugin activates (set = paid plugin). When present, installing/enabling the plugin activates this product and disabling/uninstalling deactivates it. Example amanda	4Players/cortex-typescript-sdk/src/types.ts:2473
plugin.settingsSchema?	object[]	Description Settings schema	4Players/cortex-typescript-sdk/src/types.ts:2468
plugin.slug	string	Description URL-friendly identifier Example profanity-filter	4Players/cortex-typescript-sdk/src/types.ts:2437
plugin.version	string	Description Semantic version Example 1.0.0	4Players/cortex-typescript-sdk/src/types.ts:2449
pluginId	string	Description Plugin ID	4Players/cortex-typescript-sdk/src/types.ts:2519
projectId?	string	Description Project ID (null = all projects)	4Players/cortex-typescript-sdk/src/types.ts:2517
settings	object	Description User-configured settings	4Players/cortex-typescript-sdk/src/types.ts:2521
tenantId	string	Description Tenant ID	4Players/cortex-typescript-sdk/src/types.ts:2515
updatedAt	string	Format: date-time Description Last update timestamp	4Players/cortex-typescript-sdk/src/types.ts:2535

Defined in

4Players/cortex-typescript-sdk/src/resources/plugins.ts:119

---

list()

list(): Promise<object[]>

List installed plugin instances

Returns

Promise<object[]>

Array of plugin instances with plugin details

Defined in

4Players/cortex-typescript-sdk/src/resources/plugins.ts:91

---

update()

update(instanceId, body): Promise<object>

Update a plugin instance

Parameters

Parameter	Type	Description
instanceId	string	Plugin instance ID
body	object	Updated settings
body.isEnabled?	boolean	Description Enable/disable the instance
body.settings?	object	Description Updated settings

Returns

Promise<object>

Updated plugin instance

Name	Type	Description	Defined in
createdAt	string	Format: date-time Description Creation timestamp	4Players/cortex-typescript-sdk/src/types.ts:2566
id	string	Description Instance UUID	4Players/cortex-typescript-sdk/src/types.ts:2549
isEnabled	boolean	Description Whether this instance is enabled	4Players/cortex-typescript-sdk/src/types.ts:2561
pluginId	string	Description Plugin ID	4Players/cortex-typescript-sdk/src/types.ts:2555
projectId?	string	Description Project ID (null = all projects)	4Players/cortex-typescript-sdk/src/types.ts:2553
settings	object	Description User-configured settings	4Players/cortex-typescript-sdk/src/types.ts:2557
tenantId	string	Description Tenant ID	4Players/cortex-typescript-sdk/src/types.ts:2551
updatedAt	string	Format: date-time Description Last update timestamp	4Players/cortex-typescript-sdk/src/types.ts:2571

Defined in

4Players/cortex-typescript-sdk/src/resources/plugins.ts:134