Go

The Go library is the lingara package in the module github.com/Spinning-Cat-Studios/lingara_api_clients/go. It needs Go 1.23 or later and uses only the standard library.

How it reads

Every call takes a context.Context first. Cancel the context to cancel the call; the error you get back is the context’s own, so errors.Is(err, context.Canceled) works.
Calls are synchronous. Run them in goroutines when you want several at once; one client is safe to share.
A stream is read with for ev, err := range s.Events(), and each event is matched with a type switch. Close it with defer s.Close().
Errors are four types that share the lingara.Error interface. Use errors.As to reach one; RetryAfter is nil when the API named no wait.
Options are functional: pass lingara.WithHTTPClient to use your own http.Client. Its Timeout then limits every call, streams included.

The samples below install the module, create a client, stream a vocabulary list and handle an error.

go get github.com/Spinning-Cat-Studios/lingara_api_clients/go@v0.1.0-alpha.6

import (
	"os"

	lingara "github.com/Spinning-Cat-Studios/lingara_api_clients/go"
)

client, err := lingara.New(
	lingara.WithClientCredentials(os.Getenv("LINGARA_CLIENT_ID"), os.Getenv("LINGARA_CLIENT_SECRET")),
)
if err != nil {
	return nil, err
}

count := uint8(8)
s, err := client.GenerateVocabulary(ctx, lingara.VocabRequest{Level: 2, SourceLang: "en", TargetLang: "zh", Count: &count})
if err != nil {
	return err
}
defer s.Close()
for ev, err := range s.Events() {
	if err != nil {
		return err
	}
	if item, ok := ev.(lingara.GenerateVocabularyEventItem); ok {
		fmt.Println(item.Data.Word, item.Data.Translation)
	}
}

_, err := client.GetUsage(ctx)
var apiErr *lingara.APIError
var oauthErr *lingara.OAuthError
var maintenance *lingara.MaintenanceError
var transport *lingara.TransportError
switch {
case err == nil:
case errors.As(err, &apiErr):
	// A refusal from the API: Status, Code (stable) and Message (localised).
	fmt.Println(apiErr.Status, apiErr.Code, apiErr.Message)
	if apiErr.RetryAfter != nil {
		fmt.Println("retry after", *apiErr.RetryAfter)
	}
case errors.As(err, &oauthErr):
	// The token endpoint refused the credentials or the scopes.
	fmt.Println(oauthErr.Status, oauthErr.ErrorCode, oauthErr.Description)
case errors.As(err, &maintenance):
	fmt.Println("under maintenance")
	if maintenance.RetryAfter != nil {
		fmt.Println("retry after", *maintenance.RetryAfter)
	}
case errors.As(err, &transport):
	// No usable answer: connect, tls, reset, timeout, and so on.
	fmt.Println("transport:", transport.Kind)
default:
	// ctx was cancelled or timed out: errors.Is(err, context.Canceled).
	fmt.Println(err)
}

Go

How it reads

What this page wraps