speakeasyclientsdkgo

package module
v3.15.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 30, 2024 License: Apache-2.0 Imports: 14 Imported by: 1

README

github.com/speakeasy-api/speakeasy-client-sdk-go

Summary

Speakeasy API: The Subscriptions API manages subscriptions for CLI and registry events

For more information about the API: The Speakeasy Platform Documentation

Table of Contents

SDK Installation

To add the SDK as a dependency to your project:

go get github.com/speakeasy-api/speakeasy-client-sdk-go

SDK Example Usage

Example
package main

import (
	"context"
	speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/operations"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
	"log"
)

func main() {
	s := speakeasyclientsdkgo.New(
		speakeasyclientsdkgo.WithSecurity(shared.Security{
			APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
		}),
	)

	ctx := context.Background()
	res, err := s.Apis.GetApis(ctx, operations.GetApisRequest{})
	if err != nil {
		log.Fatal(err)
	}
	if res.Apis != nil {
		// handle response
	}
}

Available Resources and Operations

Available methods
APIEndpoints
Apis
Artifacts
Auth
  • GetAccess - Get access allowances for a particular workspace
  • GetAccessToken - Get or refresh an access token for the current workspace.
  • GetUser - Get information about the current user.
  • ValidateAPIKey - Validate the current api key.
Embeds
Events
  • GetEventsByTarget - Load recent events for a particular workspace
  • GetTargets - Load targets for a particular workspace
  • GetTargetsDeprecated - Load targets for a particular workspace
  • Post - Post events for a specific workspace
  • Search - Search events for a particular workspace by any field
Github
Metadata
Organizations
  • Create - Create an organization
  • CreateFreeTrial - Create a free trial for an organization
  • Get - Get organization
  • GetAll - Get organizations for a user
  • GetUsage - Get billing usage summary for a particular organization
Reports
Requests
Schemas
ShortURLs
Subscriptions
Suggest
  • Suggest - Generate suggestions for improving an OpenAPI document.
  • SuggestItems - Generate generic suggestions for a list of items.
  • SuggestOpenAPI - (DEPRECATED) Generate suggestions for improving an OpenAPI document.
  • SuggestOpenAPIRegistry - Generate suggestions for improving an OpenAPI document stored in the registry.
Workspaces

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both.

By Default, an API error will return sdkerrors.SDKError. When custom error responses are specified for an operation, the SDK may also return their associated error. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation.

For example, the DeleteAPI function may return the following errors:

Error Type Status Code Content Type
sdkerrors.Error 4XX application/json
sdkerrors.SDKError 5XX */*
Example
package main

import (
	"context"
	"errors"
	speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/operations"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/sdkerrors"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
	"log"
)

func main() {
	s := speakeasyclientsdkgo.New(
		speakeasyclientsdkgo.WithSecurity(shared.Security{
			APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
		}),
	)

	ctx := context.Background()
	res, err := s.Apis.DeleteAPI(ctx, operations.DeleteAPIRequest{
		APIID:     "<value>",
		VersionID: "<value>",
	})
	if err != nil {

		var e *sdkerrors.Error
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}

		var e *sdkerrors.SDKError
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}
	}
}

Server Selection

Select Server by Name

You can override the default server globally using the WithServer option 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:

Name Server Variables
prod https://api.prod.speakeasyapi.dev None
Example
package main

import (
	"context"
	speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/operations"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
	"log"
)

func main() {
	s := speakeasyclientsdkgo.New(
		speakeasyclientsdkgo.WithServer("prod"),
		speakeasyclientsdkgo.WithSecurity(shared.Security{
			APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
		}),
	)

	ctx := context.Background()
	res, err := s.Apis.DeleteAPI(ctx, operations.DeleteAPIRequest{
		APIID:     "<value>",
		VersionID: "<value>",
	})
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		// handle response
	}
}
Override Server URL Per-Client

The default server can also be overridden globally using the WithServerURL option when initializing the SDK client instance. For example:

package main

import (
	"context"
	speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/operations"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
	"log"
)

func main() {
	s := speakeasyclientsdkgo.New(
		speakeasyclientsdkgo.WithServerURL("https://api.prod.speakeasyapi.dev"),
		speakeasyclientsdkgo.WithSecurity(shared.Security{
			APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
		}),
	)

	ctx := context.Background()
	res, err := s.Apis.DeleteAPI(ctx, operations.DeleteAPIRequest{
		APIID:     "<value>",
		VersionID: "<value>",
	})
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		// handle response
	}
}

Custom HTTP Client

The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

The built-in net/http client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.

import (
	"net/http"
	"time"
	"github.com/myorg/your-go-sdk"
)

var (
	httpClient = &http.Client{Timeout: 30 * time.Second}
	sdkClient  = sdk.New(sdk.WithClient(httpClient))
)

This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

Name Type Scheme
APIKey apiKey API key
Bearer http HTTP Bearer
WorkspaceIdentifier apiKey API key

You can set the security parameters through the WithSecurity option when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:

package main

import (
	"context"
	speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/operations"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
	"log"
)

func main() {
	s := speakeasyclientsdkgo.New(
		speakeasyclientsdkgo.WithSecurity(shared.Security{
			APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
		}),
	)

	ctx := context.Background()
	res, err := s.Apis.DeleteAPI(ctx, operations.DeleteAPIRequest{
		APIID:     "<value>",
		VersionID: "<value>",
	})
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		// handle response
	}
}

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 workspace_id to "<id>" at SDK initialization and then you do not have to pass the same value on calls to operations like GetAccessToken. 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.

Name Type Required Description
WorkspaceID string The WorkspaceID parameter.
Example
package main

import (
	"context"
	speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/operations"
	"log"
)

func main() {
	s := speakeasyclientsdkgo.New()

	ctx := context.Background()
	res, err := s.Auth.GetAccessToken(ctx, operations.GetAccessTokenRequest{
		WorkspaceID: "<value>",
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.AccessToken != nil {
		// handle response
	}
}

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retry.Config object to the call by using the WithRetries option:

package main

import (
	"context"
	speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/operations"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/retry"
	"log"
	"pkg/models/operations"
)

func main() {
	s := speakeasyclientsdkgo.New(
		speakeasyclientsdkgo.WithSecurity(shared.Security{
			APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
		}),
	)

	ctx := context.Background()
	res, err := s.Apis.DeleteAPI(ctx, operations.DeleteAPIRequest{
		APIID:     "<value>",
		VersionID: "<value>",
	}, operations.WithRetries(
		retry.Config{
			Strategy: "backoff",
			Backoff: &retry.BackoffStrategy{
				InitialInterval: 1,
				MaxInterval:     50,
				Exponent:        1.1,
				MaxElapsedTime:  100,
			},
			RetryConnectionErrors: false,
		}))
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		// handle response
	}
}

If you'd like to override the default retry strategy for all operations that support retries, you can use the WithRetryConfig option at SDK initialization:

package main

import (
	"context"
	speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/operations"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/retry"
	"log"
)

func main() {
	s := speakeasyclientsdkgo.New(
		speakeasyclientsdkgo.WithRetryConfig(
			retry.Config{
				Strategy: "backoff",
				Backoff: &retry.BackoffStrategy{
					InitialInterval: 1,
					MaxInterval:     50,
					Exponent:        1.1,
					MaxElapsedTime:  100,
				},
				RetryConnectionErrors: false,
			}),
		speakeasyclientsdkgo.WithSecurity(shared.Security{
			APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
		}),
	)

	ctx := context.Background()
	res, err := s.Apis.DeleteAPI(ctx, operations.DeleteAPIRequest{
		APIID:     "<value>",
		VersionID: "<value>",
	})
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		// handle response
	}
}
SDK Generated by Speakeasy

Documentation

Index

Constants

View Source 
const (
	ServerProd string = "prod"
)

Variables

View Source 
var ServerList = map[string]string{
	ServerProd: "https://api.prod.speakeasyapi.dev",
}

ServerList contains the list of servers available to the SDK

Functions

func Bool 

func Bool(b bool) *bool

Bool provides a helper function to return a pointer to a bool

func Float32 

func Float32(f float32) *float32

Float32 provides a helper function to return a pointer to a float32

func Float64 

func Float64(f float64) *float64

Float64 provides a helper function to return a pointer to a float64

func Int 

func Int(i int) *int

Int provides a helper function to return a pointer to an int

func Int64 

func Int64(i int64) *int64

Int64 provides a helper function to return a pointer to an int64

func Pointer added in v3.13.1 

func Pointer[T any](v T) *T

Pointer provides a helper function to return a pointer to a type

func String 

func String(s string) *string

String provides a helper function to return a pointer to a string

Types

type APIEndpoints 

type APIEndpoints struct {
	// contains filtered or unexported fields
}

APIEndpoints - REST APIs for managing ApiEndpoint entities

func (*APIEndpoints) DeleteAPIEndpoint 

func (s *APIEndpoints) DeleteAPIEndpoint(ctx context.Context, request operations.DeleteAPIEndpointRequest, opts ...operations.Option) (*operations.DeleteAPIEndpointResponse, error)

DeleteAPIEndpoint - Delete an ApiEndpoint. Delete an ApiEndpoint. This will also delete all associated Request Logs (if using a Postgres datastore).

func (*APIEndpoints) FindAPIEndpoint 

func (s *APIEndpoints) FindAPIEndpoint(ctx context.Context, request operations.FindAPIEndpointRequest, opts ...operations.Option) (*operations.FindAPIEndpointResponse, error)

FindAPIEndpoint - Find an ApiEndpoint via its displayName. Find an ApiEndpoint via its displayName (set by operationId from a registered OpenAPI schema). This is useful for finding the ID of an ApiEndpoint to use in the /v1/apis/{apiID}/version/{versionID}/api_endpoints/{apiEndpointID} endpoints.

func (*APIEndpoints) GenerateOpenAPISpecForAPIEndpoint 

func (s *APIEndpoints) GenerateOpenAPISpecForAPIEndpoint(ctx context.Context, request operations.GenerateOpenAPISpecForAPIEndpointRequest, opts ...operations.Option) (*operations.GenerateOpenAPISpecForAPIEndpointResponse, error)

GenerateOpenAPISpecForAPIEndpoint - Generate an OpenAPI specification for a particular ApiEndpoint. This endpoint will generate a new operation in any registered OpenAPI document if the operation does not already exist in the document. Returns the original document and the newly generated document allowing a diff to be performed to see what has changed.

func (*APIEndpoints) GeneratePostmanCollectionForAPIEndpoint 

func (s *APIEndpoints) GeneratePostmanCollectionForAPIEndpoint(ctx context.Context, request operations.GeneratePostmanCollectionForAPIEndpointRequest, opts ...operations.Option) (*operations.GeneratePostmanCollectionForAPIEndpointResponse, error)

GeneratePostmanCollectionForAPIEndpoint - Generate a Postman collection for a particular ApiEndpoint. Generates a postman collection that allows the endpoint to be called from postman variables produced for any path/query/header parameters included in the OpenAPI document.

func (*APIEndpoints) GetAPIEndpoint 

func (s *APIEndpoints) GetAPIEndpoint(ctx context.Context, request operations.GetAPIEndpointRequest, opts ...operations.Option) (*operations.GetAPIEndpointResponse, error)

GetAPIEndpoint - Get an ApiEndpoint.

func (*APIEndpoints) GetAllAPIEndpoints 

func (s *APIEndpoints) GetAllAPIEndpoints(ctx context.Context, request operations.GetAllAPIEndpointsRequest, opts ...operations.Option) (*operations.GetAllAPIEndpointsResponse, error)

GetAllAPIEndpoints - Get all Api endpoints for a particular apiID.

func (*APIEndpoints) GetAllForVersionAPIEndpoints 

func (s *APIEndpoints) GetAllForVersionAPIEndpoints(ctx context.Context, request operations.GetAllForVersionAPIEndpointsRequest, opts ...operations.Option) (*operations.GetAllForVersionAPIEndpointsResponse, error)

GetAllForVersionAPIEndpoints - Get all ApiEndpoints for a particular apiID and versionID.

func (*APIEndpoints) UpsertAPIEndpoint 

func (s *APIEndpoints) UpsertAPIEndpoint(ctx context.Context, request operations.UpsertAPIEndpointRequest, opts ...operations.Option) (*operations.UpsertAPIEndpointResponse, error)

UpsertAPIEndpoint - Upsert an ApiEndpoint. Upsert an ApiEndpoint. If the ApiEndpoint does not exist it will be created, otherwise it will be updated.

type Apis 

type Apis struct {
	// contains filtered or unexported fields
}

Apis - REST APIs for managing Api entities

func (*Apis) DeleteAPI 

func (s *Apis) DeleteAPI(ctx context.Context, request operations.DeleteAPIRequest, opts ...operations.Option) (*operations.DeleteAPIResponse, error)

DeleteAPI - Delete an Api. Delete a particular version of an Api. The will also delete all associated ApiEndpoints, Metadata, Schemas & Request Logs (if using a Postgres datastore).

func (*Apis) GenerateOpenAPISpec 

func (s *Apis) GenerateOpenAPISpec(ctx context.Context, request operations.GenerateOpenAPISpecRequest, opts ...operations.Option) (*operations.GenerateOpenAPISpecResponse, error)

GenerateOpenAPISpec - Generate an OpenAPI specification for a particular Api. This endpoint will generate any missing operations in any registered OpenAPI document if the operation does not already exist in the document. Returns the original document and the newly generated document allowing a diff to be performed to see what has changed.

func (*Apis) GeneratePostmanCollection 

func (s *Apis) GeneratePostmanCollection(ctx context.Context, request operations.GeneratePostmanCollectionRequest, opts ...operations.Option) (*operations.GeneratePostmanCollectionResponse, error)

GeneratePostmanCollection - Generate a Postman collection for a particular Api. Generates a postman collection containing all endpoints for a particular API. Includes variables produced for any path/query/header parameters included in the OpenAPI document.

func (*Apis) GetAllAPIVersions 

func (s *Apis) GetAllAPIVersions(ctx context.Context, request operations.GetAllAPIVersionsRequest, opts ...operations.Option) (*operations.GetAllAPIVersionsResponse, error)

GetAllAPIVersions - Get all Api versions for a particular ApiEndpoint. Get all Api versions for a particular ApiEndpoint. Supports filtering the versions based on metadata attributes.

func (*Apis) GetApis 

func (s *Apis) GetApis(ctx context.Context, request operations.GetApisRequest, opts ...operations.Option) (*operations.GetApisResponse, error)

GetApis - Get a list of Apis for a given workspace Get a list of all Apis and their versions for a given workspace. Supports filtering the APIs based on metadata attributes.

func (*Apis) UpsertAPI 

func (s *Apis) UpsertAPI(ctx context.Context, request operations.UpsertAPIRequest, opts ...operations.Option) (*operations.UpsertAPIResponse, error)

UpsertAPI - Upsert an Api Upsert an Api. If the Api does not exist, it will be created. If the Api exists, it will be updated.

type Artifacts added in v3.5.3 

type Artifacts struct {
	// contains filtered or unexported fields
}

Artifacts - REST APIs for working with Registry artifacts

func (*Artifacts) CreateRemoteSource added in v3.14.9 

func (s *Artifacts) CreateRemoteSource(ctx context.Context, request *shared.RemoteSource, opts ...operations.Option) (*operations.CreateRemoteSourceResponse, error)

CreateRemoteSource - Configure a new remote source

func (*Artifacts) GetBlob added in v3.5.4 

func (s *Artifacts) GetBlob(ctx context.Context, request operations.GetBlobRequest, opts ...operations.Option) (*operations.GetBlobResponse, error)

GetBlob - Get blob for a particular digest

func (*Artifacts) GetManifest added in v3.5.4 

func (s *Artifacts) GetManifest(ctx context.Context, request operations.GetManifestRequest, opts ...operations.Option) (*operations.GetManifestResponse, error)

GetManifest - Get manifest for a particular reference

func (*Artifacts) GetNamespaces added in v3.5.3 

func (s *Artifacts) GetNamespaces(ctx context.Context, opts ...operations.Option) (*operations.GetNamespacesResponse, error)

GetNamespaces - Each namespace contains many revisions.

func (*Artifacts) GetRevisions added in v3.5.3 

func (s *Artifacts) GetRevisions(ctx context.Context, request operations.GetRevisionsRequest, opts ...operations.Option) (*operations.GetRevisionsResponse, error)

func (*Artifacts) GetTags added in v3.5.4 

func (s *Artifacts) GetTags(ctx context.Context, request operations.GetTagsRequest, opts ...operations.Option) (*operations.GetTagsResponse, error)

func (*Artifacts) ListRemoteSources added in v3.14.9 

func (s *Artifacts) ListRemoteSources(ctx context.Context, request operations.ListRemoteSourcesRequest, opts ...operations.Option) (*operations.ListRemoteSourcesResponse, error)

ListRemoteSources - Get remote sources attached to a particular namespace

func (*Artifacts) PostTags added in v3.5.10 

func (s *Artifacts) PostTags(ctx context.Context, request operations.PostTagsRequest, opts ...operations.Option) (*operations.PostTagsResponse, error)

PostTags - Add tags to an existing revision

func (*Artifacts) Preflight added in v3.5.3 

func (s *Artifacts) Preflight(ctx context.Context, request *shared.PreflightRequest, opts ...operations.Option) (*operations.PreflightResponse, error)

Preflight - Get access token for communicating with OCI distribution endpoints

type Auth added in v3.1.0 

type Auth struct {
	// contains filtered or unexported fields
}

Auth - REST APIs for managing Authentication

func (*Auth) GetAccess added in v3.14.0 

func (s *Auth) GetAccess(ctx context.Context, request operations.GetWorkspaceAccessRequest, opts ...operations.Option) (*operations.GetWorkspaceAccessResponse, error)

GetAccess - Get access allowances for a particular workspace Checks if generation is permitted for a particular run of the CLI

func (*Auth) GetAccessToken added in v3.3.11 

func (s *Auth) GetAccessToken(ctx context.Context, request operations.GetAccessTokenRequest, opts ...operations.Option) (*operations.GetAccessTokenResponse, error)

GetAccessToken - Get or refresh an access token for the current workspace.

func (*Auth) GetUser added in v3.4.6 

func (s *Auth) GetUser(ctx context.Context, opts ...operations.Option) (*operations.GetUserResponse, error)

GetUser - Get information about the current user.

func (*Auth) ValidateAPIKey added in v3.1.0 

func (s *Auth) ValidateAPIKey(ctx context.Context, opts ...operations.Option) (*operations.ValidateAPIKeyResponse, error)

ValidateAPIKey - Validate the current api key.

type Embeds 

type Embeds struct {
	// contains filtered or unexported fields
}

Embeds - REST APIs for managing embeds

func (*Embeds) GetEmbedAccessToken 

func (s *Embeds) GetEmbedAccessToken(ctx context.Context, request operations.GetEmbedAccessTokenRequest, opts ...operations.Option) (*operations.GetEmbedAccessTokenResponse, error)

GetEmbedAccessToken - Get an embed access token for the current workspace. Returns an embed access token for the current workspace. This can be used to authenticate access to externally embedded content. Filters can be applied allowing views to be filtered to things like particular customerIds.

func (*Embeds) GetValidEmbedAccessTokens 

func (s *Embeds) GetValidEmbedAccessTokens(ctx context.Context, opts ...operations.Option) (*operations.GetValidEmbedAccessTokensResponse, error)

GetValidEmbedAccessTokens - Get all valid embed access tokens for the current workspace.

func (*Embeds) RevokeEmbedAccessToken 

func (s *Embeds) RevokeEmbedAccessToken(ctx context.Context, request operations.RevokeEmbedAccessTokenRequest, opts ...operations.Option) (*operations.RevokeEmbedAccessTokenResponse, error)

RevokeEmbedAccessToken - Revoke an embed access EmbedToken.

type Events added in v3.1.0 

type Events struct {
	// contains filtered or unexported fields
}

Events - REST APIs for capturing event data

func (*Events) GetEventsByTarget added in v3.14.0 

func (s *Events) GetEventsByTarget(ctx context.Context, request operations.GetWorkspaceEventsByTargetRequest, opts ...operations.Option) (*operations.GetWorkspaceEventsByTargetResponse, error)

GetEventsByTarget - Load recent events for a particular workspace

func (*Events) GetTargets added in v3.14.0 

func (s *Events) GetTargets(ctx context.Context, request operations.GetWorkspaceTargetsRequest, opts ...operations.Option) (*operations.GetWorkspaceTargetsResponse, error)

GetTargets - Load targets for a particular workspace

func (*Events) GetTargetsDeprecated added in v3.14.0 

func (s *Events) GetTargetsDeprecated(ctx context.Context, request operations.GetWorkspaceTargetsDeprecatedRequest, opts ...operations.Option) (*operations.GetWorkspaceTargetsDeprecatedResponse, error)

GetTargetsDeprecated - Load targets for a particular workspace

func (*Events) Post added in v3.14.0 

func (s *Events) Post(ctx context.Context, request operations.PostWorkspaceEventsRequest, opts ...operations.Option) (*operations.PostWorkspaceEventsResponse, error)

Post events for a specific workspace Sends an array of events to be stored for a particular workspace.

func (*Events) Search added in v3.14.0 

func (s *Events) Search(ctx context.Context, request operations.SearchWorkspaceEventsRequest, opts ...operations.Option) (*operations.SearchWorkspaceEventsResponse, error)

Search events for a particular workspace by any field

type Github added in v3.8.0 

type Github struct {
	// contains filtered or unexported fields
}

func (*Github) CheckAccess added in v3.8.9 

func (s *Github) CheckAccess(ctx context.Context, request operations.CheckGithubAccessRequest, opts ...operations.Option) (*operations.CheckGithubAccessResponse, error)

func (*Github) CheckPublishingPRs added in v3.14.0 

func (s *Github) CheckPublishingPRs(ctx context.Context, request operations.GithubCheckPublishingPRsRequest, opts ...operations.Option) (*operations.GithubCheckPublishingPRsResponse, error)

func (*Github) CheckPublishingSecrets added in v3.14.0 

func (s *Github) CheckPublishingSecrets(ctx context.Context, request operations.GithubCheckPublishingSecretsRequest, opts ...operations.Option) (*operations.GithubCheckPublishingSecretsResponse, error)

func (*Github) ConfigureCodeSamples added in v3.8.9 

func (s *Github) ConfigureCodeSamples(ctx context.Context, request shared.GithubConfigureCodeSamplesRequest, opts ...operations.Option) (*operations.GithubConfigureCodeSamplesResponse, error)

func (*Github) ConfigureMintlifyRepo added in v3.8.9 

func (s *Github) ConfigureMintlifyRepo(ctx context.Context, request shared.GithubConfigureMintlifyRepoRequest, opts ...operations.Option) (*operations.GithubConfigureMintlifyRepoResponse, error)

func (*Github) ConfigureTarget added in v3.8.9 

func (s *Github) ConfigureTarget(ctx context.Context, request shared.GithubConfigureTargetRequest, opts ...operations.Option) (*operations.GithubConfigureTargetResponse, error)

func (*Github) GetAction added in v3.9.0 

func (s *Github) GetAction(ctx context.Context, request operations.GetGitHubActionRequest, opts ...operations.Option) (*operations.GetGitHubActionResponse, error)

func (*Github) StorePublishingSecrets added in v3.14.0 

func (s *Github) StorePublishingSecrets(ctx context.Context, request shared.GithubStorePublishingSecretsRequest, opts ...operations.Option) (*operations.GithubStorePublishingSecretsResponse, error)

func (*Github) TriggerAction added in v3.8.9 

func (s *Github) TriggerAction(ctx context.Context, request shared.GithubTriggerActionRequest, opts ...operations.Option) (*operations.GithubTriggerActionResponse, error)

type HTTPClient 

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient provides an interface for suplying the SDK with a custom HTTP client

type Metadata 

type Metadata struct {
	// contains filtered or unexported fields
}

Metadata - REST APIs for managing Version Metadata entities

func (*Metadata) DeleteVersionMetadata 

func (s *Metadata) DeleteVersionMetadata(ctx context.Context, request operations.DeleteVersionMetadataRequest, opts ...operations.Option) (*operations.DeleteVersionMetadataResponse, error)

DeleteVersionMetadata - Delete metadata for a particular apiID and versionID.

func (*Metadata) GetVersionMetadata 

func (s *Metadata) GetVersionMetadata(ctx context.Context, request operations.GetVersionMetadataRequest, opts ...operations.Option) (*operations.GetVersionMetadataResponse, error)

GetVersionMetadata - Get all metadata for a particular apiID and versionID.

func (*Metadata) InsertVersionMetadata 

func (s *Metadata) InsertVersionMetadata(ctx context.Context, request operations.InsertVersionMetadataRequest, opts ...operations.Option) (*operations.InsertVersionMetadataResponse, error)

InsertVersionMetadata - Insert metadata for a particular apiID and versionID.

type Organizations added in v3.4.2 

type Organizations struct {
	// contains filtered or unexported fields
}

func (*Organizations) Create added in v3.14.0 

func (s *Organizations) Create(ctx context.Context, request shared.Organization, opts ...operations.Option) (*operations.CreateOrganizationResponse, error)

Create an organization Creates an organization

func (*Organizations) CreateFreeTrial added in v3.8.2 

func (s *Organizations) CreateFreeTrial(ctx context.Context, opts ...operations.Option) (*operations.CreateFreeTrialResponse, error)

CreateFreeTrial - Create a free trial for an organization Creates a free trial for an organization

func (*Organizations) Get added in v3.14.0 

func (s *Organizations) Get(ctx context.Context, request operations.GetOrganizationRequest, opts ...operations.Option) (*operations.GetOrganizationResponse, error)

Get organization Get information about a particular organization.

func (*Organizations) GetAll added in v3.14.0 

func (s *Organizations) GetAll(ctx context.Context, opts ...operations.Option) (*operations.GetOrganizationsResponse, error)

GetAll - Get organizations for a user Returns a list of organizations a user has access too

func (*Organizations) GetUsage added in v3.14.0 

func (s *Organizations) GetUsage(ctx context.Context, opts ...operations.Option) (*operations.GetOrganizationUsageResponse, error)

GetUsage - Get billing usage summary for a particular organization Returns a billing usage summary by target languages for a particular organization

type Reports added in v3.5.5 

type Reports struct {
	// contains filtered or unexported fields
}

Reports - REST APIs for managing reports

func (*Reports) GetChangesReportSignedURL added in v3.5.6 

func (s *Reports) GetChangesReportSignedURL(ctx context.Context, request operations.GetChangesReportSignedURLRequest, opts ...operations.Option) (*operations.GetChangesReportSignedURLResponse, error)

GetChangesReportSignedURL - Get the signed access url for the change reports for a particular document.

func (*Reports) GetLintingReportSignedURL added in v3.5.5 

func (s *Reports) GetLintingReportSignedURL(ctx context.Context, request operations.GetLintingReportSignedURLRequest, opts ...operations.Option) (*operations.GetLintingReportSignedURLResponse, error)

GetLintingReportSignedURL - Get the signed access url for the linting reports for a particular document.

func (*Reports) UploadReport added in v3.5.5 

func (s *Reports) UploadReport(ctx context.Context, request operations.UploadReportRequestBody, opts ...operations.Option) (*operations.UploadReportResponse, error)

UploadReport - Upload a report.

type Requests 

type Requests struct {
	// contains filtered or unexported fields
}

Requests - REST APIs for retrieving request information

func (*Requests) GenerateRequestPostmanCollection 

func (s *Requests) GenerateRequestPostmanCollection(ctx context.Context, request operations.GenerateRequestPostmanCollectionRequest, opts ...operations.Option) (*operations.GenerateRequestPostmanCollectionResponse, error)

GenerateRequestPostmanCollection - Generate a Postman collection for a particular request. Generates a Postman collection for a particular request. Allowing it to be replayed with the same inputs that were captured by the SDK.

func (*Requests) GetRequestFromEventLog 

func (s *Requests) GetRequestFromEventLog(ctx context.Context, request operations.GetRequestFromEventLogRequest, opts ...operations.Option) (*operations.GetRequestFromEventLogResponse, error)

GetRequestFromEventLog - Get information about a particular request.

func (*Requests) QueryEventLog 

func (s *Requests) QueryEventLog(ctx context.Context, request operations.QueryEventLogRequest, opts ...operations.Option) (*operations.QueryEventLogResponse, error)

QueryEventLog - Query the event log to retrieve a list of requests. Supports retrieving a list of request captured by the SDK for this workspace. Allows the filtering of requests on a number of criteria such as ApiID, VersionID, Path, Method, etc.

type SDKOption 

type SDKOption func(*Speakeasy)

func WithClient 

func WithClient(client HTTPClient) SDKOption

WithClient allows the overriding of the default HTTP client used by the SDK

func WithRetryConfig 

func WithRetryConfig(retryConfig retry.Config) SDKOption

func WithSecurity 

func WithSecurity(security shared.Security) SDKOption

WithSecurity configures the SDK to use the provided security details

func WithSecuritySource 

func WithSecuritySource(security func(context.Context) (shared.Security, error)) SDKOption

WithSecuritySource configures the SDK to invoke the Security Source function on each method call to determine authentication

func WithServer 

func WithServer(server string) SDKOption

WithServer allows the overriding of the default server by name

func WithServerURL 

func WithServerURL(serverURL string) SDKOption

WithServerURL allows the overriding of the default server URL

func WithTemplatedServerURL 

func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption

WithTemplatedServerURL allows the overriding of the default server URL with a templated URL populated with the provided parameters

func WithTimeout added in v3.9.0 

func WithTimeout(timeout time.Duration) SDKOption

WithTimeout Optional request timeout applied to each operation

func WithWorkspaceID added in v3.1.0 

func WithWorkspaceID(workspaceID string) SDKOption

WithWorkspaceID allows setting the WorkspaceID parameter for all supported operations

type Schemas 

type Schemas struct {
	// contains filtered or unexported fields
}

Schemas - REST APIs for managing Schema entities

func (*Schemas) DeleteSchema 

func (s *Schemas) DeleteSchema(ctx context.Context, request operations.DeleteSchemaRequest, opts ...operations.Option) (*operations.DeleteSchemaResponse, error)

DeleteSchema - Delete a particular schema revision for an Api.

func (*Schemas) DownloadSchema 

func (s *Schemas) DownloadSchema(ctx context.Context, request operations.DownloadSchemaRequest, opts ...operations.Option) (*operations.DownloadSchemaResponse, error)

DownloadSchema - Download the latest schema for a particular apiID.

func (*Schemas) DownloadSchemaRevision 

func (s *Schemas) DownloadSchemaRevision(ctx context.Context, request operations.DownloadSchemaRevisionRequest, opts ...operations.Option) (*operations.DownloadSchemaRevisionResponse, error)

DownloadSchemaRevision - Download a particular schema revision for an Api.

func (*Schemas) GetSchema 

func (s *Schemas) GetSchema(ctx context.Context, request operations.GetSchemaRequest, opts ...operations.Option) (*operations.GetSchemaResponse, error)

GetSchema - Get information about the latest schema. Returns information about the last uploaded schema for a particular API version. This won't include the schema itself, that can be retrieved via the downloadSchema operation.

func (*Schemas) GetSchemaDiff 

func (s *Schemas) GetSchemaDiff(ctx context.Context, request operations.GetSchemaDiffRequest, opts ...operations.Option) (*operations.GetSchemaDiffResponse, error)

GetSchemaDiff - Get a diff of two schema revisions for an Api.

func (*Schemas) GetSchemaRevision 

func (s *Schemas) GetSchemaRevision(ctx context.Context, request operations.GetSchemaRevisionRequest, opts ...operations.Option) (*operations.GetSchemaRevisionResponse, error)

GetSchemaRevision - Get information about a particular schema revision for an Api. Returns information about the last uploaded schema for a particular schema revision. This won't include the schema itself, that can be retrieved via the downloadSchema operation.

func (*Schemas) GetSchemas 

func (s *Schemas) GetSchemas(ctx context.Context, request operations.GetSchemasRequest, opts ...operations.Option) (*operations.GetSchemasResponse, error)

GetSchemas - Get information about all schemas associated with a particular apiID. Returns information the schemas associated with a particular apiID. This won't include the schemas themselves, they can be retrieved via the downloadSchema operation.

func (*Schemas) RegisterSchema 

func (s *Schemas) RegisterSchema(ctx context.Context, request operations.RegisterSchemaRequest, opts ...operations.Option) (*operations.RegisterSchemaResponse, error)

RegisterSchema - Register a schema. Allows uploading a schema for a particular API version. This will be used to populate ApiEndpoints and used as a base for any schema generation if present.

type ShortURLs added in v3.9.0 

type ShortURLs struct {
	// contains filtered or unexported fields
}

ShortURLs - REST APIs for managing short URLs

func (*ShortURLs) Create added in v3.9.0 

func (s *ShortURLs) Create(ctx context.Context, request operations.CreateRequestBody, opts ...operations.Option) (*operations.CreateResponse, error)

Create - Shorten a URL.

type Speakeasy 

type Speakeasy struct {
	// REST APIs for managing Api entities
	Apis *Apis
	// REST APIs for managing ApiEndpoint entities
	APIEndpoints *APIEndpoints
	// REST APIs for managing Version Metadata entities
	Metadata *Metadata
	// REST APIs for managing Schema entities
	Schemas *Schemas
	// REST APIs for working with Registry artifacts
	Artifacts *Artifacts
	// REST APIs for managing Authentication
	Auth *Auth
	// REST APIs for retrieving request information
	Requests      *Requests
	Github        *Github
	Organizations *Organizations
	// REST APIs for managing reports
	Reports *Reports
	// REST APIs for managing short URLs
	ShortURLs *ShortURLs
	// REST APIs for managing LLM OAS suggestions
	Suggest    *Suggest
	Workspaces *Workspaces
	// REST APIs for managing embeds
	Embeds *Embeds
	// REST APIs for capturing event data
	Events *Events
	// REST APIs for managing subscriptions
	Subscriptions *Subscriptions
	// contains filtered or unexported fields
}

Speakeasy API: The Subscriptions API manages subscriptions for CLI and registry events

/docs - The Speakeasy Platform Documentation

func New 

func New(opts ...SDKOption) *Speakeasy

New creates a new instance of the SDK with the provided options

type Subscriptions added in v3.14.8 

type Subscriptions struct {
	// contains filtered or unexported fields
}

Subscriptions - REST APIs for managing subscriptions

func (*Subscriptions) CreateSubscription added in v3.14.8 

func (s *Subscriptions) CreateSubscription(ctx context.Context, request operations.CreateSubscriptionRequest, opts ...operations.Option) (*operations.CreateSubscriptionResponse, error)

CreateSubscription - Create Subscription

func (*Subscriptions) ListRegistrySubscriptions added in v3.14.9 

func (s *Subscriptions) ListRegistrySubscriptions(ctx context.Context, request operations.ListRegistrySubscriptionsRequest, opts ...operations.Option) (*operations.ListRegistrySubscriptionsResponse, error)

ListRegistrySubscriptions - List Subscriptions

type Suggest added in v3.8.2 

type Suggest struct {
	// contains filtered or unexported fields
}

Suggest - REST APIs for managing LLM OAS suggestions

func (*Suggest) Suggest added in v3.13.1 

func (s *Suggest) Suggest(ctx context.Context, request operations.SuggestRequest, opts ...operations.Option) (*operations.SuggestResponse, error)

Suggest - Generate suggestions for improving an OpenAPI document. Get suggestions from an LLM model for improving an OpenAPI document.

func (*Suggest) SuggestItems added in v3.14.4 

func (s *Suggest) SuggestItems(ctx context.Context, request shared.SuggestItemsRequestBody, opts ...operations.Option) (*operations.SuggestItemsResponse, error)

SuggestItems - Generate generic suggestions for a list of items.

func (*Suggest) SuggestOpenAPI added in v3.13.0 

func (s *Suggest) SuggestOpenAPI(ctx context.Context, request operations.SuggestOpenAPIRequest, opts ...operations.Option) (*operations.SuggestOpenAPIResponse, error)

SuggestOpenAPI - (DEPRECATED) Generate suggestions for improving an OpenAPI document. Get suggestions from an LLM model for improving an OpenAPI document.

func (*Suggest) SuggestOpenAPIRegistry added in v3.13.0 

func (s *Suggest) SuggestOpenAPIRegistry(ctx context.Context, request operations.SuggestOpenAPIRegistryRequest, opts ...operations.Option) (*operations.SuggestOpenAPIRegistryResponse, error)

SuggestOpenAPIRegistry - Generate suggestions for improving an OpenAPI document stored in the registry. Get suggestions from an LLM model for improving an OpenAPI document stored in the registry.

type Workspaces added in v3.10.1 

type Workspaces struct {
	// contains filtered or unexported fields
}

func (*Workspaces) Create added in v3.14.0 

func (s *Workspaces) Create(ctx context.Context, request shared.Workspace, opts ...operations.Option) (*operations.CreateWorkspaceResponse, error)

Create a workspace Creates a workspace

func (*Workspaces) CreateToken added in v3.14.0 

func (s *Workspaces) CreateToken(ctx context.Context, request operations.CreateWorkspaceTokenRequest, opts ...operations.Option) (*operations.CreateWorkspaceTokenResponse, error)

CreateToken - Create a token for a particular workspace

func (*Workspaces) DeleteToken added in v3.14.0 

func (s *Workspaces) DeleteToken(ctx context.Context, request operations.DeleteWorkspaceTokenRequest, opts ...operations.Option) (*operations.DeleteWorkspaceTokenResponse, error)

DeleteToken - Delete a token for a particular workspace

func (*Workspaces) Get added in v3.14.0 

func (s *Workspaces) Get(ctx context.Context, opts ...operations.Option) (*operations.GetWorkspaceByContextResponse, error)

Get workspace by context Get information about a particular workspace by context.

func (*Workspaces) GetAll added in v3.14.0 

func (s *Workspaces) GetAll(ctx context.Context, opts ...operations.Option) (*operations.GetWorkspacesResponse, error)

GetAll - Get workspaces for a user Returns a list of workspaces a user has access too

func (*Workspaces) GetByID added in v3.14.0 

func (s *Workspaces) GetByID(ctx context.Context, request operations.GetWorkspaceRequest, opts ...operations.Option) (*operations.GetWorkspaceResponse, error)

GetByID - Get workspace Get information about a particular workspace.

func (*Workspaces) GetFeatureFlags added in v3.14.0 

func (s *Workspaces) GetFeatureFlags(ctx context.Context, request operations.GetWorkspaceFeatureFlagsRequest, opts ...operations.Option) (*operations.GetWorkspaceFeatureFlagsResponse, error)

GetFeatureFlags - Get workspace feature flags

func (*Workspaces) GetSettings added in v3.14.0 

func (s *Workspaces) GetSettings(ctx context.Context, request operations.GetWorkspaceSettingsRequest, opts ...operations.Option) (*operations.GetWorkspaceSettingsResponse, error)

GetSettings - Get workspace settings Get settings about a particular workspace.

func (*Workspaces) GetTeam added in v3.14.0 

func (s *Workspaces) GetTeam(ctx context.Context, request operations.GetWorkspaceTeamRequest, opts ...operations.Option) (*operations.GetWorkspaceTeamResponse, error)

GetTeam - Get team members for a particular workspace

func (*Workspaces) GetTokens added in v3.14.0 

func (s *Workspaces) GetTokens(ctx context.Context, request operations.GetWorkspaceTokensRequest, opts ...operations.Option) (*operations.GetWorkspaceTokensResponse, error)

GetTokens - Get tokens for a particular workspace

func (*Workspaces) GrantAccess added in v3.14.0 

func (s *Workspaces) GrantAccess(ctx context.Context, request operations.GrantUserAccessToWorkspaceRequest, opts ...operations.Option) (*operations.GrantUserAccessToWorkspaceResponse, error)

GrantAccess - Grant a user access to a particular workspace

func (*Workspaces) RevokeAccess added in v3.14.0 

func (s *Workspaces) RevokeAccess(ctx context.Context, request operations.RevokeUserAccessToWorkspaceRequest, opts ...operations.Option) (*operations.RevokeUserAccessToWorkspaceResponse, error)

RevokeAccess - Revoke a user's access to a particular workspace

func (*Workspaces) Update added in v3.14.0 

func (s *Workspaces) Update(ctx context.Context, request operations.UpdateWorkspaceDetailsRequest, opts ...operations.Option) (*operations.UpdateWorkspaceDetailsResponse, error)

Update workspace details Update information about a particular workspace.

func (*Workspaces) UpdateSettings added in v3.14.0 

func (s *Workspaces) UpdateSettings(ctx context.Context, request operations.UpdateWorkspaceSettingsRequest, opts ...operations.Option) (*operations.UpdateWorkspaceSettingsResponse, error)

UpdateSettings - Update workspace settings Update settings about a particular workspace.

Source Files

View all Source files

Directories

Path Synopsis
internal
globals
hooks
pkg
models/operations
models/sdkerrors
models/shared
retry
types
utils

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.