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
go get github.com/dubinc/dub-gopackage main
import (
"context"
dubgo "github.com/dubinc/dub-go"
"github.com/dubinc/dub-go/models/operations"
"log"
)
func main() {
s := dubgo.New(
dubgo.WithSecurity("DUB_API_KEY"),
dubgo.WithWorkspaceID("<value>"),
)
var request *operations.CreateLinkRequestBody = &operations.CreateLinkRequestBody{
URL: "https://google/com",
ExternalID: dubgo.String("123456"),
TagIds: operations.CreateTagIdsArrayOfStr(
[]string{
"clux0rgak00011...",
},
),
}
ctx := context.Background()
res, err := s.Links.Create(ctx, request)
if err != nil {
log.Fatal(err)
}
if res.LinkSchema != nil {
// handle response
}
}package main
import (
"context"
dubgo "github.com/dubinc/dub-go"
"github.com/dubinc/dub-go/models/operations"
"log"
)
func main() {
s := dubgo.New(
dubgo.WithSecurity("DUB_API_KEY"),
dubgo.WithWorkspaceID("<value>"),
)
var request *operations.UpsertLinkRequestBody = &operations.UpsertLinkRequestBody{
URL: "https://google/com",
ExternalID: dubgo.String("123456"),
TagIds: operations.CreateUpsertLinkTagIdsArrayOfStr(
[]string{
"clux0rgak00011...",
},
),
}
ctx := context.Background()
res, err := s.Links.Upsert(ctx, request)
if err != nil {
log.Fatal(err)
}
if res.LinkSchema != nil {
// handle response
}
}- List - Retrieve a list of links
- Create - Create a new link
- Count - Retrieve the number of links
- Get - Retrieve a link
- Delete - Delete a link
- Update - Update a link
- CreateMany - Bulk create links
- Upsert - Upsert a link
- Get - Retrieve a QR code
- Retrieve - Retrieve analytics for a link, a domain, or the authenticated workspace.
- List - Retrieve a list of domains
- Add - Add a domain
- Delete - Delete a domain
- Update - Update a domain
- SetPrimary - Set a domain as primary
- Transfer - Transfer a domain
- Get - Retrieve the metatags for a URL
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.BadRequest | 400 | application/json |
| sdkerrors.Unauthorized | 401 | application/json |
| sdkerrors.Forbidden | 403 | application/json |
| sdkerrors.NotFound | 404 | application/json |
| sdkerrors.Conflict | 409 | application/json |
| sdkerrors.InviteExpired | 410 | application/json |
| sdkerrors.UnprocessableEntity | 422 | application/json |
| sdkerrors.RateLimitExceeded | 429 | application/json |
| sdkerrors.InternalServerError | 500 | application/json |
| sdkerrors.SDKError | 4xx-5xx | / |
package main
import (
"context"
"errors"
dubgo "github.com/dubinc/dub-go"
"github.com/dubinc/dub-go/models/operations"
"github.com/dubinc/dub-go/models/sdkerrors"
"log"
)
func main() {
s := dubgo.New(
dubgo.WithSecurity("DUB_API_KEY"),
dubgo.WithWorkspaceID("<value>"),
)
request := operations.GetLinksRequest{}
ctx := context.Background()
res, err := s.Links.List(ctx, request)
if err != nil {
var e *sdkerrors.BadRequest
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
var e *sdkerrors.Unauthorized
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
var e *sdkerrors.Forbidden
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
var e *sdkerrors.NotFound
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
var e *sdkerrors.Conflict
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
var e *sdkerrors.InviteExpired
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
var e *sdkerrors.UnprocessableEntity
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
var e *sdkerrors.RateLimitExceeded
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
var e *sdkerrors.InternalServerError
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())
}
}
}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 | https://api.dub.co |
None |
package main
import (
"context"
dubgo "github.com/dubinc/dub-go"
"github.com/dubinc/dub-go/models/operations"
"log"
)
func main() {
s := dubgo.New(
dubgo.WithServerIndex(0),
dubgo.WithSecurity("DUB_API_KEY"),
dubgo.WithWorkspaceID("<value>"),
)
request := operations.GetLinksRequest{}
ctx := context.Background()
res, err := s.Links.List(ctx, request)
if err != nil {
log.Fatal(err)
}
if res.LinkSchemas != nil {
// handle response
}
}The default server can also be overridden globally using the WithServerURL option when initializing the SDK client instance. For example:
package main
import (
"context"
dubgo "github.com/dubinc/dub-go"
"github.com/dubinc/dub-go/models/operations"
"log"
)
func main() {
s := dubgo.New(
dubgo.WithServerURL("https://api.dub.co"),
dubgo.WithSecurity("DUB_API_KEY"),
dubgo.WithWorkspaceID("<value>"),
)
request := operations.GetLinksRequest{}
ctx := context.Background()
res, err := s.Links.List(ctx, request)
if err != nil {
log.Fatal(err)
}
if res.LinkSchemas != nil {
// handle response
}
}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.
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
|---|---|---|
Token |
http | HTTP Bearer |
You can configure it using the WithSecurity option when initializing the SDK client instance. For example:
package main
import (
"context"
dubgo "github.com/dubinc/dub-go"
"github.com/dubinc/dub-go/models/operations"
"log"
)
func main() {
s := dubgo.New(
dubgo.WithSecurity("DUB_API_KEY"),
dubgo.WithWorkspaceID("<value>"),
)
request := operations.GetLinksRequest{}
ctx := context.Background()
res, err := s.Links.List(ctx, request)
if err != nil {
log.Fatal(err)
}
if res.LinkSchemas != nil {
// handle response
}
}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.
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!