@speakeasy-api/speakeasy-client-sdk-typescript

SDK Installation

NPM

npm add @speakeasy-api/speakeasy-client-sdk-typescript

Yarn

yarn add @speakeasy-api/speakeasy-client-sdk-typescript

SDK Example Usage

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

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

sdk.apis.getApis({
  metadata: {
    "provident": [
      "quibusdam",
      "unde",
      "nulla",
    ],
    "corrupti": [
      "vel",
      "error",
      "deserunt",
      "suscipit",
    ],
    "iure": [
      "debitis",
      "ipsa",
    ],
  },
  op: {
    and: false,
  },
}).then((res: GetApisResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Available Resources and Operations

Speakeasy SDK

• validateApiKey - Validate the current api key.

apiEndpoints

• deleteApiEndpoint - Delete an ApiEndpoint.
• findApiEndpoint - Find an ApiEndpoint via its displayName.
• generateOpenApiSpecForApiEndpoint - Generate an OpenAPI specification for a particular ApiEndpoint.
• generatePostmanCollectionForApiEndpoint - Generate a Postman collection for a particular ApiEndpoint.
• getAllApiEndpoints - Get all Api endpoints for a particular apiID.
• getAllForVersionApiEndpoints - Get all ApiEndpoints for a particular apiID and versionID.
• getApiEndpoint - Get an ApiEndpoint.
• upsertApiEndpoint - Upsert an ApiEndpoint.

apis

• deleteApi - Delete an Api.
• generateOpenApiSpec - Generate an OpenAPI specification for a particular Api.
• generatePostmanCollection - Generate a Postman collection for a particular Api.
• getAllApiVersions - Get all Api versions for a particular ApiEndpoint.
• getApis - Get a list of Apis for a given workspace
• upsertApi - Upsert an Api

embeds

• getEmbedAccessToken - Get an embed access token for the current workspace.
• getValidEmbedAccessTokens - Get all valid embed access tokens for the current workspace.
• revokeEmbedAccessToken - Revoke an embed access EmbedToken.

metadata

• deleteVersionMetadata - Delete metadata for a particular apiID and versionID.
• getVersionMetadata - Get all metadata for a particular apiID and versionID.
• insertVersionMetadata - Insert metadata for a particular apiID and versionID.

plugins

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

requests

• generateRequestPostmanCollection - Generate a Postman collection for a particular request.
• getRequestFromEventLog - Get information about a particular request.
• queryEventLog - Query the event log to retrieve a list of requests.

schemas

• deleteSchema - Delete a particular schema revision for an Api.
• downloadSchema - Download the latest schema for a particular apiID.
• downloadSchemaRevision - Download a particular schema revision for an Api.
• getSchema - Get information about the latest schema.
• getSchemaDiff - Get a diff of two schema revisions for an Api.
• getSchemaRevision - Get information about a particular schema revision for an Api.
• getSchemas - Get information about all schemas associated with a particular apiID.
• registerSchema - Register a schema.

SDK Generated by Speakeasy