github.com/speakeasy-sdks/risk-go

🏗 Welcome to your new SDK! 🏗

It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:

• 🛠 Make your SDK feel handcrafted by customizing it
• ♻️ Refine your SDK quickly by iterating locally with the Speakeasy CLI
• 🎁 Publish your SDK to package managers by configuring automatic publishing
• ✨ When ready to productionize, delete this section from the README

SDK Installation

go get github.com/speakeasy-sdks/risk-go

SDK Example Usage

Example

package main

import (
	"context"
	riskgo "github.com/speakeasy-sdks/risk-go"
	"github.com/speakeasy-sdks/risk-go/pkg/models/operations"
	"github.com/speakeasy-sdks/risk-go/pkg/models/shared"
	"log"
)

func main() {
	s := riskgo.New(
		riskgo.WithSecurity(shared.Security{
			Basic: &shared.SchemeBasic{
				Password: "<YOUR_PASSWORD_HERE>",
				Username: "<YOUR_USERNAME_HERE>",
			},
		}),
	)

	ctx := context.Background()
	res, err := s.Authentication.GetAPIToken(ctx, operations.GetAPITokenRequest{})
	if err != nil {
		log.Fatal(err)
	}
	if res.LegacyAPITokenOut != nil {
		// handle response
	}
}

Available Resources and Operations

Authentication

• GetAPIToken - Create an API Access Token

Application

• Create - Create an application
• Delete - Delete an application
• Read - Retrieve an application
• ReadAll - Retrieve applications
• Update - Update an application

Field

• ReadAll - Retrieve fields

Record

• ReadAll - Retrieve records

Step

• Create - Create a step
• Delete - Delete a step
• Read - Retrieve a step
• ReadAll - Retrieve steps
• Update - Update a step

WorkflowMap

• Create - Create a workflow map
• Delete - Delete a workflow map
• Read - Retrieve a workflow map
• ReadAll - Retrieve workflow maps
• Update - Update a workflow map

Workflow

• Create - Create a workflow
• Delete - Delete a workflow
• Read - Retrieve a workflow
• ReadAll - Retrieve workflows
• Update - Update a workflow

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. When specified by the OpenAPI spec document, the SDK will return the appropriate subclass.

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

Example

package main

import (
	"context"
	"errors"
	riskgo "github.com/speakeasy-sdks/risk-go"
	"github.com/speakeasy-sdks/risk-go/pkg/models/operations"
	"github.com/speakeasy-sdks/risk-go/pkg/models/sdkerrors"
	"github.com/speakeasy-sdks/risk-go/pkg/models/shared"
	"log"
)

func main() {
	s := riskgo.New(
		riskgo.WithSecurity(shared.Security{
			Basic: &shared.SchemeBasic{
				Password: "<YOUR_PASSWORD_HERE>",
				Username: "<YOUR_USERNAME_HERE>",
			},
		}),
	)

	ctx := context.Background()
	res, err := s.Authentication.GetAPIToken(ctx, operations.GetAPITokenRequest{})
	if err != nil {

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

Server Selection

Select Server by Index

You can override the default server globally using the WithServerIndex 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 indexes associated with the available servers:

#	Server	Variables
0	http://localhost	None

Example

package main

import (
	"context"
	riskgo "github.com/speakeasy-sdks/risk-go"
	"github.com/speakeasy-sdks/risk-go/pkg/models/operations"
	"github.com/speakeasy-sdks/risk-go/pkg/models/shared"
	"log"
)

func main() {
	s := riskgo.New(
		riskgo.WithServerIndex(0),
		riskgo.WithSecurity(shared.Security{
			Basic: &shared.SchemeBasic{
				Password: "<YOUR_PASSWORD_HERE>",
				Username: "<YOUR_USERNAME_HERE>",
			},
		}),
	)

	ctx := context.Background()
	res, err := s.Authentication.GetAPIToken(ctx, operations.GetAPITokenRequest{})
	if err != nil {
		log.Fatal(err)
	}
	if res.LegacyAPITokenOut != 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"
	riskgo "github.com/speakeasy-sdks/risk-go"
	"github.com/speakeasy-sdks/risk-go/pkg/models/operations"
	"github.com/speakeasy-sdks/risk-go/pkg/models/shared"
	"log"
)

func main() {
	s := riskgo.New(
		riskgo.WithServerURL("http://localhost"),
		riskgo.WithSecurity(shared.Security{
			Basic: &shared.SchemeBasic{
				Password: "<YOUR_PASSWORD_HERE>",
				Username: "<YOUR_USERNAME_HERE>",
			},
		}),
	)

	ctx := context.Background()
	res, err := s.Authentication.GetAPIToken(ctx, operations.GetAPITokenRequest{})
	if err != nil {
		log.Fatal(err)
	}
	if res.LegacyAPITokenOut != 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.

Special Types

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

Name	Type	Scheme
Basic	http	HTTP Basic
Bearer	http	HTTP Bearer

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"
	riskgo "github.com/speakeasy-sdks/risk-go"
	"github.com/speakeasy-sdks/risk-go/pkg/models/operations"
	"github.com/speakeasy-sdks/risk-go/pkg/models/shared"
	"log"
)

func main() {
	s := riskgo.New(
		riskgo.WithSecurity(shared.Security{
			Basic: &shared.SchemeBasic{
				Password: "<YOUR_PASSWORD_HERE>",
				Username: "<YOUR_USERNAME_HERE>",
			},
		}),
	)

	ctx := context.Background()
	res, err := s.Authentication.GetAPIToken(ctx, operations.GetAPITokenRequest{})
	if err != nil {
		log.Fatal(err)
	}
	if res.LegacyAPITokenOut != nil {
		// handle response
	}
}

Development

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