SpeakeasySDK 5.0.0

Speakeasy

SDK Installation

Nuget

dotnet add package SpeakeasySDK

SDK Example Usage

Example

using SpeakeasySDK;
using SpeakeasySDK.Models.Shared;
using SpeakeasySDK.Models.Operations;
using System.Collections.Generic;

var sdk = new Speakeasy(
    security: new Security() {
        APIKey = "<YOUR_API_KEY_HERE>",
    },
    workspaceID: "string");

GetApisRequest req = new GetApisRequest() {
    Metadata = new Dictionary<string, List<string>>() {
        { "key", new List<string>() {
            "string",
        } },
    },
    Op = new QueryParamOp() {
        And = false,
    },
};

var res = await sdk.Apis.GetApisAsync(req);

// handle response

Available Resources and Operations

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

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.

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.

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.

Auth

• ValidateApiKey - Validate the current api key.

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.

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.

Events

• PostWorkspaceEvents - Post events for a specific workspace

Server Selection

Server Selection

Select Server by Name

You can override the default server globally by passing a server name to the server: string optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverUrl: str optional parameter when initializing the SDK client instance. For example:

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:

using SpeakeasySDK;
using SpeakeasySDK.Models.Shared;
using SpeakeasySDK.Models.Operations;

var sdk = new Speakeasy(
    security: new Security() {
        APIKey = "<YOUR_API_KEY_HERE>",
    },
    workspaceID: "string");

DeleteApiRequest req = new DeleteApiRequest() {
    ApiID = "string",
    VersionID = "string",
};

var res = await sdk.Apis.DeleteApiAsync(req);

// handle response

Global Parameters

Global Parameters

A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.

For example, you can set workspaceID to "string" at SDK initialization and then you do not have to pass the same value on calls to operations like PostWorkspaceEvents. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.

Available Globals

The following global parameter is available.

Example

using SpeakeasySDK;
using SpeakeasySDK.Models.Shared;
using SpeakeasySDK.Models.Operations;
using System.Collections.Generic;

var sdk = new Speakeasy(
    security: new Security() {
        APIKey = "<YOUR_API_KEY_HERE>",
    },
    workspaceID: "string");

PostWorkspaceEventsRequest req = new PostWorkspaceEventsRequest() {
    RequestBody = new List<CliEvent>() {
        new CliEvent() {
            CreatedAt = System.DateTime.Parse("2024-11-21T06:58:42.120Z"),
            ExecutionId = "string",
            Id = "<ID>",
            InteractionType = InteractionType.CliExec,
            LocalStartedAt = System.DateTime.Parse("2024-05-07T12:35:47.182Z"),
            SpeakeasyApiKeyName = "string",
            SpeakeasyVersion = "string",
            Success = false,
            WorkspaceId = "string",
        },
    },
};

var res = await sdk.Events.PostWorkspaceEventsAsync(req);

// handle response

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