SpeakeasySDK 1.3.1

Speakeasy

SDK Installation

Nuget

dotnet add package SpeakeasySDK

SDK Example Usage

using Speakeasy;
using Speakeasy.Models.Security;
using Speakeasy.Models.Apis;

var sdk = new SpeakeasySDK(
    security: new Security() {
        APIKey = "",
    }
);

var res = await sdk.Apis.GetApisAsync(new GetApisRequest() {
    Metadata = new Dictionary<string, List<string>>() {
        { "provident", new List<string>() {
            "quibusdam",
            "unde",
            "nulla",
        } },
        { "corrupti", new List<string>() {
            "vel",
            "error",
            "deserunt",
            "suscipit",
        } },
        { "iure", new List<string>() {
            "debitis",
            "ipsa",
        } },
    },
    Op = new GetApisOp() {
        And = false,
    },
});

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.

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy