dubgo

github.com/dubinc/dub-go

Summary

Dub API: Dub is the modern link attribution platform for short links, conversion tracking, and affiliate programs.

Table of Contents

• github.com/dubinc/dub-go
  • SDK Installation
  • SDK Example Usage
  • Available Resources and Operations
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Authentication
  • Retries
  • Pagination
• Development
  • Contributions

SDK Installation

To add the SDK as a dependency to your project:

go get github.com/dubinc/dub-go

SDK Example Usage

Example 1

package main

import (
	"context"
	dubgo "github.com/dubinc/dub-go"
	"github.com/dubinc/dub-go/models/operations"
	"log"
)

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

	s := dubgo.New(
		dubgo.WithSecurity("DUB_API_KEY"),
	)

	res, err := s.Links.Create(ctx, &operations.CreateLinkRequestBody{
		URL:        "https://google.com",
		ExternalID: dubgo.Pointer("123456"),
		TagIds: dubgo.Pointer(operations.CreateTagIdsArrayOfStr(
			[]string{
				"clux0rgak00011...",
			},
		)),
		TestVariants: []operations.TestVariants{
			operations.TestVariants{
				URL:        "https://example.com/variant-1",
				Percentage: 50.0,
			},
			operations.TestVariants{
				URL:        "https://example.com/variant-2",
				Percentage: 50.0,
			},
		},
	})
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		// handle response
	}
}

Example 2

package main

import (
	"context"
	dubgo "github.com/dubinc/dub-go"
	"github.com/dubinc/dub-go/models/operations"
	"log"
)

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

	s := dubgo.New(
		dubgo.WithSecurity("DUB_API_KEY"),
	)

	res, err := s.Links.Upsert(ctx, &operations.UpsertLinkRequestBody{
		URL:        "https://google.com",
		ExternalID: dubgo.Pointer("123456"),
		TagIds: dubgo.Pointer(operations.CreateUpsertLinkTagIdsArrayOfStr(
			[]string{
				"clux0rgak00011...",
			},
		)),
		TestVariants: []operations.UpsertLinkTestVariants{
			operations.UpsertLinkTestVariants{
				URL:        "https://example.com/variant-1",
				Percentage: 50.0,
			},
			operations.UpsertLinkTestVariants{
				URL:        "https://example.com/variant-2",
				Percentage: 50.0,
			},
		},
	})
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		// handle response
	}
}

Available Resources and Operations

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

Example

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() {
	ctx := context.Background()

	s := dubgo.New(
		dubgo.WithSecurity("DUB_API_KEY"),
	)

	res, err := s.Links.List(ctx, operations.GetLinksRequest{
		EndingBefore:  dubgo.Pointer("link_1KAP4CDPBSVMMBMH9XX3YZZ0Z..."),
		StartingAfter: dubgo.Pointer("link_1KAP4CDPBSVMMBMH9XX3YZZ0Z..."),
		Page:          dubgo.Pointer[float64](1.0),
		PageSize:      dubgo.Pointer[float64](50.0),
	})
	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())
		}
	}
}

Server Selection

Override Server URL Per-Client

The default server can be overridden globally using the WithServerURL(serverURL string) 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() {
	ctx := context.Background()

	s := dubgo.New(
		dubgo.WithServerURL("https://api.dub.co"),
		dubgo.WithSecurity("DUB_API_KEY"),
	)

	res, err := s.Links.List(ctx, operations.GetLinksRequest{
		EndingBefore:  dubgo.Pointer("link_1KAP4CDPBSVMMBMH9XX3YZZ0Z..."),
		StartingAfter: dubgo.Pointer("link_1KAP4CDPBSVMMBMH9XX3YZZ0Z..."),
		Page:          dubgo.Pointer[float64](1.0),
		PageSize:      dubgo.Pointer[float64](50.0),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		for {
			// handle items

			res, err = res.Next()

			if err != nil {
				// handle error
			}

			if res == nil {
				break
			}
		}
	}
}

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/dubinc/dub-go"
)

var (
	httpClient = &http.Client{Timeout: 30 * time.Second}
	sdkClient  = dubgo.New(dubgo.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 scheme globally:

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() {
	ctx := context.Background()

	s := dubgo.New(
		dubgo.WithSecurity("DUB_API_KEY"),
	)

	res, err := s.Links.List(ctx, operations.GetLinksRequest{
		EndingBefore:  dubgo.Pointer("link_1KAP4CDPBSVMMBMH9XX3YZZ0Z..."),
		StartingAfter: dubgo.Pointer("link_1KAP4CDPBSVMMBMH9XX3YZZ0Z..."),
		Page:          dubgo.Pointer[float64](1.0),
		PageSize:      dubgo.Pointer[float64](50.0),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		for {
			// handle items

			res, err = res.Next()

			if err != nil {
				// handle error
			}

			if res == nil {
				break
			}
		}
	}
}

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"
	dubgo "github.com/dubinc/dub-go"
	"github.com/dubinc/dub-go/models/operations"
	"github.com/dubinc/dub-go/retry"
	"log"
	"models/operations"
)

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

	s := dubgo.New(
		dubgo.WithSecurity("DUB_API_KEY"),
	)

	res, err := s.Links.List(ctx, operations.GetLinksRequest{
		EndingBefore:  dubgo.Pointer("link_1KAP4CDPBSVMMBMH9XX3YZZ0Z..."),
		StartingAfter: dubgo.Pointer("link_1KAP4CDPBSVMMBMH9XX3YZZ0Z..."),
		Page:          dubgo.Pointer[float64](1.0),
		PageSize:      dubgo.Pointer[float64](50.0),
	}, 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 {
		for {
			// handle items

			res, err = res.Next()

			if err != nil {
				// handle error
			}

			if res == nil {
				break
			}
		}
	}
}

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"
	dubgo "github.com/dubinc/dub-go"
	"github.com/dubinc/dub-go/models/operations"
	"github.com/dubinc/dub-go/retry"
	"log"
)

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

	s := dubgo.New(
		dubgo.WithRetryConfig(
			retry.Config{
				Strategy: "backoff",
				Backoff: &retry.BackoffStrategy{
					InitialInterval: 1,
					MaxInterval:     50,
					Exponent:        1.1,
					MaxElapsedTime:  100,
				},
				RetryConnectionErrors: false,
			}),
		dubgo.WithSecurity("DUB_API_KEY"),
	)

	res, err := s.Links.List(ctx, operations.GetLinksRequest{
		EndingBefore:  dubgo.Pointer("link_1KAP4CDPBSVMMBMH9XX3YZZ0Z..."),
		StartingAfter: dubgo.Pointer("link_1KAP4CDPBSVMMBMH9XX3YZZ0Z..."),
		Page:          dubgo.Pointer[float64](1.0),
		PageSize:      dubgo.Pointer[float64](50.0),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		for {
			// handle items

			res, err = res.Next()

			if err != nil {
				// handle error
			}

			if res == nil {
				break
			}
		}
	}
}

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will have a Next method that can be called to pull down the next group of results. If the return value of Next is nil, then there are no more pages to be fetched.

Here's an example of one such pagination call:

package main

import (
	"context"
	dubgo "github.com/dubinc/dub-go"
	"github.com/dubinc/dub-go/models/operations"
	"log"
)

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

	s := dubgo.New(
		dubgo.WithSecurity("DUB_API_KEY"),
	)

	res, err := s.Links.List(ctx, operations.GetLinksRequest{
		EndingBefore:  dubgo.Pointer("link_1KAP4CDPBSVMMBMH9XX3YZZ0Z..."),
		StartingAfter: dubgo.Pointer("link_1KAP4CDPBSVMMBMH9XX3YZZ0Z..."),
		Page:          dubgo.Pointer[float64](1.0),
		PageSize:      dubgo.Pointer[float64](50.0),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		for {
			// handle items

			res, err = res.Next()

			if err != nil {
				// handle error
			}

			if res == nil {
				break
			}
		}
	}
}

Development

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