speakeasyclientsdkgo

package module
v3.18.0 Latest Latest
Warning

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

 Go to latest Published: Dec 17, 2024 License: Apache-2.0 Imports: 13 Imported by: 1

README

Speakeasy

Speakeasy Go SDK

The platform to build, test, document and distribute APIs to your users ❤️ Building really high quality APIs is hard. Speakeasy is a set of OpenAPI tools to make it easier.

Developer-friendly & type-safe Go SDK specifically catered to leverage the Speakeasy API.

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/shared"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

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

	content, fileErr := os.Open("example.file")
	if fileErr != nil {
		panic(fileErr)
	}

	res, err := s.GenerateCodeSamplePreview(ctx, shared.CodeSampleSchemaInput{
		Languages: []string{
			"<value>",
			"<value>",
		},
		SchemaFile: shared.SchemaFile{
			Content:  content,
			FileName: "example.file",
		},
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.TwoHundredApplicationJSONResponseStream != nil {
		// handle response
	}
}

Available Resources and Operations

Available methods

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.

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

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

ShortURLs

Speakeasy SDK

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 GenerateCodeSamplePreview function may return the following errors:

Error Type Status Code Content Type
sdkerrors.Error 4XX, 5XX application/json

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/sdkerrors"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

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

	content, fileErr := os.Open("example.file")
	if fileErr != nil {
		panic(fileErr)
	}

	res, err := s.GenerateCodeSamplePreview(ctx, shared.CodeSampleSchemaInput{
		Languages: []string{
			"<value>",
			"<value>",
		},
		SchemaFile: shared.SchemaFile{
			Content:  content,
			FileName: "example.file",
		},
	})
	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(server string) 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
prod https://api.prod.speakeasyapi.dev
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/shared"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

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

	content, fileErr := os.Open("example.file")
	if fileErr != nil {
		panic(fileErr)
	}

	res, err := s.GenerateCodeSamplePreview(ctx, shared.CodeSampleSchemaInput{
		Languages: []string{
			"<value>",
			"<value>",
		},
		SchemaFile: shared.SchemaFile{
			Content:  content,
			FileName: "example.file",
		},
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.TwoHundredApplicationJSONResponseStream != nil {
		// handle response
	}
}

Override Server URL Per-Client

The default server can also be overridden globally using the WithServerURL(serverURL string) 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/shared"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

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

	content, fileErr := os.Open("example.file")
	if fileErr != nil {
		panic(fileErr)
	}

	res, err := s.GenerateCodeSamplePreview(ctx, shared.CodeSampleSchemaInput{
		Languages: []string{
			"<value>",
			"<value>",
		},
		SchemaFile: shared.SchemaFile{
			Content:  content,
			FileName: "example.file",
		},
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.TwoHundredApplicationJSONResponseStream != 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/shared"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

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

	content, fileErr := os.Open("example.file")
	if fileErr != nil {
		panic(fileErr)
	}

	res, err := s.GenerateCodeSamplePreview(ctx, shared.CodeSampleSchemaInput{
		Languages: []string{
			"<value>",
			"<value>",
		},
		SchemaFile: shared.SchemaFile{
			Content:  content,
			FileName: "example.file",
		},
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.TwoHundredApplicationJSONResponseStream != 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 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() {
	ctx := context.Background()

	s := speakeasyclientsdkgo.New()

	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/shared"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/retry"
	"log"
	"os"
	"pkg/models/operations"
)

func main() {
	ctx := context.Background()

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

	content, fileErr := os.Open("example.file")
	if fileErr != nil {
		panic(fileErr)
	}

	res, err := s.GenerateCodeSamplePreview(ctx, shared.CodeSampleSchemaInput{
		Languages: []string{
			"<value>",
			"<value>",
		},
		SchemaFile: shared.SchemaFile{
			Content:  content,
			FileName: "example.file",
		},
	}, 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.TwoHundredApplicationJSONResponseStream != 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/shared"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/retry"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	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>"),
		}),
	)

	content, fileErr := os.Open("example.file")
	if fileErr != nil {
		panic(fileErr)
	}

	res, err := s.GenerateCodeSamplePreview(ctx, shared.CodeSampleSchemaInput{
		Languages: []string{
			"<value>",
			"<value>",
		},
		SchemaFile: shared.SchemaFile{
			Content:  content,
			FileName: "example.file",
		},
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.TwoHundredApplicationJSONResponseStream != 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 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

func (*Artifacts) SetVisibility added in v3.16.0 

func (s *Artifacts) SetVisibility(ctx context.Context, request operations.SetVisibilityRequest, opts ...operations.Option) (*operations.SetVisibilityResponse, error)

SetVisibility - Set visibility of a namespace with an existing metadata entry

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 Events added in v3.1.0 

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

Events - REST APIs for managing events captured by a speakeasy binary (CLI, GitHub Action etc)

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
}

Github - REST APIs for managing the github integration

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) GetSetup added in v3.15.8 

func (s *Github) GetSetup(ctx context.Context, request operations.GetGithubSetupStateRequest, opts ...operations.Option) (*operations.GetGithubSetupStateResponse, error)

func (*Github) LinkGithub added in v3.15.3 

func (s *Github) LinkGithub(ctx context.Context, request operations.LinkGithubAccessRequest, opts ...operations.Option) (*operations.LinkGithubAccessResponse, 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 Organizations added in v3.4.2 

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

Organizations - REST APIs for managing Organizations (speakeasy L1 Tenancy construct)

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 (lint reports, change reports, etc)

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 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 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 working with Registry artifacts
	Artifacts *Artifacts
	// REST APIs for managing Authentication
	Auth *Auth
	// REST APIs for managing the github integration
	Github *Github
	// REST APIs for managing Organizations (speakeasy L1 Tenancy construct)
	Organizations *Organizations
	// REST APIs for managing reports (lint reports, change reports, etc)
	Reports *Reports
	// REST APIs for managing short URLs
	ShortURLs *ShortURLs
	// REST APIs for managing subscriptions
	Subscriptions *Subscriptions
	// REST APIs for managing LLM OAS suggestions
	Suggest *Suggest
	// REST APIs for managing Workspaces (speakeasy tenancy)
	Workspaces *Workspaces
	// REST APIs for managing events captured by a speakeasy binary (CLI, GitHub Action etc)
	Events *Events
	// 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

func (*Speakeasy) GenerateCodeSamplePreview added in v3.15.5 

func (s *Speakeasy) GenerateCodeSamplePreview(ctx context.Context, request shared.CodeSampleSchemaInput, opts ...operations.Option) (*operations.GenerateCodeSamplePreviewResponse, error)

GenerateCodeSamplePreview - Generate Code Sample previews from a file and configuration parameters. This endpoint generates Code Sample previews from a file and configuration parameters.

func (*Speakeasy) GenerateCodeSamplePreviewAsync added in v3.15.5 

func (s *Speakeasy) GenerateCodeSamplePreviewAsync(ctx context.Context, request shared.CodeSampleSchemaInput, opts ...operations.Option) (*operations.GenerateCodeSamplePreviewAsyncResponse, error)

GenerateCodeSamplePreviewAsync - Initiate asynchronous Code Sample preview generation from a file and configuration parameters, receiving an async JobID response for polling. This endpoint generates Code Sample previews from a file and configuration parameters, receiving an async JobID response for polling.

func (*Speakeasy) GetCodeSamplePreviewAsync added in v3.15.5 

func (s *Speakeasy) GetCodeSamplePreviewAsync(ctx context.Context, request operations.GetCodeSamplePreviewAsyncRequest, opts ...operations.Option) (*operations.GetCodeSamplePreviewAsyncResponse, error)

GetCodeSamplePreviewAsync - Poll for the result of an asynchronous Code Sample preview generation. Poll for the result of an asynchronous Code Sample preview generation.

type Subscriptions added in v3.14.8 

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

Subscriptions - REST APIs for managing subscriptions

func (*Subscriptions) ActivateSubscriptionNamespace added in v3.17.1 

func (s *Subscriptions) ActivateSubscriptionNamespace(ctx context.Context, request operations.ActivateSubscriptionNamespaceRequest, opts ...operations.Option) (*operations.ActivateSubscriptionNamespaceResponse, error)

ActivateSubscriptionNamespace - Activate an ignored namespace for a subscription

func (*Subscriptions) IgnoreSubscriptionNamespace added in v3.17.1 

func (s *Subscriptions) IgnoreSubscriptionNamespace(ctx context.Context, request operations.IgnoreSubscriptionNamespaceRequest, opts ...operations.Option) (*operations.IgnoreSubscriptionNamespaceResponse, error)

IgnoreSubscriptionNamespace - Ignored a namespace for a subscription

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
}

Workspaces - REST APIs for managing Workspaces (speakeasy tenancy)

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.