SpeakeasySDK 2.2.2

Speakeasy

SDK Installation

Nuget

dotnet add package SpeakeasySDK

SDK Example Usage

Example 1

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

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

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

Example 2

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

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

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

var res = await sdk.ApiEndpoints.DeleteApiEndpointAsync(req);

// handle response

Example 3

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

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

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

var res = await sdk.ApiEndpoints.FindApiEndpointAsync(req);

// handle response

Example 4

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

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

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

var res = await sdk.ApiEndpoints.GenerateOpenApiSpecForApiEndpointAsync(req);

// handle response

Example 5

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

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

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

var res = await sdk.ApiEndpoints.GeneratePostmanCollectionForApiEndpointAsync(req);

// handle response

Example 6

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

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

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

var res = await sdk.ApiEndpoints.GetAllApiEndpointsAsync(req);

// handle response

Example 7

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

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

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

var res = await sdk.ApiEndpoints.GetAllForVersionApiEndpointsAsync(req);

// handle response

Example 8

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

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

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

var res = await sdk.ApiEndpoints.GetApiEndpointAsync(req);

// handle response

Example 9

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

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

UpsertApiEndpointRequest req = new UpsertApiEndpointRequest() {
    ApiEndpoint = new ApiEndpointInput() {
        ApiEndpointId = "string",
        Description = "Public-key systematic attitude",
        DisplayName = "string",
        Method = "string",
        Path = "/etc/periodic",
        VersionId = "string",
    },
    ApiEndpointID = "string",
    ApiID = "string",
    VersionID = "string",
};

var res = await sdk.ApiEndpoints.UpsertApiEndpointAsync(req);

// handle response

Example 10

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

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

DeleteVersionMetadataRequest req = new DeleteVersionMetadataRequest() {
    ApiID = "string",
    MetaKey = "string",
    MetaValue = "string",
    VersionID = "string",
};

var res = await sdk.Metadata.DeleteVersionMetadataAsync(req);

// handle response

Example 11

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

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

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

var res = await sdk.Metadata.GetVersionMetadataAsync(req);

// handle response

Example 12

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

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

InsertVersionMetadataRequest req = new InsertVersionMetadataRequest() {
    VersionMetadata = new VersionMetadataInput() {
        MetaKey = "string",
        MetaValue = "string",
    },
    ApiID = "string",
    VersionID = "string",
};

var res = await sdk.Metadata.InsertVersionMetadataAsync(req);

// handle response

Example 13

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

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

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

var res = await sdk.Schemas.DeleteSchemaAsync(req);

// handle response

Example 14

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

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

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

var res = await sdk.Schemas.DownloadSchemaAsync(req);

// handle response

Example 15

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

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

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

var res = await sdk.Schemas.DownloadSchemaRevisionAsync(req);

// handle response

Example 16

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

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

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

var res = await sdk.Schemas.GetSchemaAsync(req);

// handle response

Example 17

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

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

GetSchemaDiffRequest req = new GetSchemaDiffRequest() {
    ApiID = "string",
    BaseRevisionID = "string",
    TargetRevisionID = "string",
    VersionID = "string",
};

var res = await sdk.Schemas.GetSchemaDiffAsync(req);

// handle response

Example 18

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

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

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

var res = await sdk.Schemas.GetSchemaRevisionAsync(req);

// handle response

Example 19

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

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

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

var res = await sdk.Schemas.GetSchemasAsync(req);

// handle response

Example 20

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

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

RegisterSchemaRequest req = new RegisterSchemaRequest() {
    RequestBody = new RegisterSchemaRequestBody() {
        File = new File() {
            Content = "0xCAFCA03e0e as bytes <<<>>>",
            FileName = "bronze_table_blues.m2a",
        },
    },
    ApiID = "string",
    VersionID = "string",
};

var res = await sdk.Schemas.RegisterSchemaAsync(req);

// handle response

Example 21

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

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

GenerateRequestPostmanCollectionRequest req = new GenerateRequestPostmanCollectionRequest() {
    RequestID = "string",
};

var res = await sdk.Requests.GenerateRequestPostmanCollectionAsync(req);

// handle response

Example 22

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

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

GetRequestFromEventLogRequest req = new GetRequestFromEventLogRequest() {
    RequestID = "string",
};

var res = await sdk.Requests.GetRequestFromEventLogAsync(req);

// handle response

Example 23

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

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

QueryEventLogRequest req = new QueryEventLogRequest() {
    Filters = new Filters() {
        Filters = new List<Filter>() {
            new Filter() {
                Key = "<key>",
                Operator = "string",
                Value = "string",
            },
        },
        Limit = 241978,
        Offset = 451388,
        Operator = "string",
    },
};

var res = await sdk.Requests.QueryEventLogAsync(req);

// handle response

Example 24

using SpeakeasySDK;
using SpeakeasySDK.Models.Shared;

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

var res = await sdk.Plugins.GetPluginsAsync();

// handle response

Example 25

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

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

RunPluginRequest req = new RunPluginRequest() {
    Filters = new Filters() {
        Filters = new List<Filter>() {
            new Filter() {
                Key = "<key>",
                Operator = "string",
                Value = "string",
            },
        },
        Limit = 669298,
        Offset = 94585,
        Operator = "string",
    },
    PluginID = "string",
};

var res = await sdk.Plugins.RunPluginAsync(req);

// handle response

Example 26

using SpeakeasySDK;
using SpeakeasySDK.Models.Shared;

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

Plugin req = new Plugin() {
    Code = "string",
    PluginId = "string",
    Title = "string",
    WorkspaceId = "string",
};

var res = await sdk.Plugins.UpsertPluginAsync(req);

// handle response

Example 27

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

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

GetEmbedAccessTokenRequest req = new GetEmbedAccessTokenRequest() {
    Filters = new Filters() {
        Filters = new List<Filter>() {
            new Filter() {
                Key = "<key>",
                Operator = "string",
                Value = "string",
            },
        },
        Limit = 964408,
        Offset = 95617,
        Operator = "string",
    },
};

var res = await sdk.Embeds.GetEmbedAccessTokenAsync(req);

// handle response

Example 28

using SpeakeasySDK;
using SpeakeasySDK.Models.Shared;

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

var res = await sdk.Embeds.GetValidEmbedAccessTokensAsync();

// handle response

Example 29

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

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

RevokeEmbedAccessTokenRequest req = new RevokeEmbedAccessTokenRequest() {
    TokenID = "string",
};

var res = await sdk.Embeds.RevokeEmbedAccessTokenAsync(req);

// handle response

Available Resources and Operations

Speakeasy SDK

• ValidateApiKey - Validate the current api key.

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.

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.

Plugins

• GetPlugins - Get all plugins for the current workspace.
• RunPlugin - Run a plugin
• UpsertPlugin - Upsert a plugin

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.

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:

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