Plugins

TagmeClientAdvanced.add_plugin(user_id: str, plugin: Plugin, organization_id: str | None = None, ) → None

Add new plugin to user. If it has same route as another plugin, it would be replaced.

Parameters

* user_id – user id.

* plugin – plugin data.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.check_plugin_template(plugin_template_id: str, organization_id: str | None = None, ) → CheckPluginTemplateResult

Check if plugin template is ready for publishing.

Parameters

* plugin_template_id – plugin template id to check.

* organization_id – optional organization identifier. Defaults to None.
Results

object with check status.

TagmeClientAdvanced.create_organization_plugin(plugin_template_id: str, roles: List[Literal['MARKER', 'CUSTOMER', 'ORGANIZATION_ADMIN']], route: str, enabled: bool = True, organization_id: str | None = None, ) → PluginAssignment

Install plugin template for organization.

Parameters

* plugin_template_id – plugin template id to install.

* roles – roles which will see plugin.

* route – route for plugin.

* enabled – enable/disable plugin.

* organization_id – optional organization identifier. Defaults to None.

Returns

info about installed plugin.

TagmeClientAdvanced.create_plugin_template(name: str, description: str | None = None, documentation: str | None = None, contacts: str | None = None, access: Literal['public', 'organization', 'private'] = 'private', title: str | None = None, config: dict | None = None, acl: List[str] | None = None, scope: Literal['SIDEBAR'] = 'SIDEBAR', roles: List[Literal['MARKER', 'CUSTOMER', 'ORGANIZATION_ADMIN']] | None = None, organization_id: str | None = None, ) → PluginTemplate

Create plugin template.

Parameters

* name – plugin name.

* description – plugin description.

* documentation – plugin documentation.

* contacts – plugin owner’s contacts.

* access – access.

* title – title to show in sidebar.

* config – plugin configuration.

* acl – organizations to share template with (if access is organization).

* scope – scope of plugin (now only SIDEBAR).

* roles – available roles.

* organization_id – optional organization identifier. Defaults to None.

Returns

created plugin template.

TagmeClientAdvanced.delete_organization_plugin(plugin_assignment_id: str, organization_id: str | None = None, ) → None

Uninstall plugin from organization.

Parameters

* plugin_assignment_id – plugin assignment id to delete.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.delete_plugin_template(plugin_template_id: str, organization_id: str | None = None, ) → None

Delete plugin template.

Parameters

* plugin_template_id – plugin template id to delete

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.get_my_plugins(scope: Literal['MARKER_SIDEBAR', 'ORGANIZATION_SIDEBAR'] = 'MARKER_SIDEBAR', disable_cache: bool = False, organization_id: str | None = None, ) → List[UserPlugin]

Get current user plugins.

Parameters organization_id – optional organization identifier. Defaults to None.

Returns

short info about plugins available for current user.

TagmeClientAdvanced.get_organization_plugins(page: int | None = None, size: int | None = None, query: str | None = None, organization_id: str | None = None, ) → List[InstalledPlugin]

Get plugins installed for current organization.

Parameters

* page – page number for pagination.

* size – number of items per page for pagination.

* query – optional search query for plugin names.

* organization_id – optional organization identifier. Defaults to None.

Returns

plugins installed for current organization.

TagmeClientAdvanced.get_plugin_template(plugin_template_id: str, organization_id: str | None = None, ) → PluginTemplate

Get plugin template.

Parameters

* plugin_template_id – plugin template id to get

* organization_id – optional organization identifier. Defaults to None.

Returns

plugin template info.

TagmeClientAdvanced.get_plugin_template_installations(plugin_template_id: str, organization_id: str | None = None, ) → List[PluginInstallation]

Get organizations where plugin is installed.

Parameters

* plugin_template_id – plugin template id to get installations.

* organization_id – optional organization identifier. Defaults to None.

Returns

organizations info where plugin is installed.

TagmeClientAdvanced.get_plugin_templates(page: int | None = None, size: int | None = None, query: str | None = None, organization_id: str | None = None, ) → List[PluginTemplate]

Get plugin templates created by current organization’s users.

Parameters

* page – page number for pagination.

* size – number of items per page for pagination.

* query – optional search query for file names.

* organization_id – optional organization identifier. Defaults to None.

Returns

list of plugin templates.

TagmeClientAdvanced.get_published_plugin_templates(page: int | None = None, size: int | None = None, query: str | None = None, organization_id: str | None = None, ) → List[PluginTemplate]

Get plugin templates available to install for current organization.

Parameters

* page – page number for pagination.

* size – number of items per page for pagination.

* query – optional search query for file names.

* organization_id – optional organization identifier. Defaults to None.

Returns

list of plugin templates.

TagmeClientAdvanced.publish_plugin_template(plugin_template_id: str, organization_id: str | None = None, ) → None

Publish plugin template.

Parameters

* plugin_template_id – plugin template id to publish.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.remove_plugin(user_id: str, route: str, plugin_type: PluginTypes, organization_id: str | None = None, ) → None

Remove plugin from user by its route.

Parameters

* user_id – user id.

* route – route of plugin to remove.

* plugin_type – plugin type (CUSTOMER or MARKER).

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.unpublish_plugin_template(plugin_template_id: str, organization_id: str | None = None, ) → None

Unpublish plugin template.

Parameters

* plugin_template_id – plugin template id to unpublish.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.update_organization_plugin(plugin_assignment_id: str, enabled: bool | None = False, roles: List[Literal['MARKER', 'CUSTOMER', 'ORGANIZATION_ADMIN']] | None = None, route: str | None = None, organization_id: str | None = None, ) → PluginAssignment

Update installed plugin.

Parameters

* plugin_assignment_id – plugin assignment id to update.

* enabled – enable/disable plugin.

* roles – roles which will see plugin.

* route – route for plugin.

* organization_id – optional organization identifier. Defaults to None.

Returns

info about installed plugin.

TagmeClientAdvanced.update_plugin_template(plugin_template_id: str, name: str | None = None, description: str | None = None, documentation: str | None = None, contacts: str | None = None, access: Literal['public', 'organization', 'private'] | None = None, title: str | None = None, config: dict | None = None, acl: List[str] | None = None, scope: Literal['SIDEBAR'] | None = None, roles: List[Literal['MARKER', 'CUSTOMER', 'ORGANIZATION_ADMIN']] | None = None, organization_id: str | None = None, ) → PluginTemplate

Update plugin template.

Parameters

* plugin_template_id – plugin template id to update

* name – plugin name

* description – plugin description

* documentation – plugin documentation

* contacts – plugin owner’s contacts

* access – access

* title – title to show in sidebar

* config – plugin configuration

* acl – organizations to share template with (if access is organization)

* scope – scope of plugin (now only SIDEBAR)

* roles – available roles

* organization_id – optional organization identifier. Defaults to None.

Returns

updated plugin template.

TagmeClientAdvanced.upload_plugin_template_file(plugin_template_id: str, file_type: Literal['icon', 'preview', 'bundle'], file_path: str, organization_id: str | None = None, ) → PluginTemplateFileResult

Upload file to plugin template.

Parameters

* plugin_template_id – plugin template id to upload file to.

* file_type – type of file to upload.

* file_path – path to file to upload.

* organization_id – optional organization identifier. Defaults to None.

Returns

info about uploaded file.