Skip to content

Locale that is supported by the plugin. By default, we assume 'en' is supported if not specified.

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2456

Properties

locale?

optional locale?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2497

Locale that is supported by the plugin. By default, we assume 'en' is supported if not specified.


metadata?

optional metadata?: object

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2460

createdBy?

optional createdBy?: string

Creator of the plugin

description

description: string

Description of the plugin

documentation?

optional documentation?: string

Documentation for the plugin

image

image: string

The image of the plugin

name

name: string

The name of the plugin

parentApp?

optional parentApp?: string

Parent app of the plugin. If blank, treated as its own app / entity.

sourceCode?

optional sourceCode?: string

Source code for the plugin

optional supportLink?: string

Support link for the plugin


pluginId

pluginId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2458

The unique plugin ID


rotatePluginSecret?

optional rotatePluginSecret?: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2483

Rotate the plugin secret?


toPublish?

optional toPublish?: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2480

To publish in the directory. This will trigger the start of the review process.


versionCreate?

optional versionCreate?: PluginVersionConfigPayload

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2494

Create a new version


versionUpdates?

optional versionUpdates?: object[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2486

Update an existing version

config

config: Partial<PluginVersionConfigPayload>

The configuration for this version

version

version: NumberType

The version to update

Edit this page on GitHub