plugins

Overview

REST APIs for managing and running plugins

Available Operations

• getPlugins - Get all plugins for the current workspace.
• runPlugin - Run a plugin
• upsertPlugin - Upsert a plugin

getPlugins

Get all plugins for the current workspace.

Example Usage

import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
import { GetPluginsResponse } from "@speakeasy-api/speakeasy-client-sdk-typescript/dist/sdk/models/operations";

const sdk = new Speakeasy({
  security: {
    apiKey: "",
  },
});

sdk.plugins.getPlugins().then((res: GetPluginsResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter	Type	Required	Description
config	AxiosRequestConfig	➖	Available config options for making requests.

Response

Promise<operations.GetPluginsResponse>

runPlugin

Run a plugin

Example Usage

import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
import { RunPluginResponse } from "@speakeasy-api/speakeasy-client-sdk-typescript/dist/sdk/models/operations";

const sdk = new Speakeasy({
  security: {
    apiKey: "",
  },
});

sdk.plugins.runPlugin({
  filters: {
    filters: [
      {
        key: "repellat",
        operator: "mollitia",
        value: "occaecati",
      },
    ],
    limit: 253291,
    offset: 414369,
    operator: "quam",
  },
  pluginID: "molestiae",
}).then((res: RunPluginResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter	Type	Required	Description
request	operations.RunPluginRequest	✔️	The request object to use for the request.
config	AxiosRequestConfig	➖	Available config options for making requests.

Response

Promise<operations.RunPluginResponse>

upsertPlugin

Upsert a plugin

Example Usage

import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
import { UpsertPluginResponse } from "@speakeasy-api/speakeasy-client-sdk-typescript/dist/sdk/models/operations";

const sdk = new Speakeasy({
  security: {
    apiKey: "",
  },
});

sdk.plugins.upsertPlugin({
  code: "velit",
  createdAt: new Date("2022-09-06T22:51:09.401Z"),
  evalHash: "quis",
  pluginId: "vitae",
  title: "Miss",
  updatedAt: new Date("2022-05-14T10:37:30.872Z"),
  workspaceId: "odit",
}).then((res: UpsertPluginResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter	Type	Required	Description
request	shared.Plugin	✔️	The request object to use for the request.
config	AxiosRequestConfig	➖	Available config options for making requests.

Response

Promise<operations.UpsertPluginResponse>